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

Video videos().retrieve(params = VideoRetrieveParams.none(), requestOptions = RequestOptions.none())
GET
/videos/{video_id}

Fetch the latest metadata for a generated video.

Parameters
VideoRetrieveParams params
Optional<String> videoId
Returns
class Video:

Structured information describing a generated video job.

String id

Unique identifier for the video job.

Optional<Long> completedAt

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

formatunixtime
long createdAt

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

formatunixtime
Optional<VideoCreateError> error

Error payload that explains why generation failed, if applicable.

Optional<Long> expiresAt

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

formatunixtime
VideoModel model

The video generation model that produced the job.

JsonValue; object_
constant
constant

The object type, which is always video.

long progress

Approximate completion percentage for the generation task.

Optional<String> prompt

The prompt that was used to generate the video.

Optional<String> remixedFromVideoId

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

VideoSeconds seconds

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

VideoSize size

The resolution of the generated video.

Status status

Current lifecycle status of the video job.

Retrieve a video

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.videos.Video;
import com.openai.models.videos.VideoRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        Video video = client.videos().retrieve("video_123");
    }
}

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