create avatar video

curl --request POST \
  --url https://api.anam.ai/v1/avatar-videos \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "script": "Welcome to the product tour.",
  "personaId": "00000000-0000-0000-0000-000000000000",
  "metadata": {
    "customerJobId": "onboarding-42"
  }
}
'

{
  "id": "avv_123",
  "truncated": true,
  "effectiveMaxDurationSeconds": 123,
  "content": {
    "available": true,
    "url": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "metadata": {},
  "durationSeconds": 123,
  "sessionId": "<string>",
  "failure": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true
  },
  "retryOf": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

POST

avatar-videos

curl --request POST \
  --url https://api.anam.ai/v1/avatar-videos \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "script": "Welcome to the product tour.",
  "personaId": "00000000-0000-0000-0000-000000000000",
  "metadata": {
    "customerJobId": "onboarding-42"
  }
}
'

{
  "id": "avv_123",
  "truncated": true,
  "effectiveMaxDurationSeconds": 123,
  "content": {
    "available": true,
    "url": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "metadata": {},
  "durationSeconds": 123,
  "sessionId": "<string>",
  "failure": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true
  },
  "retryOf": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

required

Stable caller-generated key. Reusing it with the same body returns the original resource; a different body returns 409.

Required string length: 1 - 255

Body

application/json

Option 1
Option 2

script

string

required

Exact text spoken through TTS; the brain is never invoked.

Required string length: 1 - 20000

personaId

string

required

Saved persona to snapshot. Mutually exclusive with direct configuration fields.

avatarId

string

voiceId

string

avatarModel

string

Example:

"cara-4-latest"

directorNotes

object | null

Show child attributes

languageCode

string

Example:

"en"

voiceSpeed

number

Required range: -1 <= x <= 1

voiceGenerationOptions

Cartesia Sonic-3 · object

Voice generation options for Cartesia Sonic-3 models.

Cartesia Sonic-3
ElevenLabs V1
ElevenLabs V2
Fish Audio

Show child attributes

videoWidth

integer

Required range: x >= 1

videoHeight

integer

Required range: x >= 1

metadata

object

Caller metadata, up to 16 KB serialized.

Response

Accepted. Poll the returned resource.

string

required

Example:

"avv_123"

status

enum<string>

required

Available options:

pending,

running,

finalizing,

completed,

failed,

cancelled

truncated

boolean

required

effectiveMaxDurationSeconds

integer

required

content

object

required

Show child attributes

createdAt

string<date-time>

required

metadata

object

required

completionReason

enum<string> | null

Available options:

script_completed,

max_duration_reached,

cancelled,

null

durationSeconds

number | null

sessionId

string | null

Underlying normal EngineSession ID. Use its recording deletion endpoint for deletion.

failure

object | null

Show child attributes

retryOf

string | null

startedAt

string<date-time> | null

completedAt

string<date-time> | null

Last modified on August 7, 2026

⌘I

Use the API

Sessions

Meetings

Avatar Videos

Personas

Avatars

Voices

LLMs

Knowledge

Tools

Share Links

Engine

create avatar video

Authorizations

Headers

Body

Response