Skip to main content
The full Agent object contains the complete configuration for a voice agent, including prompts, voice settings, and variable definitions. Returned by Get Agent.
List Agents returns a lightweight version of this object that omits vars_provided, vars_extracted, and pronunciations for performance. Use Get Agent to retrieve the full object.

​
Properties

​
agent_id
string
required
Unique identifier for the agent (UUID).
​
agent_name
string
required
Display name for the agent.
​
account
object
Account that owns the agent. null for global agents.
​
voice_id
string
required
Voice identifier. Format depends on provider:
  • OpenAI: openai:cedar, openai:sage
  • Google: he-IL-Chirp3-HD-Kore
  • Gemini Live: gl:Puck, gl:Kore
​
language
string
required
Language code (e.g., he, en, es).
​
begin_message
string
Initial greeting message spoken when call connects. null if not set.
​
agent_prompt
string
required
System prompt that defines the agent’s behavior and personality.
​
begin_message_mode
string
required
How the agent starts the conversation:
ModeDescription
staticSpeak the begin_message as-is
dynamicAI generates a greeting based on context
offWait for the caller to speak first
​
prompt_text_direction
string
required
Text direction for the prompt:
  • rtl - Right-to-left (Hebrew, Arabic)
  • ltr - Left-to-right (English, Spanish)
​
vars_provided
array
Variable definitions for values that can be provided when initiating a call.
​
vars_extracted
array
Variable definitions for values the agent should extract during the call.
​
version
integer
required
Version number of the agent. Increments on each deployment.
​
deployed_at
string
ISO 8601 timestamp when this version was deployed.null indicates a working version that hasn’t been deployed yet:
  • Working versions are editable
  • Deployed versions are frozen
  • Phone calls use the latest deployed version
​
agent_type
string
required
Type of agent:
  • singlePrompt - Standard agent with a single system prompt
  • conversationalFlow - Flow-based agent with multiple nodes
​
notification_emails
array
Email addresses to notify when calls complete.

​
Example

{
  "agent_id": "550e8400-e29b-41d4-a716-446655440001",
  "agent_name": "Customer Support Agent",
  "account": {
    "id": "550e8400-e29b-41d4-a716-446655440099",
    "name": "Acme Corp"
  },
  "voice_id": "openai:sage",
  "language": "en",
  "begin_message": "Hello! How can I help you today?",
  "agent_prompt": "You are a helpful customer support agent for Acme Corp...",
  "begin_message_mode": "static",
  "prompt_text_direction": "ltr",
  "vars_provided": [
    {
      "name": "customer_name",
      "type": "string",
      "default_value": null,
      "description": "Customer's full name"
    }
  ],
  "vars_extracted": [
    {
      "name": "appointment_date",
      "type": "string",
      "description": "Preferred appointment date",
      "required": true
    }
  ],
  "version": 3,
  "deployed_at": "2026-01-15T10:30:00Z",
  "agent_type": "singlePrompt",
  "notification_emails": ["support@acme.com"]
}