Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Create a character

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

Create a character from an uploaded video.

Parameters
name: String

Display name for this API character.

minLength1
maxLength80
video: FileInput

Video file used to create a character.

Returns
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.

formatunixtime
name: String

Display name for the character.

Create a character

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"
}