Docs

Start here

Add an item

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

Add one of your results (job_id, and asset for which file) or one of your uploads (upload_id) to a project — exactly one of the two.

Add one of your results (job_id, and asset for which file) or one of your uploads (upload_id) to a project — exactly one of the two. A result is copied into the project and kept until you delete it, after its job's own three days; a job that has not succeeded, is past its three days, or is held by a report is refused. A project holds as many items as its limits.items says, the Trash counted: its owner's plan's figure, whoever adds them. Takes a key holding studio:write — Account offers it unticked — or the desktop's own session key. Spends nothing.

#Authentication

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

#Request

#Path parameters

NameTypeRequiredDescription
projectstringyes

#Body

application/json, required.

FieldTypeRequiredDefaultDescription
job_idstringno—One of your results, by the id a submit answered.
assetinteger or stringno—Which file of the job; the first when left out.
upload_idstringno—One of your uploads, made with purpose: "item" for this project.
folder_idstringno—May be null.
namestringno—0 to 120 characters. May be null.

#Example request

curl -X POST https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/items \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "job_id": "photo_k1",
  "folder_id": null
}'

#Responses

#201 Created

Created.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "item".
idstringyes—
project_idstringyes—
folder_idstringyes—The member's folder it is filed in; null at the project's top level. May be null.
kindstringyes—One of "image", "video", "audio", "model3d".
namestringyes—0 to 120 characters. May be null.
sourceobjectyes—
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".
source.job_idstringyes—The job's id as GET /jobs/{id} reads it; null for an upload and for a film. May be null.
source.assetinteger or stringyes—Which file of the job: a position, or a 3D artefact's name. May be null.
filesobject[]yes—
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. One of "original", "thumbnail", "poster".
files[].urlstringyes—A URL.
files[].expires_atstringyes—
files[].content_typestringyes—
files[].bytesintegeryes—May be null.
files[].widthintegeryes—May be null.
files[].heightintegeryes—May be null.
files[].duration_msintegeryes—May be null.
promptstringyes—May be null.
paramsobjectyes—The settings it was made with, cleaned of links and keys. May be null.
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 an upload.
model.addressstringyes—May be null.
model.idstringyes—May be null.
model.labelstringyes—May be null.
directorobject or nullyes—
seedintegeryes—May be null.
ai_generatedbooleanyes—A model's output says so wherever it is shown, with attribution, its licence line.
attributionstringyes—May be null.
reviewstringyes—One of "none", "in_progress", "needs_review", "approved", "rejected".
favoritebooleanyes—Your own favourite.
last_viewed_atstringyes—When you last opened it (POST …/view); null for never. May be null.
trimobject or nullyes—
created_atstringyes—
updated_atstringyes—
trashed_atstringyes—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

#409 Conflict

#410 Gone

#413 Payload Too Large

#429 Too Many Requests

#500 Internal Server Error

#502 Bad Gateway

#503 Service Unavailable

#Status codes

StatusMeaning
201Created.
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
410Gone
413Payload Too Large
429Too Many Requests
500Internal Server Error
502Bad Gateway
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