Videos

Get a video job

Changed on

Returns a video job as it stands now. Requires the API key of the account that created it. urls and usage appear when status is completed, error when it is failed.

get/v1/videos/{id}

Request

Path parameters

idstring required

The job's id, as POST /v1/videos returned it.

Response

The job as it stands now.

idstring required

The job id; the polling and content URLs carry it.

objectstring required

Always video.generation.

modelstring required

The model the job was submitted for, as the caller named it.

statusstring required

pending, in_progress, completed or failed.

polling_urlstring required

Where to poll this job.

created_atinteger required

Unix seconds when the job was accepted.

completed_atinteger nullable

Unix seconds when the job reached completed or failed.

durationinteger required

The requested clip length in seconds.

resolutionstring required

The requested resolution.

aspect_ratiostring required

The requested aspect ratio.

urlsstring[] nullable

Links to the finished file; present once the job is completed.

Example response

{
  "object": "video.generation"
}

Changes