Skip to content
API Reference
Videos

List videos

client.Videos.List(ctx, query) (*ConversationCursorPage[Video], error)
GET/videos

List videos

ParametersExpand Collapse
query VideoListParams
After param.Field[string]optional

Identifier for the last item from the previous pagination request

Limit param.Field[int64]optional

Number of items to retrieve

minimum0
maximum100
Order param.Field[VideoListParamsOrder]optional

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

const VideoListParamsOrderAsc VideoListParamsOrder = "asc"
const VideoListParamsOrderDesc VideoListParamsOrder = "desc"
ReturnsExpand Collapse
type Video struct{…}

Structured information describing a generated video job.

ID string

Unique identifier for the video job.

CompletedAt int64

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

CreatedAt int64

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

Error VideoCreateError

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.

ExpiresAt int64

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

Model VideoModel

The video generation model that produced the job.

Accepts one of the following:
string
type VideoModel string
Accepts one of the following:
const VideoModelSora2 VideoModel = "sora-2"
const VideoModelSora2Pro VideoModel = "sora-2-pro"
const VideoModelSora2_2025_10_06 VideoModel = "sora-2-2025-10-06"
const VideoModelSora2Pro2025_10_06 VideoModel = "sora-2-pro-2025-10-06"
const VideoModelSora2_2025_12_08 VideoModel = "sora-2-2025-12-08"
Object Video

The object type, which is always video.

Progress int64

Approximate completion percentage for the generation task.

Prompt string

The prompt that was used to generate the video.

RemixedFromVideoID string

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

Seconds VideoSeconds

Duration of the generated clip in seconds.

Accepts one of the following:
const VideoSeconds4 VideoSeconds = "4"
const VideoSeconds8 VideoSeconds = "8"
const VideoSeconds12 VideoSeconds = "12"
Size VideoSize

The resolution of the generated video.

Accepts one of the following:
const VideoSize720x1280 VideoSize = "720x1280"
const VideoSize1280x720 VideoSize = "1280x720"
const VideoSize1024x1792 VideoSize = "1024x1792"
const VideoSize1792x1024 VideoSize = "1792x1024"
Status VideoStatus

Current lifecycle status of the video job.

Accepts one of the following:
const VideoStatusQueued VideoStatus = "queued"
const VideoStatusInProgress VideoStatus = "in_progress"
const VideoStatusCompleted VideoStatus = "completed"
const VideoStatusFailed VideoStatus = "failed"

List videos

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.Videos.List(context.TODO(), openai.VideoListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "data": [
    {
      "id": "id",
      "completed_at": 0,
      "created_at": 0,
      "error": {
        "code": "code",
        "message": "message"
      },
      "expires_at": 0,
      "model": "string",
      "object": "video",
      "progress": 0,
      "prompt": "prompt",
      "remixed_from_video_id": "remixed_from_video_id",
      "seconds": "4",
      "size": "720x1280",
      "status": "queued"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id",
  "object": "list"
}
Returns Examples
{
  "data": [
    {
      "id": "id",
      "completed_at": 0,
      "created_at": 0,
      "error": {
        "code": "code",
        "message": "message"
      },
      "expires_at": 0,
      "model": "string",
      "object": "video",
      "progress": 0,
      "prompt": "prompt",
      "remixed_from_video_id": "remixed_from_video_id",
      "seconds": "4",
      "size": "720x1280",
      "status": "queued"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id",
  "object": "list"
}