Sign in
Videos

Create a video generation job

POST /v1/videos

post/api/v1/videos

Request

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

Request body

modelstring nullable

The model to use for video generation (defaults to sora-2).

promptstring required

A text description of the desired video.

seconds'4' | '8' | '12' | '16' | '20'

Requested video duration in seconds. Creation/edits allow 4/8/12; extensions additionally allow 16/20.

size'720x1280' | '1280x720' | '1024x1792' | '1792x1024'

Output resolution for a generated video.

Response

Video job created

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.