Docs

Start here

Get a film's export

GET/v1/studio/projects/{project}/films/{film}/exports/{export}on https://api.auray.ai/v1

Where an export of a film stands: queued, running, done with the video it filed (item_id, an item of the project — read it for its file), or failed with why (error).

Where an export of a film stands: queued, running, done with the video it filed (item_id, an item of the project — read it for its file), or failed with why (error). expected_seconds is what a progress bar may assume, never a promise. out_of_date once the film was changed since, or a clip it was made of — or the film itself — has since been withheld. 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
filmstringyes
exportstringyes

#Example request

curl https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/films/6d7e8f90-1a2b-4c3d-8e4f-5a6b7c8d9e0f/exports/7e8f9a0b-1c2d-4e3f-8a4b-5c6d7e8f9a0b \
  -H "Authorization: Bearer $AURAY_API_KEY"

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "film_export".
idstringyes—
film_idstringyes—The film it was made of; null once that film was deleted — the video stays. May be null.
revintegeryes—The film's revision it was made of. 1 to ….
statestringyes—One of "queued", "running", "done", "failed".
item_idstringyes—The video it filed in the project's Film folder, once done; null before, and once that item was deleted. May be null.
errorstringyes—Why it failed: a clip or the music could not be read, the clips could not be made into one film, the film was larger than a film is kept at, it could not be stored, no film arrived after every try, video was paused before it could start again, a clip was withheld or left the project before it started, its place in the project went, or its film was deleted. Null unless failed. One of "source_unreadable", "render_failed", "too_large", "upload_failed", "timed_out", "paused", "source_withheld", "source_missing", "lost", "cancelled", null. May be null.
out_of_datebooleanyes—Done, and no longer the film as it stands: the film was changed since, or a clip it was made of — or the film itself — has since been withheld.
duration_msintegeryes—The film's length by its document. 0 to ….
expected_secondsintegeryes—What a progress bar may assume, from the film's length — never a promise. 0 to ….
created_atstringyes—
started_atstringyes—May be null.
finished_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

#401 Unauthorized

#403 Forbidden

#404 Not Found

#429 Too Many Requests

#500 Internal Server Error

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
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