Update agent

PATCH

/v1/convai/agents/:agent_id

PATCH

/v1/convai/agents/:agent_id

1 from elevenlabs import ElevenLabs
2 
3 client = ElevenLabs(
4     api_key="YOUR_API_KEY",
5 )
6 client.conversational_ai.agents.update(
7     agent_id="21m00Tcm4TlvDq8ikWAM",
8 )

Try it

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_8000",
9       "keywords": [
10         "foo"
11       ]
12     },
13     "turn": {
14       "turn_timeout": 7,
15       "silence_end_call_timeout": -1,
16       "mode": "silence"
17     },
18     "tts": {
19       "model_id": "eleven_turbo_v2",
20       "voice_id": "cjVigY5qzO86Huf0OWal",
21       "supported_voices": [
22         {
23           "label": "foo",
24           "voice_id": "foo",
25           "description": "foo",
26           "language": "foo",
27           "model_family": "turbo",
28           "optimize_streaming_latency": 0,
29           "stability": 42,
30           "speed": 42,
31           "similarity_boost": 42
32         }
33       ],
34       "agent_output_audio_format": "pcm_8000",
35       "optimize_streaming_latency": 0,
36       "stability": 0.5,
37       "speed": 1,
38       "similarity_boost": 0.8,
39       "pronunciation_dictionary_locators": [
40         {
41           "pronunciation_dictionary_id": "foo",
42           "version_id": "foo"
43         }
44       ]
45     },
46     "conversation": {
47       "text_only": false,
48       "max_duration_seconds": 600,
49       "client_events": [
50         "conversation_initiation_metadata"
51       ]
52     },
53     "language_presets": {},
54     "agent": {
55       "first_message": "",
56       "language": "en",
57       "dynamic_variables": {
58         "dynamic_variable_placeholders": {}
59       },
60       "prompt": {
61         "prompt": "",
62         "llm": "gpt-4o-mini",
63         "temperature": 0,
64         "max_tokens": -1,
65         "tool_ids": [
66           "foo"
67         ],
68         "built_in_tools": {
69           "end_call": {
70             "name": "foo",
71             "description": "foo",
72             "params": {
73               "system_tool_type": "end_call"
74             },
75             "response_timeout_secs": 20,
76             "assignments": [
77               {
78                 "dynamic_variable": "foo",
79                 "value_path": "foo",
80                 "source": "response"
81               }
82             ],
83             "type": "system"
84           },
85           "language_detection": {
86             "name": "foo",
87             "description": "foo",
88             "params": {
89               "system_tool_type": "end_call"
90             },
91             "response_timeout_secs": 20,
92             "assignments": [
93               {
94                 "dynamic_variable": "foo",
95                 "value_path": "foo",
96                 "source": "response"
97               }
98             ],
99             "type": "system"
100           },
101           "transfer_to_agent": {
102             "name": "foo",
103             "description": "foo",
104             "params": {
105               "system_tool_type": "end_call"
106             },
107             "response_timeout_secs": 20,
108             "assignments": [
109               {
110                 "dynamic_variable": "foo",
111                 "value_path": "foo",
112                 "source": "response"
113               }
114             ],
115             "type": "system"
116           },
117           "transfer_to_number": {
118             "name": "foo",
119             "description": "foo",
120             "params": {
121               "system_tool_type": "end_call"
122             },
123             "response_timeout_secs": 20,
124             "assignments": [
125               {
126                 "dynamic_variable": "foo",
127                 "value_path": "foo",
128                 "source": "response"
129               }
130             ],
131             "type": "system"
132           },
133           "skip_turn": {
134             "name": "foo",
135             "description": "foo",
136             "params": {
137               "system_tool_type": "end_call"
138             },
139             "response_timeout_secs": 20,
140             "assignments": [
141               {
142                 "dynamic_variable": "foo",
143                 "value_path": "foo",
144                 "source": "response"
145               }
146             ],
147             "type": "system"
148           },
149           "play_keypad_touch_tone": {
150             "name": "foo",
151             "description": "foo",
152             "params": {
153               "system_tool_type": "end_call"
154             },
155             "response_timeout_secs": 20,
156             "assignments": [
157               {
158                 "dynamic_variable": "foo",
159                 "value_path": "foo",
160                 "source": "response"
161               }
162             ],
163             "type": "system"
164           },
165           "voicemail_detection": {
166             "name": "foo",
167             "description": "foo",
168             "params": {
169               "system_tool_type": "end_call"
170             },
171             "response_timeout_secs": 20,
172             "assignments": [
173               {
174                 "dynamic_variable": "foo",
175                 "value_path": "foo",
176                 "source": "response"
177               }
178             ],
179             "type": "system"
180           }
181         },
182         "mcp_server_ids": [
183           "foo"
184         ],
185         "native_mcp_server_ids": [
186           "foo"
187         ],
188         "knowledge_base": [
189           {
190             "type": "file",
191             "name": "foo",
192             "id": "foo",
193             "usage_mode": "prompt"
194           }
195         ],
196         "custom_llm": {
197           "url": "foo",
198           "model_id": "foo",
199           "api_key": {
200             "secret_id": "foo"
201           },
202           "request_headers": {},
203           "api_version": "foo"
204         },
205         "ignore_default_personality": true,
206         "rag": {
207           "enabled": false,
208           "embedding_model": "e5_mistral_7b_instruct",
209           "max_vector_distance": 0.6,
210           "max_documents_length": 50000,
211           "max_retrieved_rag_chunks_count": 20
212         },
213         "timezone": "foo",
214         "tools": [
215           {
216             "name": "foo",
217             "description": "foo",
218             "response_timeout_secs": 20,
219             "assignments": [
220               {
221                 "source": "response",
222                 "dynamic_variable": "foo",
223                 "value_path": "foo"
224               }
225             ],
226             "type": "webhook",
227             "api_schema": {
228               "url": "foo",
229               "method": "GET",
230               "path_params_schema": {},
231               "query_params_schema": {
232                 "properties": {},
233                 "required": [
234                   "foo"
235                 ]
236               },
237               "request_body_schema": {
238                 "type": "object",
239                 "required": [
240                   "foo"
241                 ],
242                 "description": "",
243                 "properties": {}
244               },
245               "request_headers": {},
246               "auth_connection": {
247                 "auth_connection_id": "foo"
248               }
249             },
250             "dynamic_variables": {
251               "dynamic_variable_placeholders": {}
252             }
253           }
254         ]
255       }
256     }
257   },
258   "metadata": {
259     "created_at_unix_secs": 42
260   }
261 }

Patches an Agent settings

Path parameters

agent_idstringRequired

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

Request

This endpoint expects an object.

conversation_configobjectOptional

Conversation configuration for an agent

platform_settingsobjectOptional

Platform settings for the agent are all settings that aren't related to the conversation orchestration and content.

workflowanyOptional

Workflow for the agent. This is used to define the flow of the conversation and how the agent interacts with tools.

namestring or nullOptional

A name to make the agent easier to find

tagslist of strings or nullOptional

Tags to help classify and filter the agent

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_settingsobject or null

The platform settings of the agent

phone_numberslist of objects or null

The phone numbers of the agent

workflowany or null

The workflow of the agent

access_infoobject or null

The access information of the agent for the user

tagslist of strings or null

Agent tags used to categorize the agent

Update agent

Path parameters

Headers

Request

Response

Errors