Docs

Start here

Start a collection

POST/v1/community/collectionson https://api.auray.ai/v1

Start a collection, a hundred at most.

Start a collection, a hundred at most. It is private unless public, which shows it on your profile and needs one. Takes a key holding community:write — Account offers it unticked — or the desktop's own session key. Spends nothing.

#Authentication

Authorization: Bearer auray_sk_… — community:write — Account offers it unticked; the desktop's session key holds it.

#Request

#Body

application/json, required.

FieldTypeRequiredDefaultDescription
titlestringyes—0 to 80 characters.
descriptionstringno—0 to 500 characters. May be null.
publicbooleannofalse

#Example request

curl -X POST https://api.auray.ai/v1/community/collections \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "title": "Fog studies"
}'

#Responses

#201 Created

Created.

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—
request_idstringno—Mirrored in the X-Request-Id header.

Headers:

HeaderDescription
RateLimit-LimitBurst capacity.
RateLimit-Remaining
RateLimit-ResetSeconds until refill.
X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-ResetUnix seconds. The X- spelling is what client libraries read.
X-Request-Id

#400 Bad Request

#401 Unauthorized

#403 Forbidden

#409 Conflict

#428 Precondition Required

#429 Too Many Requests

#503 Service Unavailable

#Status codes

StatusMeaning
201Created.
400Bad Request
401Unauthorized
403Forbidden
409Conflict
428Precondition Required
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