Assistants
List and manage inbound and outbound AI voice assistants.
Assistants are the AI agents that handle calls. ErzyCall has two types:
- Inbound — handle incoming calls to your phone numbers
- Outbound — used for outgoing calls initiated via the API or dashboard
List Inbound Assistants
GET /api/v1/assistants/inboundRequired scope: assistants:read
Example Request
curl -X GET "https://app.erzycall.com/api/v1/assistants/inbound" \
-H "X-API-Key: ek_live_abc123"Example Response
{
"data": [
{
"id": "asst_001",
"name": "Customer Support Agent",
"systemPromptId": "prompt_abc",
"createdAt": "2025-01-05T12:00:00Z"
}
]
}Get Inbound Assistant
GET /api/v1/assistants/inbound/{id}Required scope: assistants:read
Example Request
curl -X GET "https://app.erzycall.com/api/v1/assistants/inbound/asst_001" \
-H "X-API-Key: ek_live_abc123"Example Response
{
"data": {
"id": "asst_001",
"name": "Customer Support Agent",
"systemPromptId": "prompt_abc",
"createdAt": "2025-01-05T12:00:00Z"
}
}Update Inbound Assistant
Update the name or system prompt of an inbound assistant.
PATCH /api/v1/assistants/inbound/{id}Required scope: assistants:write
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Assistant name (1–200 chars) |
systemPromptId | string | No | ID of the system prompt to use |
Example Request
curl -X PATCH "https://app.erzycall.com/api/v1/assistants/inbound/asst_001" \
-H "X-API-Key: ek_live_abc123" \
-H "Content-Type: application/json" \
-d '{"name": "Updated Support Agent"}'Example Response
{
"data": {
"id": "asst_001",
"name": "Updated Support Agent",
"systemPromptId": "prompt_abc",
"createdAt": "2025-01-05T12:00:00Z"
}
}List Outbound Assistants
GET /api/v1/assistants/outboundRequired scope: assistants:read
Example Request
curl -X GET "https://app.erzycall.com/api/v1/assistants/outbound" \
-H "X-API-Key: ek_live_abc123"Example Response
{
"data": [
{
"id": "asst_002",
"name": "Sales Outreach Agent",
"createdAt": "2025-01-08T14:00:00Z"
}
]
}Outbound assistants are read-only via the API. Use the dashboard to configure outbound assistant settings.