Partner API
Get Voice AI agent
GET /api/v2/voice-ai/agents/:agent_uuid - Fetch one agent plus tool flags and opening message.
GET
/api/v2/voice-ai/agents/:agent_uuidFetch one agent plus tool flags and opening message.
Required scope: voice-ai (or *).
Path parameters
| Name | Required | Description |
|---|---|---|
agent_uuid | Yes | Voice AI agent UUID |
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
"https://benefitpath.com/api/v2/voice-ai/agents/c0a80101-0000-4000-8000-000000000008"
{
"success": true,
"agent": {
"agent_uuid": "c0a80101-0000-4000-8000-000000000008",
"name": "Default Agent",
"is_default": true,
"voice_id": "jennifer",
"voice_label": "Jennifer",
"first_message": "Hi {{first_name}}, this is Riley calling from Benefit Path...",
"tools": {
"book_appointment": true,
"transfer_human": false,
"leave_voicemail": true,
"end_call": true
},
"created_at": "2026-07-01T15:00:00.000Z",
"updated_at": "2026-07-10T12:00:00.000Z"
}
}
See Errors for the standard error envelope and rate limits.