descriptionstring nullable
labelstring nullable
The agent label (DEPRECATED - use labels instead.)
typestring required
The agent type. Must be "ca_v1" currently.
prompt_idinteger required
ID of the prompt associated with the agent
prompt_version_numberinteger nullable
Optional pin to a specific version of the prompt (prompt history version number). When omitted or null, the agent tracks the latest/current version of the prompt. When set, the agent runs that specific prompt version. Must reference an existing version of the agent's prompt.
custom_message_idinteger nullable
Internal ID of the custom message that should be delivered at the beginning of a conversation with the agent
language_group_idinteger nullable
Internal ID of the language group associated with the agent
bridge_phrases_idinteger nullable
Internal ID of the bridge phrases config associated with the agent
timezonestring required
The time zone in which the agent operates
languagesstring[]
BCP 47 codes of languages the agent supports. (DEPRECATED - pass an empty list here and use language group ID to link agent to a language group instead.)
variablesobject required
Custom context variables for the conversation session. Keys should be prefixed with "vars.".
tool_headersobject nullable required
Optional headers to include in tool calls for agent. (It is discouraged to use this field for "Authorization" headers, as values here are not encrypted. Instead, set up a service with either basic, bearer, or custom header auth; attach the appropriate tools to that service, and the attached tools will automatically use the auth configured on the service.)
agent_initiatedboolean
Whether the agent initiates conversation with a user after the custom_message is delivered
stt_providerstring nullable
Speech-to-text provider for the agent.
wait_soundstring nullable
Sound to play while waiting for a response from the LLM.
enable_verbal_language_changeboolean
Enables Dynamic Language Switching - when true and a voice group is configured, callers may switch among group languages by speaking at any point in the conversation (in addition to DTMF in response to the language menu).
updated_atstring date-time required
Timestamp of most recent update
last_updated_bystring nullable required
Email of the user who last updated the agent