Agents

Update Agent

Update an existing agent's configuration. Only provided fields will be updated. Omitted fields remain unchanged.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

agent_idstringRequired

Request

This endpoint expects an object.
namestring or nullOptional
Agent name
descriptionstring or nullOptional
Agent description
custom_descriptionstring or nullOptional
Custom agent description
languagestring or nullOptional

Agent language: English, Hindi, Tamil, Telugu, Bengali, Gujarati, Kannada, Malayalam, Marathi

sectorstring or nullOptional
Industry sector
tonestring or nullOptional

Agent tone: professional, friendly, casual, formal

agent_rolestring or nullOptional
Agent role
ai_modelstring or nullOptional

AI model: lai-premium-2, lai-premium-3, lai-premium-4

voicestring or nullOptional
Voice gender
voice_idstring or nullOptional
Voice ID
accentstring or nullOptional
Voice accent
pronunciationsmap from strings to strings or nullOptional
Custom pronunciations
voice_response_settingsobject or nullOptional

Voice & response settings

promptstring or nullOptional

Agent prompt/instructions

start_flowstring or nullOptional
Opening greeting
end_flowstring or nullOptional
Closing message
details_to_collectlist of objects or nullOptional

Information the agent should collect during the call. List of items, each with: key (string — field name), type (text/number/email/phone), description (string — what to collect)

brand_namestring or nullOptional
Brand name
typed_knowledgestring or nullOptional
Knowledge base text
timezonestring or nullOptional
Timezone
webhook_configobject or nullOptional

Webhook configuration. Fields: url (string, required) — the endpoint URL to receive events. Optional: events (list of event names like call.completed, call.failed), headers (dict of custom headers)

custom_apilist of objects or nullOptional

List of custom API tool configurations the agent can call during conversations. Each item: api_name (string), api_url (string), method (GET/POST/PUT/DELETE), headers (list of {key, value}), query_params (list of {key, value, is_variable}), body (dict/string), content_type (application/json)

lookup_apiobject or nullOptional

Pre-call data lookup configuration. Called at session start to fetch customer data. Required fields: api_name (string), api_url (string), method (GET/POST). Optional: enabled (bool), headers (list of {key, value, is_variable}), query_params (list of {key, value, is_variable}), path_params (list of {name, source}), body_template (dict), auth_type (bearer/api_key/basic), auth_token (string), timeout_seconds (int), retry_count (int)

transfer_maplist of objects or nullOptional

Human handoff phone numbers. List of transfer targets, each with: name (string), number (string — phone number), country_code (string), category (string)

other_languageslist of strings or nullOptional
Additional languages

Response

Successful Response
dataobject
Full agent detail response.
request_idstring
timestampdatetime
successbooleanOptionalDefaults to true

Errors

422
Unprocessable Entity Error