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

Videos

Create video
Deprecated
client.videos.create(VideoCreateParams { prompt, input_reference, model, 2 more } body, RequestOptionsoptions?): Video { id, completed_at, created_at, 10 more }
POST/videos
Create a character from an uploaded video.
Deprecated
client.videos.createCharacter(VideoCreateCharacterParams { name, video } body, RequestOptionsoptions?): VideoCreateCharacterResponse { id, created_at, name }
POST/videos/characters
Delete video
Deprecated
client.videos.delete(stringvideoID, RequestOptionsoptions?): VideoDeleteResponse { id, deleted, object }
DELETE/videos/{video_id}
Retrieve video content
Deprecated
client.videos.downloadContent(stringvideoID, VideoDownloadContentParams { variant } query?, RequestOptionsoptions?): Response
GET/videos/{video_id}/content
Create a new video generation job by editing a source video or existing generated video.
Deprecated
client.videos.edit(VideoEditParams { prompt, video } body, RequestOptionsoptions?): Video { id, completed_at, created_at, 10 more }
POST/videos/edits
Create an extension of a completed video.
Deprecated
client.videos.extend(VideoExtendParams { prompt, seconds, video } body, RequestOptionsoptions?): Video { id, completed_at, created_at, 10 more }
POST/videos/extensions
Fetch a character.
Deprecated
client.videos.getCharacter(stringcharacterID, RequestOptionsoptions?): VideoGetCharacterResponse { id, created_at, name }
GET/videos/characters/{character_id}
List videos
Deprecated
client.videos.list(VideoListParams { after, limit, order } query?, RequestOptionsoptions?): ConversationCursorPage<Video { id, completed_at, created_at, 10 more } >
GET/videos
Remix video
Deprecated
client.videos.remix(stringvideoID, VideoRemixParams { prompt } body, RequestOptionsoptions?): Video { id, completed_at, created_at, 10 more }
POST/videos/{video_id}/remix
Retrieve video
Deprecated
client.videos.retrieve(stringvideoID, RequestOptionsoptions?): Video { id, completed_at, created_at, 10 more }
GET/videos/{video_id}
ModelsExpand Collapse
ImageInputReferenceParam { file_id, image_url }
Video { id, completed_at, created_at, 10 more }

Structured information describing a generated video job.

VideoCreateCharacterResponse { id, created_at, name }
VideoCreateError { code, message }

An error that occurred while generating the response.

VideoDeleteResponse { id, deleted, object }

Confirmation payload returned after deleting a video.

VideoGetCharacterResponse { id, created_at, name }
VideoModel = (string & {}) | "sora-2" | "sora-2-pro" | "sora-2-2025-10-06" | 2 more
VideoSeconds = "4" | "8" | "12"
VideoSize = "720x1280" | "1280x720" | "1024x1792" | "1792x1024"