SpyBara
Go Premium

cli/resources/videos/methods/retrieve/index.md 2026-07-10 23:02 UTC to 2026-07-12 06:58 UTC

1 added, 1 removed.

2026
Thu 16 20:57 Wed 15 02:58 Tue 14 06:58 Mon 13 15:59 Sun 12 06:58 Fri 10 23:02 Thu 9 20:58 Tue 7 08:02

Retrieve video

$ openai videos retrieve

get /videos/{video_id}

Fetch the latest metadata for a generated video.

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 }

      Error payload that explains why generation failed, if applicable.

      • code: string

        A machine-readable error code that was returned.

      • message: string

        A human-readable description of the error that was returned.

    • 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.

      • "sora-2"

      • "sora-2-pro"

      • "sora-2-2025-10-06"

      • "sora-2-pro-2025-10-06"

      • "sora-2-2025-12-08"

    • 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.

      • "4"

      • "8"

      • "12"

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

      The resolution of the generated video.

      • "720x1280"

      • "1280x720"

      • "1024x1792"

      • "1792x1024"

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

      Current lifecycle status of the video job.

      • "queued"

      • "in_progress"

      • "completed"

      • "failed"

Example

openai videos retrieve \
  --api-key 'My API Key' \
  --video-id video_123

Response

{
  "id": "id",
  "completed_at": 0,
  "created_at": 0,
  "error": {
    "code": "code",
    "message": "message"
  },
  "expires_at": 0,
  "model": "sora-2",
  "object": "video",
  "progress": 0,
  "prompt": "prompt",
  "remixed_from_video_id": "remixed_from_video_id",
  "seconds": "4",
  "size": "720x1280",
  "status": "queued"
}