Docs

Start here

List a project's items

GET/v1/studio/projects/{project}/itemson https://api.auray.ai/v1

A page of a project's items not in the Trash — by folder, kind, model, review status, your favourites, a window of creation and words — each with its files signed.

A page of a project's items not in the Trash — by folder, kind, model, review status, your favourites, a window of creation and words — each with its files signed. 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

#Path parameters

NameTypeRequiredDescription
projectstringyes

#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.
folderstringnoall (the default), generations, uploads, or a member's folder by its id.
kindstringnoOne kind or several, comma-separated.
modelstringnoThe address or id GET /models lists a model under.
reviewstringnoOne of "none", "in_progress", "needs_review", "approved", "rejected".
favoritebooleannoOnly your favourites, or only the rest.
sincestringnoMade at or after, ISO 8601.
untilstringnoMade at or before, ISO 8601.
qstringnoWords of an item's name or prompt. 0 to 200 characters.
sortstringnonew, old, name, viewed — the ones you opened last first — or shot: the AI Director's shots as the film runs, plan by plan and shot by shot with each shot's versions oldest first, then everything else newest first. One of "new", "old", "name", "viewed", "shot".

#Example request

curl https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/items \
  -H "Authorization: Bearer $AURAY_API_KEY"

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "list".
dataobject[]yes—
data[].objectstringyes—One of "item".
data[].idstringyes—
data[].project_idstringyes—
data[].folder_idstringyes—The member's folder it is filed in; null at the project's top level. May be null.
data[].kindstringyes—One of "image", "video", "audio", "model3d".
data[].namestringyes—0 to 120 characters. May be null.
data[].sourceobjectyes—
data[].source.productstringyes—The product whose job made it, upload for a file from a disk, or film for a film exported from the project's own clips. One of "photo", "music", "video", "threed", "external", "upload", "film".
data[].source.job_idstringyes—The job's id as GET /jobs/{id} reads it; null for an upload and for a film. May be null.
data[].source.assetinteger or stringyes—Which file of the job: a position, or a 3D artefact's name. May be null.
data[].source.from_uploadbooleanno—Whether it was made from a file not made here: true for an upload and for a result whose job was given one, however many jobs back; false for a result made here from files made here alone; null where it is not known. Only a picture, a clip or a recording that is false can be made to speak or used as a voice without your consent. May be null.
data[].filesobject[]yes—
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[].promptstringyes—May be null.
data[].paramsobjectyes—The settings it was made with, cleaned of links and keys. May be null.
data[].modelobjectyes—The model an item was made with: its address and id as GET /models lists it, and the name a person reads. All three are null for the person's own upload; a frame the AI Director cut from a model's clip is named by that clip's model.
data[].model.addressstringyes—May be null.
data[].model.idstringyes—May be null.
data[].model.labelstringyes—May be null.
data[].directorobject or nullyes—
data[].seedintegeryes—May be null.
data[].ai_generatedbooleanyes—A model's output says so wherever it is shown, with attribution, its licence line.
data[].attributionstringyes—May be null.
data[].reviewstringyes—One of "none", "in_progress", "needs_review", "approved", "rejected".
data[].favoritebooleanyes—Your own favourite.
data[].last_viewed_atstringyes—When you last opened it (POST …/view); null for never. May be null.
data[].trimobject or nullyes—
data[].created_atstringyes—
data[].updated_atstringyes—
data[].trashed_atstringyes—May be null.
data[].filmobjectyes—For a film exported from the project's own clips (source.product film): its cut, its place among the cut's exports and every model that made it. Null for every other item. May be null.
data[].film.film_idstringyes—The cut it is an export of.
data[].film.exportintegeryes—Its place among the cut's exports in the project, 1 the oldest. 1 to ….
data[].film.exportsintegeryes—How many exports of the cut the project holds now, the Trash included. 1 to ….
data[].film.latestbooleanyes—True for the newest export of the cut outside the Trash.
data[].film.made_withobject[]yes—Every model its clips and sounds were made with, each by its name.
data[].film.made_with[].addressstringyes—May be null.
data[].film.made_with[].idstringyes—May be null.
data[].film.made_with[].labelstringyes—May be null.
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

#404 Not Found

#429 Too Many Requests

#500 Internal Server Error

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
400Bad Request
401Unauthorized
403Forbidden
404Not Found
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