API reference
Agents API
| Endpoint | Purpose |
|---|---|
POST /api/agents/quickstart | One call: preset persona + voice + number |
POST /api/v1/agents | Create field-by-field |
GET /api/v1/agents | List agents |
GET /api/agents/{id} | Get one |
PATCH /api/agents/{id} | Update (playbook, voice, escalation, …) |
DELETE /api/agents/{id} | Delete |
POST /api/v1/agents/{id}/knowledge-base | Attach knowledge (≤100KB text) |
POST /api/v1/agents/{id}/phone-number | Attach/purchase a number |
POST /api/agents/{id}/test-call | Agent calls you (NANP, 5/day) |
POST /api/agents/quickstart
Body: preset (receptionist · customer_support · sales_associate · custom) — required. Optional: business_name (≤120), instructions (≤4000, replaces the preset playbook), agent_name (≤80), first_message (≤300), voice_id (ElevenLabs id), with_number (bool), area_code (3 digits). 10/hour.
Returns 201 {agent, phone_number, number_error} — the agent always exists; a number failure is reported, not rolled back.
POST /api/v1/agents
Body: name; system_prompt or auto-built from description/objective/knowledge; first_message; voice_id; persona_type, tone, speech_style, goal, category; webhook_url (per-agent call.started notification), escalation_phone, sms_followup_enabled, missed_call_sms_enabled. Returns 201 {agent} with credentials stripped.
PATCH /api/agents/{id}
Accepts any editable field, including system_prompt, first_message, elevenlabs_voice_id, language, escalation settings, and per-agent Twilio credentials for BYO accounts.