Update agent

PATCH

/v1/convai/agents/:agent_id

Patches an Agent settings

Path parameters

agent_idstringRequired

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

Query parameters

use_tool_idsbooleanOptionalDefaults to false

Use tool ids instead of tools specs from request payload.

Request

This endpoint expects an object.

conversation_configanyOptional

platform_settingsanyOptional

namestringOptional

A name to make the agent easier to find

Response

Successful Response

agent_idstring

namestring

conversation_configobject

metadataobject

platform_settingsobjectOptional

phone_numberslist of objectsOptional

Errors

PATCH

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 '{}'

200Updated

1 {
2   "agent_id": "agent_id",
3   "name": "name",
4   "conversation_config": {
5     "asr": {
6       "quality": "high",
7       "provider": "elevenlabs",
8       "user_input_audio_format": "pcm_8000",
9       "keywords": [
10         "keywords"
11       ]
12     },
13     "turn": {
14       "turn_timeout": 1.1,
15       "mode": "silence"
16     },
17     "tts": {
18       "model_id": "eleven_turbo_v2",
19       "voice_id": "voice_id",
20       "agent_output_audio_format": "pcm_8000",
21       "optimize_streaming_latency": 1,
22       "stability": 1.1,
23       "speed": 1.1,
24       "similarity_boost": 1.1,
25       "pronunciation_dictionary_locators": [
26         {
27           "pronunciation_dictionary_id": "pronunciation_dictionary_id",
28           "version_id": "version_id"
29         }
30       ]
31     },
32     "conversation": {
33       "max_duration_seconds": 1,
34       "client_events": [
35         "conversation_initiation_metadata"
36       ]
37     },
38     "language_presets": {
39       "key": {
40         "overrides": {}
41       }
42     },
43     "agent": {
44       "first_message": "first_message",
45       "language": "language"
46     }
47   },
48   "metadata": {
49     "created_at_unix_secs": 1
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       "expandable": "never",
72       "avatar": {
73         "type": "orb"
74       },
75       "feedback_mode": "none",
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       "shareable_page_show_terms": true,
92       "terms_text": "terms_text",
93       "terms_html": "terms_html",
94       "terms_key": "terms_key",
95       "show_avatar_when_collapsed": true,
96       "disable_banner": true,
97       "language_selector": true,
98       "custom_avatar_path": "custom_avatar_path"
99     },
100     "data_collection": {
101       "key": {
102         "type": "boolean"
103       }
104     },
105     "overrides": {
106       "custom_llm_extra_body": true,
107       "enable_conversation_initiation_client_data_from_webhook": true
108     },
109     "call_limits": {
110       "agent_concurrency_limit": 1,
111       "daily_limit": 1
112     },
113     "ban": {
114       "at_unix": 1,
115       "reason_type": "safety",
116       "reason": "reason"
117     },
118     "privacy": {
119       "record_voice": true,
120       "retention_days": 1,
121       "delete_transcript_and_pii": true,
122       "delete_audio": true,
123       "apply_to_existing_conversations": true
124     },
125     "safety": {
126       "is_blocked_ivc": true,
127       "is_blocked_non_ivc": true
128     }
129   },
130   "phone_numbers": [
131     {
132       "phone_number": "phone_number",
133       "provider": "twilio",
134       "label": "label",
135       "phone_number_id": "phone_number_id",
136       "assigned_agent": {
137         "agent_id": "agent_id",
138         "agent_name": "agent_name"
139       }
140     }
141   ]
142 }

Delete agent

Up Next

Built with

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	"asr": {
6	"quality": "high",
7	"provider": "elevenlabs",
8	"user_input_audio_format": "pcm_8000",
9	"keywords": [
10	"keywords"
11	]
12	},
13	"turn": {
14	"turn_timeout": 1.1,
15	"mode": "silence"
16	},
17	"tts": {
18	"model_id": "eleven_turbo_v2",
19	"voice_id": "voice_id",
20	"agent_output_audio_format": "pcm_8000",
21	"optimize_streaming_latency": 1,
22	"stability": 1.1,
23	"speed": 1.1,
24	"similarity_boost": 1.1,
25	"pronunciation_dictionary_locators": [
26	{
27	"pronunciation_dictionary_id": "pronunciation_dictionary_id",
28	"version_id": "version_id"
29	}
30	]
31	},
32	"conversation": {
33	"max_duration_seconds": 1,
34	"client_events": [
35	"conversation_initiation_metadata"
36	]
37	},
38	"language_presets": {
39	"key": {
40	"overrides": {}
41	}
42	},
43	"agent": {
44	"first_message": "first_message",
45	"language": "language"
46	}
47	},
48	"metadata": {
49	"created_at_unix_secs": 1
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	"expandable": "never",
72	"avatar": {
73	"type": "orb"
74	},
75	"feedback_mode": "none",
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	"shareable_page_show_terms": true,
92	"terms_text": "terms_text",
93	"terms_html": "terms_html",
94	"terms_key": "terms_key",
95	"show_avatar_when_collapsed": true,
96	"disable_banner": true,
97	"language_selector": true,
98	"custom_avatar_path": "custom_avatar_path"
99	},
100	"data_collection": {
101	"key": {
102	"type": "boolean"
103	}
104	},
105	"overrides": {
106	"custom_llm_extra_body": true,
107	"enable_conversation_initiation_client_data_from_webhook": true
108	},
109	"call_limits": {
110	"agent_concurrency_limit": 1,
111	"daily_limit": 1
112	},
113	"ban": {
114	"at_unix": 1,
115	"reason_type": "safety",
116	"reason": "reason"
117	},
118	"privacy": {
119	"record_voice": true,
120	"retention_days": 1,
121	"delete_transcript_and_pii": true,
122	"delete_audio": true,
123	"apply_to_existing_conversations": true
124	},
125	"safety": {
126	"is_blocked_ivc": true,
127	"is_blocked_non_ivc": true
128	}
129	},
130	"phone_numbers": [
131	{
132	"phone_number": "phone_number",
133	"provider": "twilio",
134	"label": "label",
135	"phone_number_id": "phone_number_id",
136	"assigned_agent": {
137	"agent_id": "agent_id",
138	"agent_name": "agent_name"
139	}
140	}
141	]
142	}