---
title: "Update Convai Settings"
method: PATCH
path: "/v1/convai/settings"
tags: ["Agents Platform"]
---

# Update Convai Settings

`PATCH /v1/convai/settings`

Update Convai settings for the workspace

## Headers

- `xi-api-key` string, nullable — Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

## Request body

- PatchConvAISettingsRequest
  - `conversation_initiation_client_data_webhook` ConversationInitiationClientDataWebhook
    - `url` string, required — The URL to send the webhook to
    - `request_headers` object, required — The headers to send with the webhook request
  - `webhooks` ConvAIWebhooks
    - `post_call_webhook_id` string, nullable
    - `events` WebhookEventType[] — List of event types to send via webhook. Options: transcript, audio, call_initiation_failure, unredacted_transcript, unredacted_audio.
    - `transcript_format` 'json' | 'opentelemetry'
    - `send_audio` boolean, nullable — DEPRECATED: Use 'events' field instead. Whether to send audio data with post-call webhooks for ConvAI conversations
  - `can_use_mcp_servers` boolean — Whether the workspace can use MCP servers
  - `rag_retention_period_days` integer
  - `conversation_embedding_retention_days` integer, nullable — Days to retain conversation embeddings. None means use the system default (30 days).
  - `default_livekit_stack` 'standard' | 'static'

## Response `200`

Successful Response

- GetConvAISettingsResponseModel
  - `conversation_initiation_client_data_webhook` ConversationInitiationClientDataWebhook
    - `url` string, required — The URL to send the webhook to
    - `request_headers` object, required — The headers to send with the webhook request
  - `webhooks` ConvAIWebhooks
    - `post_call_webhook_id` string, nullable
    - `events` WebhookEventType[] — List of event types to send via webhook. Options: transcript, audio, call_initiation_failure, unredacted_transcript, unredacted_audio.
    - `transcript_format` 'json' | 'opentelemetry'
    - `send_audio` boolean, nullable — DEPRECATED: Use 'events' field instead. Whether to send audio data with post-call webhooks for ConvAI conversations
  - `can_use_mcp_servers` boolean — Whether the workspace can use MCP servers
  - `rag_retention_period_days` integer
  - `conversation_embedding_retention_days` integer, nullable — Days to retain conversation embeddings. None means use the system default (30 days).
  - `default_livekit_stack` 'standard' | 'static'

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation.md) · [All operations](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elevenlabs/elevenlabs-api-documentation/revisions/d1a4847203ce/schema)