Skip to main content
Retrieve an avatar

Authorizations

Authorization
string
header
required

Live API key minted in the dashboard. Pass as Authorization: Bearer sk_live_…. Keys are scoped to a single environment (staging / prod).

Path Parameters

avatar_id
string
required

Stable av_… avatar id.

Response

Successful Response

Public Avatar resource returned by GET /v1/avatars and GET /v1/avatars/{id}.

created_at
string<date-time>
required
id
string
required

Stable av_… avatar id. Platform stock avatars use fixed ids such as av_stock_001; customer avatars use generated ids.

is_demo
boolean
required

True for platform stock avatars (e.g. av_stock_001).

name
string
required
runtime_type
string
required

Runtime that serves this avatar (e.g. mock, avtr1).

status
enum<string>
required

Lifecycle of a custom avatar.

ready — usable for sessions. processing — being fitted / converted. failed — fitting failed; will not be usable without re-upload.

Available options:
ready,
processing,
failed
custom_instructions
string | null

Preferred managed-conversation instructions for this avatar, when configured.

failure_reason
string | null

Human-readable reason the build failed (e.g. No face detected in source image.). Only set while status is failed.

object
string
default:avatar
Allowed value: "avatar"
voice
string | null

Preferred conversation voice for this avatar, when configured.

voice_instructions
string | null

Voice-style instructions for managed conversations using this avatar.