Skip to main content
POST
Script an avatar-video render job

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
avatar_agent_id
string
required

The vaa_-prefixed avatar persona to render from. Must be an existing, enabled persona.

Required string length: 1 - 64
script_template
string
required

The operator-authored script, with optional {{merge_field}} tokens.

Required string length: 1 - 5000
locale
string | null

Optional BCP-47-ish locale override for TTS; falls back to the persona's locale when omitted.

Maximum string length: 35
merge_fields
object

Values for every {{token}} referenced by script_template. A referenced token with no supplied value rejects the request.

Response

The scripted render job, queued for the render runtime.

data
object
meta
object