Skip to main content

​
Overview

A VoiceAgent represents the external voice AI provider configuration attached to an Agent. It stores which provider is powering the agent and how to authenticate with it. VoiceAgent objects are embedded directly inside Agent objects — they are never returned standalone.

​
Fields

​
provider
string
The voice AI provider name (e.g. ElevenLabs).
​
agent_id
string
The external agent identifier on the voice AI provider’s platform. This is the ID of the agent as it exists in the provider’s dashboard (e.g. an ElevenLabs agent ID).
​
auth_method
string
How the provider authenticates clients connecting to this agent:
  • public — No authentication required; anyone with the link can connect
  • api_key — Clients authenticate using an API key
  • token — Clients authenticate using a signed token

​
Auth Method Values

ValueDescription
publicOpen access — no client-side authentication required
api_keyAPI key-based authentication
tokenSigned URL / token-based authentication

​
Example

{
  "provider": "ElevenLabs",
  "agent_id": "el_agent_xxxxxxxxxxxxxxxx",
  "auth_method": "public"
}