API reference

API reference · Account

Every take the account has on its way, across every film

GET/api/studio/jobs/openSigned in session

The account's studio jobs still queued or being made (from the last day), and its render plans' shots still waiting for a slot, newest first, at most 50: each with the film on the account it was asked from where the server knows it, the shot's title where it came through a render plan, and its queue line. What the workspace bar's list of takes being made reads. While video and sound jobs are switched off this door answers the unknown endpoint 404 (code unknown_endpoint).

Answer 200

The takes on their way.

Fields of the 200 answer
FieldTypeWhat it is
objectstringOne of "list".
dataarray of object
data[].idstringThe job's id, or a waiting plan shot's stand in.
data[].shot_refstring or null
data[].kindstringOne of "video", "sound", "still".
data[].modelstring
data[].statusstringOne of "waiting", "queued", "in_progress".
data[].progressnumber or null
data[].microsintegerBilled micro USD held for it.
data[].created_atinteger
data[].queueobjectOn GET /api/studio/jobs while the job is queued or running: queued at its provider (with how many requests are ahead of it where the provider's status says one) or being made, and the median seconds this model's takes took from submit to landing over the last 7 days, from at least 5 of them (null with fewer). Nothing is estimated without them.
data[].queue.stagestringOne of "queued", "running".
data[].queue.aheadinteger or null
data[].queue.typical_secondsinteger or null
data[].projectobject or null
data[].project.idstring
data[].project.doc_idstring
data[].project.namestring
data[].titlestring or null

Errors

  • 401OpenAI shaped error.
  • 404OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter