Skip to main content
GET
/
v1
/
get-agent
/
{agent_id}
curl https://api.voicy.co/v1/get-agent/550e8400-e29b-41d4-a716-446655440001 \
  -H "Authorization: Bearer voicy_sk_live_xxx"

{
  "agent_id": "550e8400-e29b-41d4-a716-446655440001",
  "agent_name": "Customer Support Agent",
  "voice_id": "pNInz6obpgDQGcFmaJgB",
  "language": "en",
  "begin_message": "Hello! How can I help you today?",
  "general_prompt": "You are a helpful customer support agent...",
  "begin_message_mode": "static",
  "response_delay_ms": 100,
  "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
    }
  ]
}
Retrieve complete configuration details for an agent.

​
Path Parameters

​
agent_id
string
required
The unique identifier of the agent (UUID format).

​
Response

​
agent_id
string
Unique identifier for the agent.
​
agent_name
string
Display name for the agent.
​
voice_id
string
Voice ID (Google or ElevenLabs format).
​
language
string
Language code (e.g., he, en).
​
begin_message
string
Initial greeting message spoken when call connects.
​
general_prompt
string
System prompt that defines the agent’s behavior and personality.
​
begin_message_mode
string
How the begin message is handled: static, dynamic, or off.
​
response_delay_ms
integer
Delay in milliseconds before agent responds (for natural pacing).
​
prompt_text_direction
string
Text direction for the prompt: rtl (right-to-left) or ltr (left-to-right).
​
vars_provided
array
Variable definitions for values that can be provided when initiating a call. Each variable has: name, type, default_value, description.
​
vars_extracted
array
Variable definitions for values the agent should extract during the call. Each variable has: name, type, description, required.
curl https://api.voicy.co/v1/get-agent/550e8400-e29b-41d4-a716-446655440001 \
  -H "Authorization: Bearer voicy_sk_live_xxx"

{
  "agent_id": "550e8400-e29b-41d4-a716-446655440001",
  "agent_name": "Customer Support Agent",
  "voice_id": "pNInz6obpgDQGcFmaJgB",
  "language": "en",
  "begin_message": "Hello! How can I help you today?",
  "general_prompt": "You are a helpful customer support agent...",
  "begin_message_mode": "static",
  "response_delay_ms": 100,
  "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
    }
  ]
}