Docs

Start here

List a published project's assets

GET/v1/community/publications/{id}/assetson https://api.auray.ai/v1

A page of a published project's assets — all of them, or one folder's — in the project's order, each with its files, model, licence text and AI-generated mark, and its prompt only while its author …

A page of a published project's assets — all of them, or one folder's — in the project's order, each with its files, model, licence text and AI-generated mark, and its prompt only while its author shows prompts. Seen as its page is. Takes no key. A key that holds community:write reads as its account — its likes filled in, and its author told where it stands in mine — and any other key reads what a stranger reads; either way a request with a key is answered for itself alone and kept in no shared cache. An answer without a key is the same for every reader, its request_id included — which names the request that filled the edge's copy — and carries no RateLimit-* headers, since they would describe that request's sender. Cached at the edge for thirty seconds with two minutes of stale service.

#Authentication

No key needed — this document is public.

#Request

#Path parameters

NameTypeRequiredDescription
idstringyes

#Query parameters

NameTypeRequiredDescription
folderstringnoall (the default), generations, uploads, or a folder's id from the page's folders.
cursorstringnoThe next_cursor the previous page answered, unchanged, with the same filters. None for the first page. 0 to 200 characters.
limitintegernoHow many on a page. 1 to 60.

#Example request

curl https://api.auray.ai/v1/community/publications/photo_docs-mtpb1vnh/assets

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "list".
dataobject[]yes—
data[].idstringyes—The asset's own public id. Report it as a publication: the report is about the project, with the asset named.
data[].kindstringyes—One of "image", "video", "audio", "model3d".
data[].titlestringyes—May be null.
data[].folder_idstringyes—A member's folder of the page's folders, or null. May be null.
data[].mediaobject[]yes—
data[].media[].rolestringyes—primary is the work as it was made; the rest are what the feeds draw: an image's thumbnail, a video's or a model's poster and thumbnail, a song's waveform (JSON: {version, peaks}). One of "primary", "poster", "preview", "thumbnail", "waveform".
data[].media[].positionintegeryes—
data[].media[].urlstringyes—Where to load it. Kept until its author unpublishes the work. A URL.
data[].media[].content_typestringyes—
data[].media[].widthintegeryes—May be null.
data[].media[].heightintegeryes—May be null.
data[].media[].duration_msintegeryes—May be null.
data[].media[].suppliedbooleanyes—True for a poster, or its thumbnail, that the work's author supplied rather than one our services made: it is not what the model made, and the work's ai_generated does not describe it.
data[].promptstringyes—Only while its author shows prompts; a hidden prompt exists nowhere in the answer. May be null.
data[].modelobjectyes—
data[].model.addressstringyes—The model address it was made with, as GET /v1/models lists it: the path a job is submitted to, such as auray-ai/krea-2-turbo/text-to-image. May be null.
data[].model.idstringyes—The same model's id, as GET /v1/models lists it: the catalogue slug, such as krea2. May be null.
data[].model.labelstringyes—The model's name, as a person reads it. May be null.
data[].attributionstringyes—The licence text the model's output travels with. Show it wherever the asset is. May be null.
data[].ai_generatedbooleanyes—A model made it; false for a picture or a clip its author uploaded.
data[].created_atstringyes—
next_cursorstringyes—May be null.
request_idstringno—

Headers:

HeaderDescription
Cache-Controlpublic, s-maxage=30, stale-while-revalidate=120 with no key; private, no-store with one.
VaryAuthorization.
RateLimit-LimitBurst capacity, per key, on an answer to a key. An answer without one is cached at the edge and carries none of the RateLimit-* headers; a refusal without one, which is never cached, carries its address's.
RateLimit-Remaining
RateLimit-ResetSeconds until refill.
X-Request-Id

#400 Bad Request

#401 Unauthorized

#403 Forbidden

#404 Not Found

#429 Too Many Requests

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
400Bad Request
401Unauthorized
403Forbidden
404Not Found
429Too Many Requests
503Service Unavailable

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