API Reference

Videos

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create a character from an uploaded video.

VideoCreateCharacterResponse videos().createCharacter(VideoCreateCharacterParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/videos/characters

Create a character from an uploaded video.

ParametersExpand Collapse

VideoCreateCharacterParams params

String name

Display name for this API character.

maxLength80

minLength1

InputStream video

Video file used to create a character.

ReturnsExpand Collapse

class VideoCreateCharacterResponse:

Optional<String> id

Identifier for the character creation cameo.

long createdAt

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

Optional<String> name

Display name for the character.

Create a character from an uploaded video.

Java

HTTP

TypeScript

Python

Java

Go

Ruby

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.videos.VideoCreateCharacterParams;
import com.openai.models.videos.VideoCreateCharacterResponse;
import java.io.ByteArrayInputStream;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        VideoCreateCharacterParams params = VideoCreateCharacterParams.builder()
            .name("x")
            .video(ByteArrayInputStream("Example data".getBytes()))
            .build();
        VideoCreateCharacterResponse response = client.videos().createCharacter(params);
    }
}

200 example

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

Returns Examples

200 example

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