Skip to content
Primary navigation

Fetch a character.

VideoGetCharacterResponse videos().getCharacter(VideoGetCharacterParamsparams = VideoGetCharacterParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/videos/characters/{character_id}

Fetch a character.

ParametersExpand Collapse
VideoGetCharacterParams params
Optional<String> characterId
ReturnsExpand Collapse
class VideoGetCharacterResponse:
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.

Fetch a character.

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.videos.VideoGetCharacterParams;
import com.openai.models.videos.VideoGetCharacterResponse;

public final class Main {
    private Main() {}

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

        VideoGetCharacterResponse response = client.videos().getCharacter("char_123");
    }
}
{
  "id": "id",
  "created_at": 0,
  "name": "name"
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "name": "name"
}