Get agent
Retrieve config for an agent
Path parameters
agent_id
The id of an agent. This is returned on agent creation.
Headers
xi-api-key
Query parameters
version_id
The ID of the agent version to use
branch_id
The ID of the branch to use
Response
Successful Response
agent_id
The ID of the agent
name
The name of the agent
conversation_config
The conversation configuration of the agent
metadata
The metadata of the agent
platform_settings
The platform settings of the agent
phone_numbers
The phone numbers of the agent
whatsapp_accounts
WhatsApp accounts assigned to the agent
workflow
The workflow of the agent
access_info
The access information of the agent for the user
version_id
The ID of the version the agent is on
branch_id
The ID of the branch the agent is on
main_branch_id
The ID of the main branch for this agent
procedures
Procedures keyed by procedure_id.
default_hold_audio_url
URL of the default hold tone played to queued callers when no custom hold audio is uploaded, so the dashboard can preview it.
Errors
422
Agents Get Request Unprocessable Entity Error