Skip to content
Primary navigation

Fetch a character.

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

Fetch a character.

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

Fetch a character.

require "openai"

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

response = openai.videos.get_character("char_123")

puts(response)
{
  "id": "id",
  "created_at": 0,
  "name": "name"
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "name": "name"
}