Videos
Cancel video
Cancel a video job before generation starts
/v1/videos/{video_id}/cancelCancel a job that is still waiting to start. A cancelled job is never billed.
A job is sent for generation as soon as it is created. Cancellation usually succeeds only right after creation. Once generation starts, cancelling returns 409 with code: "video_not_cancellable", even if the job still reports queued. The job then runs to the end and is billed if it completes. To discard its video, delete the job once it has finished.
queued: accepted; waiting for or being submitted for generation, so cancellation may already be unavailable. in_progress: generating. completed: generation succeeded; download available until expires_at. failed: see error. cancelled: cancelled before generation started. The last three are terminal.
Available options:queuedin_progresscompletedfailedcancelled
Until when the video can be downloaded, in Unix seconds: 7 days after it finished. After it, the job is no longer listed. Present only when status is completed.
The requested aspect ratio, with the model's default filled in. adaptive for a job with frame_images, whose video takes the first frame's shape.
The job's long-running operation. Poll it with GET https://api.inworld.ai/lro/v1alpha/{operation} as an alternative to retrieving the job. The operation reports progress and the outcome but never the download link. See Poll the operation instead.
Why the job failed. Present only when status is failed.
Show child attributes
content_filtered: the prompt or the generated video was blocked by the model provider's content policy. invalid_request: the model provider rejected the request. generation_failed: generation failed for another reason. generation_timeout: generation did not finish in time.
Available options:content_filteredinvalid_requestgeneration_failedgeneration_timeout
The finished video. Returned only by Retrieve video, only while status is completed and before expires_at.
Show child attributes
Show child attributes
A signed HTTPS link to the MP4. Anyone with the link can download the file until url_expires_at, so treat it like a secret.