Docs

Start here

Read a profile's collections

GET/v1/community/profiles/{handle}/collectionson https://api.auray.ai/v1

A profile's public collections.

A profile's public collections. Its creator, reading with a key that holds community:write, sees the private ones too. 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
handlestringyesA profile's handle; one @ before it is read past.

#Example request

curl https://api.auray.ai/v1/community/profiles/ada/collections

#Responses

#200 OK

OK. Every collection on one page.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "list".
dataobject[]yes—
data[].idstringyes—
data[].titlestringyes—
data[].descriptionstringyes—May be null.
data[].publicbooleanyes—Shown on its owner's profile.
data[].itemsintegeryes—Works in it, shown or not.
data[].updated_atstringyes—
data[].minebooleanyes—
data[].coverobject[]yes—The newest shown work's files.
data[].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".
data[].cover[].positionintegeryes—
data[].cover[].urlstringyes—Where to load it. Kept until its author unpublishes the work. A URL.
data[].cover[].content_typestringyes—
data[].cover[].widthintegeryes—May be null.
data[].cover[].heightintegeryes—May be null.
data[].cover[].duration_msintegeryes—May be null.
data[].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.
data[].ownerobject or nullno—
next_cursorstringyes—The cursor of the next page; null on the last. 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

#404 Not Found

#429 Too Many Requests

#503 Service Unavailable

#Status codes

StatusMeaning
200OK. Every collection on one page.
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