Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
Agents Platform

Update Convai Settings

Update Convai settings for the workspace

patch/v1/convai/settings

Headers

xi-api-keystring 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.

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

can_use_mcp_serversboolean

Whether the workspace can use MCP servers

rag_retention_period_daysinteger
conversation_embedding_retention_daysinteger nullable

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

default_livekit_stack'standard' | 'static'

Example request

{
  "conversation_initiation_client_data_webhook": {
    "request_headers": {
      "Content-Type": "application/json"
    },
    "url": "https://example.com/webhook"
  }
}

Response

Successful Response

can_use_mcp_serversboolean

Whether the workspace can use MCP servers

rag_retention_period_daysinteger
conversation_embedding_retention_daysinteger nullable

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

default_livekit_stack'standard' | 'static'

Example response

{
  "conversation_initiation_client_data_webhook": {
    "request_headers": {
      "Content-Type": "application/json"
    },
    "url": "https://example.com/webhook"
  }
}