Skip to content
API Reference

Videos

Create video
client.Videos.New(ctx, body) (*Video, error)
POST/videos
List videos
client.Videos.List(ctx, query) (*ConversationCursorPage[Video], error)
GET/videos
Retrieve video
client.Videos.Get(ctx, videoID) (*Video, error)
GET/videos/{video_id}
Delete video
client.Videos.Delete(ctx, videoID) (*VideoDeleteResponse, error)
DELETE/videos/{video_id}
Remix video
client.Videos.Remix(ctx, videoID, body) (*Video, error)
POST/videos/{video_id}/remix
Retrieve video content
client.Videos.DownloadContent(ctx, videoID, query) (*Response, error)
GET/videos/{video_id}/content
ModelsExpand 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.

ExpiresAt int64

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

Model VideoModel

The video generation model that produced the job.

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.

Size VideoSize

The resolution of the generated video.

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"
type VideoCreateError struct{…}

An error that occurred while generating the response.

Code string

A machine-readable error code that was returned.

Message string

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

type VideoModel interface{…}
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"
type VideoSeconds string
Accepts one of the following:
const VideoSeconds4 VideoSeconds = "4"
const VideoSeconds8 VideoSeconds = "8"
const VideoSeconds12 VideoSeconds = "12"
type VideoSize string
Accepts one of the following:
const VideoSize720x1280 VideoSize = "720x1280"
const VideoSize1280x720 VideoSize = "1280x720"
const VideoSize1024x1792 VideoSize = "1024x1792"
const VideoSize1792x1024 VideoSize = "1792x1024"