Skip to main content
GET
Get Convai Settings

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Response

Successful Response

conversation_initiation_client_data_webhook
ConversationInitiationClientDataWebhook · object | null
Example:
webhooks
ConvAIWebhooks · object
can_use_mcp_servers
boolean
default:false

Whether the workspace can use MCP servers

rag_retention_period_days
integer
default:10
Required range: x <= 30
conversation_embedding_retention_days
integer | null

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

Required range: 0 < x <= 365
default_livekit_stack
enum<string>
default:standard
Available options:
standard,
static