Docs

Start here

List elements

GET/v1/studio/elementson https://api.auray.ai/v1

A page of your elements — characters, locations, props, voices and styles, every version — or one project's, newest change first.

A page of your elements — characters, locations, props, voices and styles, every version — or one project's, newest change first. Takes a key holding studio:read (or studio:write, which reads too) — Account offers both unticked — or the desktop's own session key. Spends nothing.

#Authentication

Authorization: Bearer auray_sk_… — studio:read, or studio:write, which reads too — Account offers both unticked; the desktop's session key holds both.

#Request

#Query parameters

NameTypeRequiredDescription
cursorstringnoThe next_cursor the previous page answered, unchanged, with the same filters. None for the first page. 0 to 120 characters.
limitintegernoHow many on a page. 1 to 100.
categorystringnoOne of "character", "location", "prop", "voice", "style".
statusstringnoOne of "draft", "ready", "archived".
projectstringnoOne project's elements, every member's; left out, your own across every project.
qstringnoWords of an element's name, handle or description. 0 to 200 characters.

#Example request

curl https://api.auray.ai/v1/studio/elements \
  -H "Authorization: Bearer $AURAY_API_KEY"

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "list".
dataobject[]yes—
data[].objectstringyes—One of "element".
data[].idstringyes—
data[].handlestringyes—What a prompt names it by: @char_aliya_v1. Every version has its own.
data[].namestringyes—0 to 60 characters.
data[].categorystringyes—One of "character", "location", "prop", "voice", "style".
data[].versionintegeryes—1 to ….
data[].lineage_idstringyes—Every version of one element shares it.
data[].descriptionstringyes—0 to 1000 characters. May be null.
data[].filesobject[]yes—Pictures or clips of a character, location or prop (one to six); a voice's one sound, its sample; a style's pictures (up to six).
data[].files[].rolestringyes—original as made or uploaded; thumbnail a smaller picture for a card; poster a frame of a clip or a view of a mesh; captions a film's subtitles, the WebVTT a captioned export files beside it. One of "original", "thumbnail", "poster", "captions".
data[].files[].urlstringyes—A URL.
data[].files[].expires_atstringyes—
data[].files[].content_typestringyes—
data[].files[].bytesintegeryes—May be null.
data[].files[].widthintegeryes—May be null.
data[].files[].heightintegeryes—May be null.
data[].files[].duration_msintegeryes—May be null.
data[].files[].from_uploadbooleanno—On an element's file alone: whether it was made from a file not made here — false for a picture made here from files made here alone, true for one made from an upload, null where it is not known. Only a picture that is false can be made to speak. An item says its own as source.from_upload. May be null.
data[].files[].uploadedbooleanno—On an element's file alone: true for your own upload itself.
data[].propertiesobject[]yes—
data[].properties[].keystringyes—0 to 40 characters.
data[].properties[].valuestringyes—0 to 200 characters.
data[].statusstringyes—One of "draft", "ready", "archived".
data[].project_idstringyes—The project it was made in; null for one of your own across every project. May be null.
data[].voiceobject or nullyes—A voice element's voice; null on every other kind.
data[].voice_handlestringyes—A character's voice: the @handle of the voice element it speaks with. May be null.
data[].pinnedbooleanyes—A style the AI Director uses on every shot it makes in its project: at most one per project.
data[].sample_consentobject or nullno—A voice element's own recording: the consent it was kept with — whose voice, the words' version, when. Null for a sample made here, for no sample and on every other kind.
data[].sample_acceptanceobject or nullno—A voice element's own recording kept since your account's one acceptance of real people's faces and voices: the acceptance it was kept under — its kind, the words' version, when you gave it. Null for a sample made here, for no sample, for one kept before it (see sample_consent) and on every other kind.
data[].created_atstringyes—
data[].updated_atstringyes—
next_cursorstringyes—Send it as cursor for the next page; null on the last. May be null.
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

#429 Too Many Requests

#500 Internal Server Error

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
400Bad Request
401Unauthorized
403Forbidden
429Too Many Requests
500Internal Server Error
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