Sign in
Agents Platform

Get Convai Settings

Retrieve Convai settings for the workspace

get/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.

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"
  }
}

Changes

Changed in 1 of the 49 revisions of this API.1

  • 7ac648a154bb1See the full diff
    • ●

      added the new answering_machine_detection enum value to the // response property for the response status

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog