Skip to content
Primary navigation

Fetch a character.

videos.get_character(strcharacter_id) -> VideoGetCharacterResponse
GET/videos/characters/{character_id}

Fetch a character.

ParametersExpand Collapse
character_id: str
ReturnsExpand Collapse
class VideoGetCharacterResponse:
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.

Fetch a character.

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.get_character(
    "char_123",
)
print(response.id)
{
  "id": "id",
  "created_at": 0,
  "name": "name"
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "name": "name"
}