API reference

API reference · API

The account's own studio jobs among these ids

GET/v1/studio/jobsAPI key

Up to 50 ids, comma separated; an id that is not the account's is left out. A job whose poll is due is moved on first. Its file is at /v1/videos/{id}/content or /v1/sounds/{id}/content, or at /v1/studio/assets/{asset_id}/content once stored. An API key with the read scope. An agent's key is refused (403 policy_violation). Rate limited per key at the key's own requests a minute, in a window of its own. While video and sound jobs are switched off this door answers the unknown endpoint 404.

Parameters

Path and query parameters
FieldTypeWhat it is
ids (query)requiredstringJob ids, comma separated, at most 50.

Answer 200

The jobs.

Fields of the 200 answer
FieldTypeWhat it is
objectstringOne of "list".
dataarray of object
data[].idstring
data[].kindstringOne of "video", "sound", "still".
data[].modelstring
data[].statusstringOne of "queued", "in_progress", "completed", "failed", "cancelled".
data[].progressinteger or null
data[].microsintegerThe hold while running, the charge once settled.
data[].created_atinteger
data[].completed_atinteger or null
data[].expires_atinteger or null
data[].errorobject or null
data[].error.codestring
data[].error.messagestring
data[].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.
data[].failover.triedinteger
data[].failover.reasonsarray of string
data[].failover.first_hold_microsinteger
data[].failover.dearerboolean
data[].storedobject or nullOn GET /api/studio/jobs where stored media is on: the stored copy of the output and where it stands.
data[].stored.asset_idstring
data[].stored.statusstringOne of "ready", "awaiting", "failed".
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

Errors

  • 400OpenAI shaped error.
  • 401OpenAI shaped error.
  • 403OpenAI shaped error.
  • 404OpenAI shaped error.
  • 429OpenAI 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