provider Agents Platform GET /v1/convai/agents/{agent_id}/widget
@utdk/elevenlabs /v1/convai/agents/{agent_id}/widget
Get Agent Widget Config
Retrieve the widget configuration for an agent
agent_id path required
The id of an agent. This is returned on agent creation.
string
conversation_signature query
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
xi-api-key header
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.

Try it

Authentication
Configure credentials for ElevenLabs API Documentation
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getAgentWidgetRoute
GET/v1/convai/agents/{agent_id}/widget
Retrieve the widget configuration for an agent

Parameters

required

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

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

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import elevenlabs from '@utdk/elevenlabs';

await elevenlabs.getAgentWidgetRoute()