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
| Field | Type | What it is |
|---|---|---|
| id (path)required | string | The job's id, video_, sound_ or still_ followed by hex. |
Answer 200
The job.
| Field | Type | What it is |
|---|---|---|
| id | string | |
| kind | string | One of "video", "sound", "still". |
| model | string | |
| status | string | One of "queued", "in_progress", "completed", "failed", "cancelled". |
| progress | integer or null | |
| micros | integer | The hold while running, the charge once settled. |
| created_at | integer | |
| completed_at | integer or null | |
| expires_at | integer or null | |
| error | object or null | |
| error. | string | |
| error. | string | |
| failover | object | Present 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. | integer | |
| failover. | array of string | |
| failover. | integer | |
| failover. | boolean | |
| stored | object or null | On GET /api/studio/jobs where stored media is on: the stored copy of the output and where it stands. |
| stored. | string | |
| stored. | string | One of "ready", "awaiting", "failed". |
| queue | object | On 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. | string | One of "queued", "running". |
| queue. | integer or null | |
| queue. | integer 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.