Agent

An Agent defines how a voice agent behaves. The API exposes an agent’s interface — its identity, voice, and variable contract — but not its internal configuration.

There are two agent types. Prompt-based agents (singlePrompt) are fully manageable via the API. Flow agents (conversationalFlow) are built in the dashboard; they appear in List and Get but cannot be created or modified through the API, and their internal flow configuration is never returned.

Properties

string

required

Unique identifier (UUID). Pass this as override_agent_id on Dial.

string

Agent display name.

string

Language code, e.g. he or en.

string

Voice display name. One of Sapir, Steve, Ori, Yael, Guy, Gefen, Gal, Gabriel for a NEW assignment. An agent created before a voice was retired keeps reporting that voice here — the read path is not narrowed.

string

singlePrompt (prompt-based, API-manageable) or conversationalFlow (dashboard-only, read-only here).

boolean

Whether the agent is enabled.

string

System prompt. Present for prompt-based agents only.

string

Message spoken first when the agent answers. Present for prompt-based agents only.

array

Variables the agent accepts at call time — supply them via vars_provided on Dial.

Show Variable properties

string

Variable name.

string

Human-readable description.

array

Variables the agent extracts from the conversation after the call.

Show Variable properties

string

Variable name.

string

Human-readable description.

string

ISO 8601 timestamp.

string

ISO 8601 timestamp.

Example

{
  "agent_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Appointment Booker",
  "language": "he",
  "voice": "Keren",
  "agent_type": "singlePrompt",
  "active": true,
  "prompt": "You are a friendly receptionist that books appointments.",
  "welcome_message": "שלום, איך אפשר לעזור?",
  "variables_provided": [
    { "name": "customer_name", "description": "The caller's name" }
  ],
  "variables_extracted": [
    { "name": "appointment_date", "description": "The date the caller chose" }
  ],
  "created_at": "2026-06-06T10:00:00Z",
  "updated_at": "2026-06-06T10:00:00Z"
}

Overview

Models

Calls

Agents

Properties

Example

​Properties

​Example

Properties

Example