Skip to main content
Updates an existing persona by its ID.
Calls PUT /v1/persona/{personaId}

Arguments

string
required
The ID of the persona to update.

Options

string
The name the agent will identify as during conversations.
string
Label shown in place of the name across the dashboard (e.g. a short descriptor like “Irate Escalator”). The persona still identifies as name on calls. Omit or set null to display the name itself.
string
Human-readable description of the persona.
string
Primary language ISO 639-1 code for the persona. One of EN, ES, DE, HI, FR, NL, AR, EL, IT, ID, TH, JA, TL, MS, ZH, TR, PT, HE
string
Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish). One of EN
array
Languages the persona can understand. Multilingual combinations are limited by multilingual speech recognition support. One of EN, ES, DE, HI, FR, NL, AR, EL, IT, ID, TH, JA, TL, MS, ZH, TR, PT, HE Repeatable.
string
Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with optional variants. One of US, US_X_SOUTH, GB, ES, DE, IN, FR, NL, SA, GR, AU, IT, ID, TH, JP, NZ, PH, SG, MY, HK, TR, PT, IL
string
How old the caller sounds and behaves. Only ages the persona’s accent has a voice for are accepted; defaults to ADULT, which every accent supports. One of CHILD, TEENAGER, ADULT, ELDERLY
string
Gender of the persona. One of MALE, FEMALE
string
Background noise setting. One of NONE, AIRPORT, CHILDREN_PLAYING, CITY, COFFEE_SHOP, CONSTRUCTION, CRYING_BABY, DRIVING, LIBRARY, OFFICE, THUNDERSTORM, TRAIN
string
Speech pace of the persona. One of SUPER_SLOW, SLOW, NORMAL, FAST, SUPER_FAST
string
Speech clarity of the persona. One of CLEAR, VAGUE, RAMBLING
switch
Whether the persona uses filler words like “um” and “uh”.
string
Base emotional state of the persona. One of NEUTRAL, CHEERFUL, CONFUSED, FRUSTRATED, SKEPTICAL, RUSHED, DISTRACTED, ANGRY, ANXIOUS, SAD
string
How clearly the persona expresses their intentions. One of CLEAR, INDIRECT, VAGUE
string
How the persona confirms information. One of EXPLICIT, VAGUE
string
How reliable the persona’s memory is. One of HIGH, LOW
string
Deprecated and inert: it no longer affects the call. It set how long the persona waited once the agent stopped talking, and measured across production simulations it moved the reply gap by less than the noise floor, because model and speech latency dominate it. Every persona now uses one voice-activity profile. Use interruption for a caller who talks over the agent. Still accepted and stored so existing clients keep working. BARGE_IN is stored as responseTiming: QUICK with interruption: OCCASIONAL. One of RELAXED, NORMAL, QUICK, BARGE_IN
string
How much the persona talks over the agent while it is still speaking. OFF waits its turn. BACKCHANNEL makes listening noises (“mm-hm”) over the agent without taking the floor, which tests whether the agent wrongly stops for them. OCCASIONAL adds cutting in on some long agent turns, HEAVY on most of them. Timing is randomised per turn, so two runs of the same persona do not interrupt at identical moments. One of OFF, BACKCHANNEL, OCCASIONAL, HEAVY
string
Background story and behavioral patterns for the persona.
array
Messages the persona will say when the agent goes silent during a call. null = “Automatic”: language-appropriate defaults are used at call time. Repeatable.
integer
Seconds of silence before the persona sends an idle message.
integer
Maximum number of idle messages the persona will send before giving up.
switch
Whether the idle message counter resets when the agent speaks.
object
Additional custom properties about the persona.

Example

Every command also takes the global options and sets one of the exit codes.