API Reference

Videos

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create a character from an uploaded video.

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

POST/videos/characters

Create a character from an uploaded video.

ParametersExpand Collapse

name: String

Display name for this API character.

maxLength80

minLength1

video: FileInput

Video file used to create a character.

ReturnsExpand Collapse

class VideoCreateCharacterResponse { id, created_at, name }

id: String

Identifier for the character creation cameo.

created_at: Integer

Unix timestamp (in seconds) when the character was created.

name: String

Display name for the character.

Create a character from an uploaded video.

Ruby

HTTP

TypeScript

Python

Java

Go

Ruby

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

response = openai.videos.create_character(name: "x", video: StringIO.new("Example data"))

puts(response)

200 example

{
  "id": "id",
  "created_at": 0,
  "name": "name"
}

Returns Examples

200 example

{
  "id": "id",
  "created_at": 0,
  "name": "name"
}