Docs

Start here

Read a collection

GET/v1/community/collections/{id}on https://api.auray.ai/v1

A page of one collection's works still shown, newest saved first.

A page of one collection's works still shown, newest saved first. A public collection of a listed profile reads with no key; its owner reads it either way. Takes no key. A key that holds community:write reads as its account — its likes and follows filled in — 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. A key that holds community:write is read as its account — its likes and follows filled in — and is answered private, no-store. Paced per address, and cached at the edge for thirty seconds.

#Request

#Path parameters

NameTypeRequiredDescription
idstringyes

#Query parameters

NameTypeRequiredDescription
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/collections/5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "collection".
idstringyes—
titlestringyes—
descriptionstringyes—May be null.
publicbooleanyes—Shown on its owner's profile.
itemsintegeryes—Works in it, shown or not.
updated_atstringyes—
minebooleanyes—
coverobject[]yes—The newest shown work's files.
cover[].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".
cover[].positionintegeryes—
cover[].urlstringyes—Where to load it. Kept until its author unpublishes the work. A URL.
cover[].content_typestringyes—
cover[].widthintegeryes—May be null.
cover[].heightintegeryes—May be null.
cover[].duration_msintegeryes—May be null.
cover[].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.
ownerobject or nullno—
urlstringno—Its page, under its owner's profile. A URL. May be null.
dataobject[]no—
data[].idstringyes—The work's public id.
data[].kindstringyes—One of "image", "video", "audio", "model3d", "project".
data[].titlestringyes—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 work is shown. May be null.
data[].ai_generatedbooleanyes—Every work here is a generation's result. Label it so wherever it is shown. One of true.
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[].authorobject or nullyes—
data[].countsobjectyes—
data[].counts.likesintegeryes—
data[].counts.viewsintegeryes—Counted once a day per visitor.
data[].counts.commentsintegeryes—
data[].counts.remixesintegeryes—
data[].made_atstringyes—When the result was made. May be null.
data[].published_atstringyes—May be null.
data[].featuredbooleanyes—Featured by our team.
data[].pinnedbooleanyes—Pinned by our team to the top of the public feeds.
data[].originalbooleanyes—An Original: made by our own team.
data[].remixedbooleanyes—Made from another work.
data[].likedbooleanyes—The reader's own like; null when no key that holds community:write was sent. May be null.
data[].urlstringyes—The work's page. A URL.
data[].projectobjectno—Only on a project's card: its address, category, how many assets it shows, and the three largest bands of its Stack.
data[].project.slugstringyes—
data[].project.categorystringyes—One of "film", "short", "series", "trailer", "commercial", "music_video", "animation", "documentary", "fashion", "game", "worldbuilding", "experimental", "other".
data[].project.itemsintegeryes—0 to ….
data[].project.stackobject[]yes—
data[].project.stack[].modelobjectyes—
data[].project.stack[].tenthsintegeryes—Its share in tenths of a percent; the bands of one Stack add up to exactly 1000. 0 to 1000.
data[].project.stack[].percentnumberyes—tenths / 10, for display only.
data[].project.stack[].countintegeryes—0 to ….
data[].project.stack[].colorstringyes—
data[].project.stack[].otherbooleanyes—The band that gathers every model past the top ones.
next_cursorstringno—May be null.
request_idstringno—Mirrored in the X-Request-Id header. On an answer without a key it names the request that filled the edge's copy, so readers served from that copy are handed the same one.

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

#404 Not Found

#429 Too Many Requests

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
400Bad Request
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