Sign in
Videos

Retrieve a video job (refreshes status from the provider)

GET /v1/videos/{video_id}

get/api/v1/videos/{video_id}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/videos/{video_id}
  • Auth: HTTP bearer

Path parameters

video_idstring required

Video job id

Response

Video job

completed_atinteger nullable

Unix timestamp (seconds) when the job completed.

created_atinteger required

Unix timestamp (seconds) when the job was created.

expires_atinteger nullable

Unix timestamp (seconds) when the rendered asset expires.

idstring required

Unique job identifier.

modelstring required

Model used for generation.

objectstring

Object type, always "video".

progressinteger nullable

Approximate completion percentage (0-100).

promptstring nullable

Original generation prompt.

remixed_from_video_idstring nullable

Source video id when this job is a remix.

secondsstring nullable

Requested duration in seconds.

sizestring nullable

Output resolution.

status'queued' | 'in_progress' | 'completed' | 'failed' required

Status of a video generation job.

Changes

No recorded changes to this operation across all 1 revision of this API.