Get settings

import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";
async function main() {
    const client = new ElevenLabsClient();
    await client.conversationalAi.settings.get();
}
main();

{
  "conversation_initiation_client_data_webhook": {
    "url": "https://hooks.myworkspace.com/convai/initiate",
    "request_headers": {
      "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
      "Content-Type": "application/json"
    }
  },
  "webhooks": {
    "post_call_webhook_id": "webhook_123abc456def",
    "events": [
      "transcript",
      "call_initiation_failure"
    ],
    "send_audio": false
  },
  "can_use_mcp_servers": true,
  "rag_retention_period_days": 14,
  "conversation_embedding_retention_days": 30,
  "default_livekit_stack": "standard"
}

Retrieve Convai settings for the workspace

Response

Successful Response

conversation_initiation_client_data_webhookobject or null

webhooksobject or null

can_use_mcp_serversboolean or nullDefaults to false

Whether the workspace can use MCP servers

rag_retention_period_daysinteger or null<=30Defaults to 10

conversation_embedding_retention_daysinteger or null<=365

Days to retain conversation embeddings. None means use the system default (30 days).

default_livekit_stackenum or nullDefaults to standard

Allowed values:

Headers

Response

Errors