Docs

Start here

The work each model is shown with

GET/v1/catalogue/showcaseson https://api.auray.ai/v1

Takes no key and charges nothing, for the reason /catalogue does: the marketing page reads it before anybody has an account.

Takes no key and charges nothing, for the reason /catalogue does: the marketing page reads it before anybody has an account. For every published address that one of our team's works was made with, the work it is shown with — published, approved and listed on the Community, by an author the Community shows — the one we picked for that model while it still qualifies, else chosen in this order: featured, then one with a still (a song: with a waveform), then one not made from another work, then the textured tier of a 3D model, then a landscape still before a square one before a portrait, then the first published. A work withdrawn, unlisted or taken down leaves this map within a few minutes. An address with no work of ours is simply absent: draw the maker's mark there. Keyed by each address as this reference prints it, never by another name. Answered with a weak ETag over the works alone; send it back in If-None-Match and an unchanged map is answered 304 with no body. When the works cannot be read this answers 200 with source: "fallback", an empty showcases and as_of: null rather than an error, sent with no-store and stored nowhere. Cached at the edge for sixty seconds with two minutes of stale service.

#Authentication

No key needed — this document is public.

#Request

#Headers

NameTypeRequiredDescription
If-None-MatchstringnoThe ETag of a map you hold. When it is still current the answer is 304 with no body.

#Example request

curl https://api.auray.ai/v1/catalogue/showcases

#Responses

#200 OK

OK. Every showcase, by address, and when they were read.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "showcases".
sourcestringyes—fallback when the works could not be read: showcases is then empty and as_of null. One of "live", "fallback".
showcasesobjectyes—One work per published address that has one, keyed by the address as this reference prints it.
as_ofstringyes—When the works were read; null on fallback. May be null.
request_idstringyes—

Headers:

HeaderDescription
Cache-Controlpublic, s-maxage=60, stale-while-revalidate=120 when the works were read; no-store on fallback.
ETagA weak validator of showcases (W/"…"). Absent on fallback.
X-Request-Id

#304 Not Modified

Not modified: the map the If-None-Match named is current. No body.

#Status codes

StatusMeaning
200OK. Every showcase, by address, and when they were read.
304Not modified: the map the If-None-Match named is current.

Every refusal names its code, and every code is explained at Errors.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close