Get agent

GET

/v1/convai/agents/:agent_id

GET

/v1/convai/agents/:agent_id

1 curl https://api.elevenlabs.io/v1/convai/agents/21m00Tcm4TlvDq8ikWAM \
2      -H "xi-api-key: <apiKey>"

Try it

200Retrieved

1 {
2   "agent_id": "J3Pbu5gP6NNKBscdCdwB",
3   "name": "My Agent",
4   "conversation_config": {
5     "asr": {
6       "quality": "high",
7       "provider": "elevenlabs",
8       "user_input_audio_format": "pcm_16000",
9       "keywords": [
10         "hello",
11         "world"
12       ]
13     },
14     "turn": {
15       "turn_timeout": 7,
16       "silence_end_call_timeout": -1,
17       "mode": "turn"
18     },
19     "tts": {
20       "model_id": "eleven_turbo_v2",
21       "voice_id": "cjVigY5qzO86Huf0OWal",
22       "agent_output_audio_format": "pcm_16000",
23       "optimize_streaming_latency": 3,
24       "stability": 0.5,
25       "speed": 1,
26       "similarity_boost": 0.8,
27       "pronunciation_dictionary_locators": [
28         {
29           "pronunciation_dictionary_id": "pronunciation_dictionary_id"
30         }
31       ]
32     },
33     "conversation": {
34       "max_duration_seconds": 600,
35       "client_events": [
36         "audio",
37         "interruption"
38       ]
39     },
40     "language_presets": {
41       "key": {
42         "overrides": {}
43       }
44     },
45     "agent": {
46       "first_message": "Hello, how can I help you today?",
47       "language": "en",
48       "dynamic_variables": {
49         "dynamic_variable_placeholders": {
50           "user_name": "John Doe"
51         }
52       },
53       "prompt": {
54         "prompt": "You are a helpful assistant that can answer questions about the topic of the conversation.",
55         "llm": "gemini-2.0-flash-001",
56         "temperature": 0,
57         "max_tokens": -1,
58         "tools": [
59           {
60             "type": "client",
61             "description": "description",
62             "name": "name",
63             "dynamic_variables": {
64               "dynamic_variable_placeholders": {
65                 "user_name": "John Doe"
66               }
67             },
68             "expects_response": false
69           }
70         ],
71         "tool_ids": [
72           "tool_ids"
73         ],
74         "knowledge_base": [
75           {
76             "type": "file",
77             "name": "My Knowledge Base",
78             "id": "123",
79             "usage_mode": "auto"
80           }
81         ]
82       }
83     }
84   },
85   "metadata": {
86     "created_at_unix_secs": 1
87   },
88   "platform_settings": {
89     "auth": {
90       "enable_auth": true,
91       "allowlist": [
92         {
93           "hostname": "https://example.com"
94         }
95       ],
96       "shareable_token": "1234567890"
97     },
98     "evaluation": {
99       "criteria": [
100         {
101           "id": "1234567890",
102           "conversation_goal_prompt": "You are a helpful assistant that can answer questions about the topic of the conversation.",
103           "use_knowledge_base": false
104         }
105       ]
106     },
107     "widget": {
108       "variant": "compact",
109       "expandable": "never",
110       "avatar": {
111         "type": "orb",
112         "color_1": "#2792dc",
113         "color_2": "#9ce6e6"
114       },
115       "feedback_mode": "none",
116       "bg_color": "bg_color",
117       "text_color": "text_color",
118       "btn_color": "btn_color",
119       "btn_text_color": "btn_text_color",
120       "border_color": "border_color",
121       "focus_color": "focus_color",
122       "border_radius": 1,
123       "btn_radius": 1,
124       "action_text": "action_text",
125       "start_call_text": "start_call_text",
126       "end_call_text": "end_call_text",
127       "expand_text": "expand_text",
128       "listening_text": "listening_text",
129       "speaking_text": "speaking_text",
130       "shareable_page_text": "shareable_page_text",
131       "shareable_page_show_terms": true,
132       "terms_text": "terms_text",
133       "terms_html": "terms_html",
134       "terms_key": "terms_key",
135       "show_avatar_when_collapsed": true,
136       "disable_banner": true,
137       "mic_muting_enabled": true,
138       "language_selector": false,
139       "custom_avatar_path": "https://example.com/avatar.png"
140     },
141     "data_collection": {
142       "key": {
143         "type": "boolean",
144         "description": "My property",
145         "dynamic_variable": "Dynamic variable",
146         "constant_value": "Constant value"
147       }
148     },
149     "overrides": {
150       "conversation_config_override": {
151         "agent": {
152           "prompt": {
153             "prompt": false
154           },
155           "first_message": false,
156           "language": false
157         },
158         "tts": {
159           "voice_id": false
160         }
161       },
162       "custom_llm_extra_body": true,
163       "enable_conversation_initiation_client_data_from_webhook": true
164     },
165     "call_limits": {
166       "agent_concurrency_limit": -1,
167       "daily_limit": 100000
168     },
169     "privacy": {
170       "record_voice": true,
171       "retention_days": -1,
172       "delete_transcript_and_pii": false,
173       "delete_audio": false,
174       "apply_to_existing_conversations": false
175     },
176     "workspace_overrides": {
177       "conversation_initiation_client_data_webhook": {
178         "url": "https://example.com/webhook",
179         "request_headers": {
180           "Content-Type": "application/json"
181         }
182       }
183     },
184     "safety": {
185       "is_blocked_ivc": true,
186       "is_blocked_non_ivc": true,
187       "ignore_safety_evaluation": true
188     }
189   },
190   "phone_numbers": [
191     {
192       "phone_number": "phone_number",
193       "provider": "twilio",
194       "label": "label",
195       "phone_number_id": "X3Pbu5gP6NNKBscdCdwB",
196       "assigned_agent": {
197         "agent_id": "F3Pbu5gP6NNKBscdCdwB",
198         "agent_name": "My Agent"
199       }
200     }
201   ]
202 }

Retrieve config for an agent

Path parameters

agent_idstringRequired

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

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

Get agent

Path parameters

Headers

Response

Errors