Update Agent — ElevenLabs Documentation

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_configmap from strings to anyOptional

Conversation configuration for an agent

platform_settingsmap from strings to anyOptional

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

secretslist of objectsOptional

A list of secrets for the agent. Can be used to add new secrets or update and delete the existing ones

namestringOptional

A name to make the agent easier to find

Response

Successful Response

agent_idstring

namestring

conversation_configobject

metadataobject

secretslist of objects

platform_settingsobjectOptional

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

1 { 2 "agent_id": "agent_id", 3 "name": "name", 4 "conversation_config": { 5 "agent": { 6 "first_message": "first_message", 7 "language": "language" 8 }, 9 "asr": { 10 "quality": "high", 11 "provider": "elevenlabs", 12 "user_input_audio_format": "pcm_16000", 13 "keywords": [ 14 "keywords" 15 ] 16 }, 17 "turn": { 18 "turn_timeout": 1.1, 19 "mode": "silence" 20 }, 21 "tts": { 22 "model_id": "eleven_turbo_v2", 23 "voice_id": "voice_id", 24 "agent_output_audio_format": "pcm_16000", 25 "optimize_streaming_latency": 1, 26 "stability": 1.1, 27 "similarity_boost": 1.1, 28 "pronunciation_dictionary_locators": [ 29 { 30 "pronunciation_dictionary_id": "pronunciation_dictionary_id", 31 "version_id": "version_id" 32 } 33 ] 34 }, 35 "conversation": { 36 "max_duration_seconds": 1, 37 "client_events": [ 38 "conversation_initiation_metadata" 39 ] 40 } 41 }, 42 "metadata": { 43 "created_at_unix_secs": 1 44 }, 45 "secrets": [ 46 { 47 "secret_id": "secret_id", 48 "name": "name" 49 } 50 ], 51 "platform_settings": { 52 "auth": { 53 "enable_auth": true, 54 "allowlist": [ 55 { 56 "hostname": "hostname" 57 } 58 ], 59 "shareable_token": "shareable_token" 60 }, 61 "evaluation": { 62 "criteria": [ 63 { 64 "id": "id", 65 "conversation_goal_prompt": "conversation_goal_prompt" 66 } 67 ] 68 }, 69 "widget": { 70 "variant": "compact", 71 "avatar": { 72 "type": "image" 73 }, 74 "feedback_mode": "none", 75 "custom_avatar_path": "custom_avatar_path", 76 "bg_color": "bg_color", 77 "text_color": "text_color", 78 "btn_color": "btn_color", 79 "btn_text_color": "btn_text_color", 80 "border_color": "border_color", 81 "focus_color": "focus_color", 82 "border_radius": 1, 83 "btn_radius": 1, 84 "action_text": "action_text", 85 "start_call_text": "start_call_text", 86 "end_call_text": "end_call_text", 87 "expand_text": "expand_text", 88 "listening_text": "listening_text", 89 "speaking_text": "speaking_text", 90 "shareable_page_text": "shareable_page_text" 91 }, 92 "data_collection": { 93 "key": { 94 "type": "boolean", 95 "description": "description" 96 } 97 }, 98 "overrides": { 99 "custom_llm_extra_body": true 100 }, 101 "ban": { 102 "at_unix": 1, 103 "reason_type": "safety", 104 "reason": "reason" 105 }, 106 "privacy": { 107 "record_voice": true 108 } 109 } 110 }

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

1	{
2	"agent_id": "agent_id",
3	"name": "name",
4	"conversation_config": {
5	"agent": {
6	"first_message": "first_message",
7	"language": "language"
8	},
9	"asr": {
10	"quality": "high",
11	"provider": "elevenlabs",
12	"user_input_audio_format": "pcm_16000",
13	"keywords": [
14	"keywords"
15	]
16	},
17	"turn": {
18	"turn_timeout": 1.1,
19	"mode": "silence"
20	},
21	"tts": {
22	"model_id": "eleven_turbo_v2",
23	"voice_id": "voice_id",
24	"agent_output_audio_format": "pcm_16000",
25	"optimize_streaming_latency": 1,
26	"stability": 1.1,
27	"similarity_boost": 1.1,
28	"pronunciation_dictionary_locators": [
29	{
30	"pronunciation_dictionary_id": "pronunciation_dictionary_id",
31	"version_id": "version_id"
32	}
33	]
34	},
35	"conversation": {
36	"max_duration_seconds": 1,
37	"client_events": [
38	"conversation_initiation_metadata"
39	]
40	}
41	},
42	"metadata": {
43	"created_at_unix_secs": 1
44	},
45	"secrets": [
46	{
47	"secret_id": "secret_id",
48	"name": "name"
49	}
50	],
51	"platform_settings": {
52	"auth": {
53	"enable_auth": true,
54	"allowlist": [
55	{
56	"hostname": "hostname"
57	}
58	],
59	"shareable_token": "shareable_token"
60	},
61	"evaluation": {
62	"criteria": [
63	{
64	"id": "id",
65	"conversation_goal_prompt": "conversation_goal_prompt"
66	}
67	]
68	},
69	"widget": {
70	"variant": "compact",
71	"avatar": {
72	"type": "image"
73	},
74	"feedback_mode": "none",
75	"custom_avatar_path": "custom_avatar_path",
76	"bg_color": "bg_color",
77	"text_color": "text_color",
78	"btn_color": "btn_color",
79	"btn_text_color": "btn_text_color",
80	"border_color": "border_color",
81	"focus_color": "focus_color",
82	"border_radius": 1,
83	"btn_radius": 1,
84	"action_text": "action_text",
85	"start_call_text": "start_call_text",
86	"end_call_text": "end_call_text",
87	"expand_text": "expand_text",
88	"listening_text": "listening_text",
89	"speaking_text": "speaking_text",
90	"shareable_page_text": "shareable_page_text"
91	},
92	"data_collection": {
93	"key": {
94	"type": "boolean",
95	"description": "description"
96	}
97	},
98	"overrides": {
99	"custom_llm_extra_body": true
100	},
101	"ban": {
102	"at_unix": 1,
103	"reason_type": "safety",
104	"reason": "reason"
105	},
106	"privacy": {
107	"record_voice": true
108	}
109	}
110	}