API reference · API
Stop a video job
POST/v1/videos/{id}/cancelAPI key
Asks the provider to stop it. One the provider never made is released and costs nothing; one it finishes anyway is billed as made. A job at a provider that documents no cancel (Alibaba's Wan, MiniMax's Hailuo) answers 409 not_cancellable and runs to its end, billed as made.
Parameters
| Field | Type | What it is |
|---|---|---|
| id (path)required | string | The job's id. |
Answer 200
The job as it stands.
| Field | Type | What it is |
|---|---|---|
| idrequired | string | video_, sound_, mesh_ or still_ then 24 hex digits. |
| objectrequired | string | One of "video", "sound", "mesh", "still". |
| modelrequired | string | |
| statusrequired | string | One of "queued", "in_progress", "completed", "failed", "cancelled". |
| progress | integer | 0 until completed, then 100. |
| created_atrequired | integer | |
| completed_at | integer or null | |
| expires_at | integer or null | When the file stops being fetchable: 60 minutes after completion. |
| prompt | string or null | |
| seconds | string | |
| size | string | |
| resolution | string | |
| aspect_ratio | string | |
| audio | boolean | |
| reference_count | integer | How many reference pictures it was sent; the pictures are not kept. |
| content_type | string or null | |
| hold_microsrequired | integer | The worst case held while it runs. |
| cost_micros | integer or null | What it was billed, never past the hold. |
| cancel_requested | boolean | |
| error | object or null | generation_failed, deadline_exceeded, provider_unanswered (billed its hold), submit_lost or model_unavailable. |
| error. | string | |
| error. | string |
Errors
- 404OpenAI shaped error.
- 409OpenAI 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.