Videos

Get video job status and result

Changed on

Gets the status of a video generation job, with a download link once it has succeeded. Requires a valid X-API-KEY header.

The link expires after 24 hours. Call this endpoint again for a fresh link instead of regenerating the video.

Throws:

  • 404 if the job does not exist or was not created with this API key's user
get/video/{job_id}

Request

Path parameters

job_idstring uuid required

Response

Successful Response

job_idstring uuid required

The job ID

status'queued' | 'processing' | 'succeeded' | 'failed' required
video_idstring uuid nullable

Can be reused as a reference or source video

urlstring nullable

Download URL, valid for 24 hours; poll again for a fresh one

duration_msinteger nullable

Output length in milliseconds

widthinteger nullable

Output width in pixels

heightinteger nullable

Output height in pixels

modelstring nullable

Model that generated the video

errorstring nullable

Why the job failed, when status is failed

Changes