Create a new persona
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Configuration for the new persona. avatarId, voiceId, and llmId are references to existing resources in your organization. systemPrompt, if provided, is merged into the brain field server-side. Setting zeroDataRetention to true requires both the voice and LLM to be ZDR-compatible and an enterprise plan.
Name of the persona
"Cara"
Description of the persona, for example "A helpful assistant". Does not affect the persona's behavior.
The avatar to use.
"071b0286-4cce-4808-bee2-e642f1062de3"
Avatar model version. Models with the '-latest' suffix are invite only.
cara-2, cara-3, cara-4-latest "cara-3"
The voice to use.
"de23e340-1416-4dd8-977d-065a7ca11697"
The LLM to use. To disable the LLM, use 'CUSTOMER_CLIENT_V1'.
"a7cf662c-2ace-4de1-a21e-ef0fbf144bb7"
System prompt for the LLM
"You are a helpful assistant"
Whether to skip the greeting message when starting a session with this persona.
false
When true, the greeting message cannot be interrupted by the user.
false
When true, session data is not stored after the conversation ends
false
Options for voice activity detection during user speech input.
ISO 639-1 formatted language code override for transcription, replaces organisation level settings and multilingual (default) mode.
"en"
Configuration options for voice generation.
Array of tool IDs to attach to the persona.
["tool-id-1", "tool-id-2"]Successfully created persona
Full persona shape returned by the create, get, and update endpoints.
Unique identifier for the persona.
Human-readable name of the persona.
Free-form description of the persona.
Name of the preset the persona was cloned from, if any.
Avatar currently attached to the persona.
Public model version (e.g. cara-3) used when rendering the avatar.
Voice currently attached to the persona.
Speech rate multiplier applied to the voice.
ID of the LLM the persona uses, or null for presets that don't run an LLM.
Persona behaviour configuration applied on top of the raw LLM.
Tool configurations currently attached to the persona.
Knowledge group attachments currently active on the persona.
All share links ever issued for this persona.
The primary share link attached to the persona, if one has been created.
Whether audio is passed through from the client instead of being generated server-side.
Whether the persona skips the greeting message at the start of a session.
Whether session data is discarded instead of stored after the conversation ends.
Voice activity detection tuning for user speech.
Provider-specific voice generation tuning.
Widget rendering overrides (e.g. removing the watermark).
Timestamp when the persona was created.
Timestamp when the persona was last updated.