For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Connect

Blog Help Center API Pricing Sign up

Overview ElevenCreative ElevenAgents ElevenAPI Reception AI API reference Changelog

Overview ElevenCreative ElevenAgents ElevenAPI Reception AI API reference Changelog

Get started
- Overview
- Quickstart
Configure
Deploy
- Overview
- Environment variables
- WhatsApp
- Batch calls
Monitor
Advanced
- Events
- Custom models
- LLM cascading
- Post-call webhooks
Resources
- UI components
Guides
- Chat Mode
- Burst pricing
- ElevenLabs' docs agent
- Scaling user interviews
- Simulate Conversations

Connect

Blog Help Center API Pricing Sign up

API reference Widget

Get widget

GET

/v1/convai/agents/:agent_id/widget

GET

/v1/convai/agents/:agent_id/widget

$ curl https://api.elevenlabs.io/v1/convai/agents/agent_id/widget

1 {
2   "agent_id": "string",
3   "widget_config": {
4     "language": "en",
5     "supported_language_overrides": [
6       "es",
7       "fr"
8     ],
9     "language_presets": {},
10     "text_only": false,
11     "supports_text_only": true,
12     "first_message": "Hello! How can I help you today?",
13     "use_rtc": false,
14     "file_input_config": {
15       "enabled": false,
16       "max_files_per_conversation": 10
17     }
18   }
19 }

Retrieve the widget configuration for an agent

Was this page helpful?

Create widget avatar

Path parameters

agent_idstringRequired

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

Headers

xi-api-keystringOptional

Query parameters

conversation_signaturestring or nullOptional

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

Response

Successful Response

agent_idstring

widget_configobject

Errors

422

Unprocessable Entity Error