Agents Platform

Get Agent Widget Config

Retrieve the widget configuration for an agent

get/v1/convai/agents/{agent_id}/widget

Path parameters

agent_idstring required

The id of an agent. This is returned on agent creation.

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz

The id of an agent. This is returned on agent creation.

Query parameters

conversation_signaturestring nullable

An expiring token that enables a websocket conversation to start. These can be generated for an agent using the /v1/convai/conversation/get_signed_url endpoint

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.

Response

Successful Response

agent_idstring required

Example response

{
  "widget_config": {
    "file_input_config": {
      "enabled": false,
      "max_files_in_memory": 10,
      "max_files_per_conversation": 10
    },
    "first_message": "Hello! How can I help you today?",
    "language": "en",
    "language_presets": {},
    "supported_language_overrides": [
      "es",
      "fr"
    ],
    "supports_text_only": true,
    "text_only": false,
    "use_rtc": false
  }
}

Changes

Changed in 3 of the 31 revisions of this API.18

Aug 20, 2026db6eec599cbe2See the full diff
- ○
  the response's property default value changed from false to true for the status
  response-property-default-value-changed
- ○
  the response's property default value changed from false to true for the status
  response-property-default-value-changed
Jul 31, 202672c54eba117e2See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 26, 2026494d96419d1514See the full diff
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history