PATCH
/v1/convai/settings
ElevenLabs APIUpdate Convai Settings
- Base URL
- https://api.elevenlabs.io
- Auth
- xi-api-key: <ELEVENLABS_API_KEY>
- Last verified
- 2026-09-03 · upstream hash matched
Actions
Agents: curl -H "Accept: text/markdown" this URL
→ 225 tokens · Vary: Accept
→ 225 tokens · Vary: Accept
Critical gotchas
Authentication uses the non-standard xi-api-key header, not Authorization: Bearer. Sending a Bearer token returns HTTP 401.
Text-to-speech responses are raw binary audio, not JSON. Write the body to a file (--output speech.mp3) rather than parsing it.
cURL
curl -X PATCH 'https://api.elevenlabs.io/v1/convai/settings' \ -H "xi-api-key: $ELEVENLABS_API_KEY" \ -H 'Content-Type: application/json' \ -d '{ "conversation_initiation_client_data_webhook": { "request_headers": { "Content-Type": "application/json" }, "url": "https://example.com/webhook" }, "webhooks": { "post_call_webhook_id": "string", "events": [ "transcript" ], "transcript_format": "json", "send_audio": true }, "can_use_mcp_servers": false, "rag_retention_period_days": 10, "conversation_embedding_retention_days": 0, "default_livekit_stack": "standard"}'Get a free ElevenLabs API key → sponsored
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| conversation_initiation_client_data_webhook | body | object | No | Request body field conversation_initiation_client_data_webhook. |
| webhooks | body | object | No | Request body field webhooks. |
| can_use_mcp_servers | body | boolean | No | Whether the workspace can use MCP servers |
| rag_retention_period_days | body | integer | No | Request body field rag_retention_period_days. |
| conversation_embedding_retention_days | body | integer | No | Days to retain conversation embeddings. None means use the system default (30 days). |
| default_livekit_stack | body | string | No | Request body field default_livekit_stack. |
Response 200 OK
{
"conversation_initiation_client_data_webhook": {
"request_headers": {
"Content-Type": "application/json"
},
"url": "https://example.com/webhook"
},
"webhooks": {
"post_call_webhook_id": "string",
"events": [
"transcript"
],
"transcript_format": "json",
"send_audio": true
},
"can_use_mcp_servers": false,
"rag_retention_period_days": 10,
"conversation_embedding_retention_days": 0,
"default_livekit_stack": "standard"
}