Create a character | Sample

2 body fields

Multipart form data containing the video used to create the character and its display name.

videostringrequired

Video file used to create a character.

namestringrequired

Display name for this API character.

1 status code

200Returns the created character with its `id`, `name`, and Unix creation timestamp in `created_at`.

idstringrequired

Identifier for the character creation cameo.

namestringrequired

Display name for the character.

created_atintegerrequired

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

Error handling

video and name are required. video must be an uploaded binary video file, and name must contain between 1 and 80 characters.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.characters.create({
  video: "example",
  name: "Untitled",
});

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example Name",
  "created_at": 1
}

Request

Response

Errors