provider Agents Platform GET
/v1/convai/conversation/get_signed_url @utdk/elevenlabs
/v1/convai/conversation/get_signed_url Get Signed Url
Get a signed url to start a conversation with an agent with an agent that requires authorization
- agent_id query required
- Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.
- string
- include_conversation_id query
- Whether to include a conversation_id with the response. If included, the conversation_signature cannot be used again.
- boolean
- branch_id query
- The ID of the branch to use
- environment query
- The environment to use for resolving environment variables (e.g. 'production', 'staging'). Defaults to 'production'.
- 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.
Code snippet
Updates live as you fill in the form above.
TypeScript
import elevenlabs from '@utdk/elevenlabs';
await elevenlabs.getSignedUrlDeprecated({
"include_conversation_id": false
})