Skip to main content
GET
Download a video

Authorizations

Authorization
string
header
required

Bearer token used for request authentication. Alternatively, you can send the API key in the x-api-key header. Note: A payment method is required to use the API.

Path Parameters

id
string
required

The task id returned by the Video Generation API.

Response

Successful video task response

id
string
required

Unique task id, used to download the video.

model
string
required

The model used for this task.

status
enum<string>
required

Task state.

Available options:
queued,
in_progress,
completed,
failed
created
integer
required

Unix timestamp in seconds when the task was created.

video_url
string

Signed download URL for the video file, present when status is completed. Valid for 7 days after generation.

expires_at
integer

Unix timestamp in seconds when video_url expires. Present when status is completed.

duration
integer

Length of the generated video in seconds. Present when status is completed.

resolution
string

Resolution of the generated video. Present when status is completed.

usage
object

Metering for the task. Present only when status is completed.

error
string

Failure reason, present when status is failed.

code
string

Machine-readable failure code, present when status is failed.