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

List videos

videos.list(VideoListParams**kwargs) -> SyncConversationCursorPage[Video]
GET/videos

List recently generated videos for the current project.

ParametersExpand Collapse
after: Optional[str]

Identifier for the last item from the previous pagination request

limit: Optional[int]

Number of items to retrieve

minimum0
maximum100
order: Optional[Literal["asc", "desc"]]

Sort order of results by timestamp. Use asc for ascending order or desc for descending order.

ReturnsExpand Collapse
class Video: …

Structured information describing a generated video job.

id: str

Unique identifier for the video job.

completed_at: Optional[int]

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

formatunixtime
created_at: int

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

formatunixtime
error: Optional[VideoCreateError]

Error payload that explains why generation failed, if applicable.

expires_at: Optional[int]

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

formatunixtime
model: VideoModel

The video generation model that produced the job.

object: Literal["video"]

The object type, which is always video.

progress: int

Approximate completion percentage for the generation task.

prompt: Optional[str]

The prompt that was used to generate the video.

remixed_from_video_id: Optional[str]

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

seconds: Union[str, 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: Literal["queued", "in_progress", "completed", "failed"]

Current lifecycle status of the video job.

List videos

from openai import OpenAI

client = OpenAI()
page = client.videos.list()
page = page.data[0]
print(page.id)

{
  "data": [
    {
      "id": "video_123",
      "object": "video",
      "model": "sora-2",
      "status": "completed",
      "created_at": 1712697600,
      "completed_at": 1712697840,
      "progress": 100,
      "expires_at": null,
      "error": null,
      "prompt": "A calico cat playing a piano on stage",
      "size": "1024x1792",
      "seconds": "8",
      "remixed_from_video_id": null
    }
  ],
  "object": "list",
  "first_id": "video_123",
  "last_id": "video_123",
  "has_more": false
}
Returns Examples
{
  "data": [
    {
      "id": "video_123",
      "object": "video",
      "model": "sora-2",
      "status": "completed",
      "created_at": 1712697600,
      "completed_at": 1712697840,
      "progress": 100,
      "expires_at": null,
      "error": null,
      "prompt": "A calico cat playing a piano on stage",
      "size": "1024x1792",
      "seconds": "8",
      "remixed_from_video_id": null
    }
  ],
  "object": "list",
  "first_id": "video_123",
  "last_id": "video_123",
  "has_more": false
}