Docs

Start here

Save a work into a collection

PUT/v1/community/collections/{id}/items/{publication}on https://api.auray.ai/v1

Save a shown work into one of your collections, a thousand at most.

Save a shown work into one of your collections, a thousand at most. Saving twice is one save. 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

#Path parameters

NameTypeRequiredDescription
idstringyes
publicationstringyesThe work's id.

#Example request

curl -X PUT https://api.auray.ai/v1/community/collections/5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e/items/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d \
  -H "Authorization: Bearer $AURAY_API_KEY"

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "collection_item".
collection_idstringyes—
publication_idstringyes—
collectedbooleanyes—
itemsintegeryes—
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

#401 Unauthorized

#403 Forbidden

#404 Not Found

#409 Conflict

#429 Too Many Requests

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
401Unauthorized
403Forbidden
404Not Found
409Conflict
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