API Reference

Videos

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Fetch a character.

client.videos.getCharacter(stringcharacterID, RequestOptionsoptions?): VideoGetCharacterResponse { id, created_at, name }

GET/videos/characters/{character_id}

Fetch a character.

ParametersExpand Collapse

characterID: string

ReturnsExpand Collapse

VideoGetCharacterResponse { id, created_at, name }

id: string | null

Identifier for the character creation cameo.

created_at: number

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

name: string | null

Display name for the character.

Fetch a character.

TypeScript

HTTP

TypeScript

Python

Java

Go

Ruby

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted
});

const response = await client.videos.getCharacter('char_123');

console.log(response.id);

200 example

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

Returns Examples

200 example

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