Skip to main content
POST
Register an avatar-agent persona

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
name
string
required

Tenant-supplied label rendered in the picker. Unique within the tenant (case-insensitive).

Required string length: 1 - 80
agent_id
string
required

The conversational agent that drives the dialog (agt_-prefixed).

Required string length: 1 - 64
provider
enum<string>
required

Rendered-avatar provider this persona uses.

Available options:
tavus,
heygen,
did
provider_persona_ref
string
required

The tenant's own opaque persona/replica reference id at that provider.

Required string length: 1 - 200
greeting
string | null

Optional opening line the avatar speaks on join.

Maximum string length: 500
locale
string | null

Optional BCP-47-ish locale hint for TTS (e.g. en-US).

Maximum string length: 35
enabled
boolean

Whether the persona is dispatchable to rooms. Defaults to true.

Response

The registered avatar persona.

data
object
meta
object