curl https://api.vozagent.ai/v1/assistants \
-H "Authorization: Bearer <token>"
[
{
"id": "a1b2c3d4-e5f6-a7b8-c9d0-e1f2a3b4c5d6",
"name": "Inbound Receptionist",
"role": "receptionist",
"assistant_type": "inbound",
"is_active": true,
"voice_id": "sarah",
"first_message": "Hello! Thanks for calling...",
"phone_number_id": "pn1234",
"created_at": "2024-01-15T09:30:00Z",
"updated_at": "2024-01-15T09:30:00Z"
},
{
"id": "b2c3d4e5-f6a7-b8c9-d0e1-f2a3b4c5d6e7",
"name": "Follow-up Agent",
"role": "sales",
"assistant_type": "outbound",
"is_active": true,
"voice_id": "marcus",
"created_at": "2024-01-14T14:20:00Z",
"updated_at": "2024-01-14T14:20:00Z"
}
]
Assistants
List Assistants
Retrieve a list of all assistants.
GET
/
v1
/
assistants
curl https://api.vozagent.ai/v1/assistants \
-H "Authorization: Bearer <token>"
[
{
"id": "a1b2c3d4-e5f6-a7b8-c9d0-e1f2a3b4c5d6",
"name": "Inbound Receptionist",
"role": "receptionist",
"assistant_type": "inbound",
"is_active": true,
"voice_id": "sarah",
"first_message": "Hello! Thanks for calling...",
"phone_number_id": "pn1234",
"created_at": "2024-01-15T09:30:00Z",
"updated_at": "2024-01-15T09:30:00Z"
},
{
"id": "b2c3d4e5-f6a7-b8c9-d0e1-f2a3b4c5d6e7",
"name": "Follow-up Agent",
"role": "sales",
"assistant_type": "outbound",
"is_active": true,
"voice_id": "marcus",
"created_at": "2024-01-14T14:20:00Z",
"updated_at": "2024-01-14T14:20:00Z"
}
]
Retrieve your API Key from your VozAgent Dashboard.
Query parameters
number
default:"50"
Maximum number of assistants to return. Range: 0-100.
number
Pagination offset.
boolean
Filter by active status.
string
Filter by type:
inbound, outbound, or custom.Response
Returns an array of assistant objects with their configuration details.string
Unique identifier for the assistant.
string
Display name of the assistant.
string
The role/persona of the assistant.
string
Type:
inbound, outbound, or custom.boolean
Whether the assistant is currently active.
string
Voice model being used.
string
Initial greeting message.
string
Linked phone number ID (if any).
curl https://api.vozagent.ai/v1/assistants \
-H "Authorization: Bearer <token>"
[
{
"id": "a1b2c3d4-e5f6-a7b8-c9d0-e1f2a3b4c5d6",
"name": "Inbound Receptionist",
"role": "receptionist",
"assistant_type": "inbound",
"is_active": true,
"voice_id": "sarah",
"first_message": "Hello! Thanks for calling...",
"phone_number_id": "pn1234",
"created_at": "2024-01-15T09:30:00Z",
"updated_at": "2024-01-15T09:30:00Z"
},
{
"id": "b2c3d4e5-f6a7-b8c9-d0e1-f2a3b4c5d6e7",
"name": "Follow-up Agent",
"role": "sales",
"assistant_type": "outbound",
"is_active": true,
"voice_id": "marcus",
"created_at": "2024-01-14T14:20:00Z",
"updated_at": "2024-01-14T14:20:00Z"
}
]
Was this page helpful?