Skip to content
Primary navigation

Create a character from an uploaded video.

videos.create_character(VideoCreateCharacterParams**kwargs) -> VideoCreateCharacterResponse
POST/videos/characters

Create a character from an uploaded video.

ParametersExpand Collapse
name: str

Display name for this API character.

maxLength80
minLength1
video: FileTypes

Video file used to create a character.

ReturnsExpand Collapse
class VideoCreateCharacterResponse:
id: Optional[str]

Identifier for the character creation cameo.

created_at: int

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

name: Optional[str]

Display name for the character.

Create a character from an uploaded video.

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
response = client.videos.create_character(
    name="x",
    video=b"Example data",
)
print(response.id)
{
  "id": "id",
  "created_at": 0,
  "name": "name"
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "name": "name"
}