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

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Retrieve a video

videos.retrieve(video_id) -> Video { id, completed_at, created_at, 10 more }
GET
/videos/{video_id}

Fetch the latest metadata for a generated video.

Parameters
video_id: String
Returns
class Video { id, completed_at, created_at, 10 more }

Structured information describing a generated video job.

id: String

Unique identifier for the video job.

completed_at: Integer

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

formatunixtime
created_at: Integer

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

formatunixtime
error: VideoCreateError { code, message, headers, 3 more }

Error payload that explains why generation failed, if applicable.

expires_at: Integer

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

formatunixtime
model: VideoModel

The video generation model that produced the job.

object: :video

The object type, which is always video.

progress: Integer

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 | VideoSeconds

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

size: VideoSize

The resolution of the generated video.

status: :queued | :in_progress | :completed | :failed

Current lifecycle status of the video job.

Retrieve a video

require "openai"

openai = OpenAI::Client.new

video = openai.videos.retrieve("video_123")

puts(video)

{
  "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"
}
Returns Examples
{
  "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"
}