API reference

API reference · Account

One of the account's studio jobs

GET/api/studio/jobs/{id}Signed in session

While video and sound jobs are switched off this door answers the unknown endpoint 404 (code unknown_endpoint).

Parameters

Path and query parameters
FieldTypeWhat it is
id (path)requiredstringThe job's id, video_, sound_ or still_ followed by hex.

Answer 200

The job.

Fields of the 200 answer
FieldTypeWhat it is
idstring
kindstringOne of "video", "sound", "still".
modelstring
statusstringOne of "queued", "in_progress", "completed", "failed", "cancelled".
progressinteger or null
microsintegerThe hold while running, the charge once settled.
created_atinteger
completed_atinteger or null
expires_atinteger or null
errorobject or null
error.codestring
error.messagestring
failoverobjectPresent only when the cheapest provider was unreachable or answered a server error at submit and the job went to the next provider of the same model: how many were tried, why, the first hold, and whether the job is now held dearer. No provider is named.
failover.triedinteger
failover.reasonsarray of string
failover.first_hold_microsinteger
failover.dearerboolean
storedobject or nullOn GET /api/studio/jobs where stored media is on: the stored copy of the output and where it stands.
stored.asset_idstring
stored.statusstringOne of "ready", "awaiting", "failed".
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.
queue.stagestringOne of "queued", "running".
queue.aheadinteger or null
queue.typical_secondsinteger 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