Skip to main content
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

​
agent_id
string
required
Unique identifier (UUID). Pass this as override_agent_id on Dial.
​
name
string
Agent display name.
​
language
string
Language code, e.g. he or en.
​
voice
string
Voice display name. One of Keren, Karmit, Kobi, Kfir, Dana, Dafna, Dorin, Dan, Dor, David, Sapir, Steve.
​
agent_type
string
singlePrompt (prompt-based, API-manageable) or conversationalFlow (dashboard-only, read-only here).
​
active
boolean
Whether the agent is enabled.
​
prompt
string
System prompt. Present for prompt-based agents only.
​
welcome_message
string
Message spoken first when the agent answers. Present for prompt-based agents only.
​
variables_provided
array
Variables the agent accepts at call time — supply them via vars_provided on Dial.
​
variables_extracted
array
Variables the agent extracts from the conversation after the call.
​
created_at
string
ISO 8601 timestamp.
​
updated_at
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"
}