Skip to main content
GET
/
v1
/
list-agents
curl https://api.voicy.co/v1/list-agents \
  -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": [],
    "vars_extracted": []
  },
  {
    "agent_id": "550e8400-e29b-41d4-a716-446655440002",
    "agent_name": "Sales Agent",
    "voice_id": "21m00Tcm4TlvDq8ikWAM",
    "language": "he",
    "begin_message": "שלום! איך אוכל לעזור לך היום?",
    "general_prompt": "אתה נציג מכירות מועיל...",
    "begin_message_mode": "static",
    "response_delay_ms": 150,
    "prompt_text_direction": "rtl",
    "vars_provided": [
      {"name": "customer_name", "type": "string", "default_value": null, "description": "Customer name"}
    ],
    "vars_extracted": [
      {"name": "preferred_date", "type": "string", "description": "Preferred meeting date", "required": true}
    ]
  }
]
Retrieve a list of all agents associated with your account.

​
Response

Returns an array of agent objects. Each agent contains the same fields as the Get Agent response. 
curl https://api.voicy.co/v1/list-agents \
  -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": [],
    "vars_extracted": []
  },
  {
    "agent_id": "550e8400-e29b-41d4-a716-446655440002",
    "agent_name": "Sales Agent",
    "voice_id": "21m00Tcm4TlvDq8ikWAM",
    "language": "he",
    "begin_message": "שלום! איך אוכל לעזור לך היום?",
    "general_prompt": "אתה נציג מכירות מועיל...",
    "begin_message_mode": "static",
    "response_delay_ms": 150,
    "prompt_text_direction": "rtl",
    "vars_provided": [
      {"name": "customer_name", "type": "string", "default_value": null, "description": "Customer name"}
    ],
    "vars_extracted": [
      {"name": "preferred_date", "type": "string", "description": "Preferred meeting date", "required": true}
    ]
  }
]