Get agent

Retrieve config for an agent

Path parameters

agent_idstringRequired
The id of an agent. This is returned on agent creation.

Headers

xi-api-keystringOptional

Query parameters

version_idstringOptional
The ID of the agent version to use
branch_idstringOptional
The ID of the branch to use

Response

Successful Response
agent_idstring
The ID of the agent
namestring
The name of the agent
conversation_configobject
The conversation configuration of the agent
metadataobject
The metadata of the agent
platform_settingsobjectOptional
The platform settings of the agent
phone_numberslist of objectsOptional
The phone numbers of the agent
whatsapp_accountslist of objectsOptional
WhatsApp accounts assigned to the agent
workflowobjectOptional
The workflow of the agent
access_infoobjectOptional
The access information of the agent for the user
tagslist of stringsOptional
Agent tags used to categorize the agent
version_idstringOptional
The ID of the version the agent is on
branch_idstringOptional
The ID of the branch the agent is on
main_branch_idstringOptional
The ID of the main branch for this agent
proceduresmap from strings to objectsOptional

Procedures keyed by procedure_id.

default_hold_audio_urlstringOptionalDefaults to https://eleven-public-cdn-common.elevenlabs.io/convai/ambient-audio-assets/elevator1.mp3
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