API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Videos

Create video

Deprecated

videos.create(**kwargs) -> Video { id, completed_at, created_at, 10 more }

POST/videos

Create a character from an uploaded video.

Deprecated

videos.create_character(**kwargs) -> VideoCreateCharacterResponse { id, created_at, name }

POST/videos/characters

Delete video

Deprecated

videos.delete(video_id) -> VideoDeleteResponse { id, deleted, object }

DELETE/videos/{video_id}

Retrieve video content

Deprecated

videos.download_content(video_id, **kwargs) -> StringIO

GET/videos/{video_id}/content

Create a new video generation job by editing a source video or existing generated video.

Deprecated

videos.edit(**kwargs) -> Video { id, completed_at, created_at, 10 more }

POST/videos/edits

Create an extension of a completed video.

Deprecated

videos.extend_(**kwargs) -> Video { id, completed_at, created_at, 10 more }

POST/videos/extensions

Fetch a character.

Deprecated

videos.get_character(character_id) -> VideoGetCharacterResponse { id, created_at, name }

GET/videos/characters/{character_id}

List videos

Deprecated

videos.list(**kwargs) -> ConversationCursorPage<Video { id, completed_at, created_at, 10 more } >

GET/videos

Remix video

Deprecated

videos.remix(video_id, **kwargs) -> Video { id, completed_at, created_at, 10 more }

POST/videos/{video_id}/remix

Retrieve video

Deprecated

videos.retrieve(video_id) -> Video { id, completed_at, created_at, 10 more }

GET/videos/{video_id}

ModelsExpand Collapse

class ImageInputReferenceParam { file_id, image_url }

class Video { id, completed_at, created_at, 10 more }

Structured information describing a generated video job.

class VideoCreateCharacterResponse { id, created_at, name }

class VideoCreateError { code, message }

An error that occurred while generating the response.

class VideoDeleteResponse { id, deleted, object }

Confirmation payload returned after deleting a video.

class 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"