Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Retrieve a video

$ openai videos retrieve
GET
/videos/{video_id}

Fetch the latest metadata for a generated video.

Retrieve a video

openai videos retrieve \
  --api-key 'My API Key' \
  --video-id video_123
Response example
{
  "id": "video_123",
  "object": "video",
  "model": "sora-2",
  "status": "queued",
  "progress": 0,
  "created_at": 1712697600,
  "completed_at": null,
  "error": null,
  "expires_at": null,
  "prompt": "A calico cat playing a piano on stage",
  "remixed_from_video_id": null,
  "size": "720x1280",
  "seconds": "4"
}
Parameters
--video-id: string

The identifier of the video to retrieve.

Returns
video: object { id, completed_at, created_at, 10 more }

Structured information describing a generated video job.

id: string

Unique identifier for the video job.

completed_at: number

Unix timestamp (seconds) for when the job completed, if finished.

created_at: number

Unix timestamp (seconds) for when the job was created.

error: object { code, message, headers, 3 more }

Error payload that explains why generation failed, if applicable.

expires_at: number

Unix timestamp (seconds) for when the downloadable assets expire, if set.

model: string or "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more

The video generation model that produced the job.

object: "video"

The object type, which is always video.

progress: number

Approximate completion percentage for the generation task.

prompt: string

The prompt that was used to generate the video.

remixed_from_video_id: string

Identifier of the source video if this video is a remix.

seconds: string or VideoSeconds

Duration of the generated clip in seconds. For extensions, this is the stitched total duration.

size: "720x1280" or "1280x720" or "1024x1792" or "1792x1024"

The resolution of the generated video.

status: "queued" or "in_progress" or "completed" or "failed"

Current lifecycle status of the video job.

Returns Examples
Response example
{
  "id": "video_123",
  "object": "video",
  "model": "sora-2",
  "status": "queued",
  "progress": 0,
  "created_at": 1712697600,
  "completed_at": null,
  "error": null,
  "expires_at": null,
  "prompt": "A calico cat playing a piano on stage",
  "remixed_from_video_id": null,
  "size": "720x1280",
  "seconds": "4"
}