Skip to main content

​
Overview

An Agent represents a configured AI voice agent owned by a user. It combines your display settings (name, avatar) with a VoiceAgent that points to the underlying voice AI provider. Agents are referenced by Link objects, which expose them to the public via shareable URLs.

​
Fields

​
agent_id
string
Unique agent identifier (starts with agnt_).
​
name
string
Display name for the agent.
​
avatar_image_url
string | null
URL of the avatar image shown to end-users. null if no avatar is set.
​
created_at
string
ISO 8601 timestamp of when the agent was created.
​
voice_agent
object
The voice AI provider configuration for this agent. See VoiceAgent.

​
Example

{
  "agent_id": "agnt_01J8ZK4R2N5M6P7Q8W4T",
  "name": "Support Agent",
  "avatar_image_url": "https://cdn.example.com/avatars/support.jpg",
  "created_at": "2024-01-15T10:00:00Z",
  "voice_agent": {
    "provider": "ElevenLabs",
    "agent_id": "el_agent_xxxxxxxxxxxxxxxx",
    "auth_method": "public"
  }
}