Update agent

1 curl -X PATCH https://api.elevenlabs.io/v1/convai/agents/agent_id \ 2 -H "xi-api-key: xi-api-key" \ 3 -H "Content-Type: application/json" \ 4 -d '{}'

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 "type": "system" 77 }, 78 "language_detection": { 79 "name": "foo", 80 "description": "foo", 81 "params": { 82 "system_tool_type": "end_call" 83 }, 84 "response_timeout_secs": 20, 85 "type": "system" 86 }, 87 "transfer_to_agent": { 88 "name": "foo", 89 "description": "foo", 90 "params": { 91 "system_tool_type": "end_call" 92 }, 93 "response_timeout_secs": 20, 94 "type": "system" 95 }, 96 "transfer_to_number": { 97 "name": "foo", 98 "description": "foo", 99 "params": { 100 "system_tool_type": "end_call" 101 }, 102 "response_timeout_secs": 20, 103 "type": "system" 104 }, 105 "skip_turn": { 106 "name": "foo", 107 "description": "foo", 108 "params": { 109 "system_tool_type": "end_call" 110 }, 111 "response_timeout_secs": 20, 112 "type": "system" 113 }, 114 "play_keypad_touch_tone": { 115 "name": "foo", 116 "description": "foo", 117 "params": { 118 "system_tool_type": "end_call" 119 }, 120 "response_timeout_secs": 20, 121 "type": "system" 122 } 123 }, 124 "mcp_server_ids": [ 125 "foo" 126 ], 127 "native_mcp_server_ids": [ 128 "foo" 129 ], 130 "knowledge_base": [ 131 { 132 "type": "file", 133 "name": "foo", 134 "id": "foo", 135 "usage_mode": "prompt" 136 } 137 ], 138 "custom_llm": { 139 "url": "foo", 140 "model_id": "foo", 141 "api_key": { 142 "secret_id": "foo" 143 }, 144 "request_headers": {} 145 }, 146 "ignore_default_personality": true, 147 "rag": { 148 "enabled": false, 149 "embedding_model": "e5_mistral_7b_instruct", 150 "max_vector_distance": 0.6, 151 "max_documents_length": 50000, 152 "max_retrieved_rag_chunks_count": 20 153 }, 154 "tools": [ 155 { 156 "name": "foo", 157 "description": "foo", 158 "response_timeout_secs": 20, 159 "type": "webhook", 160 "api_schema": { 161 "url": "foo", 162 "method": "GET", 163 "path_params_schema": {}, 164 "query_params_schema": { 165 "properties": {}, 166 "required": [ 167 "foo" 168 ] 169 }, 170 "request_body_schema": { 171 "type": "object", 172 "required": [ 173 "foo" 174 ], 175 "description": "", 176 "properties": {} 177 }, 178 "request_headers": {}, 179 "auth_connection": { 180 "auth_connection_id": "foo" 181 } 182 }, 183 "dynamic_variables": { 184 "dynamic_variable_placeholders": {} 185 } 186 } 187 ] 188 } 189 } 190 }, 191 "metadata": { 192 "created_at_unix_secs": 42 193 } 194 }

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.

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

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

Path parameters

Headers

Request

Response

Errors