Endpoints
REST endpoints grouped by resource. Every endpoint requires authentication and counts against the relevant rate limit.
| Resource | Common operations |
|---|---|
| Agents | Create / update voice personas (name, voice ID, language) |
| Campaigns | Outbound calling campaigns. Owns calls, contacts, stats, settings. |
| Calls | Inspect calls, fetch transcripts, place outbound |
| Phone Numbers | Search, purchase, port-in, manage routing |
| Businesses | Business profile, hours, services, prompts, settings |
| Webhooks | Subscribe to call events |
Architectural note
Akol’s data model: Agents are minimal — voice ID + name only. Everything else (calls, contacts, stats, phone numbers, analytics, settings) lives on Campaigns. When designing integrations:
- Read agent configuration from the Business profile, not the Agent.
- Group call data by Campaign, not Agent.
- An Agent (voice persona) can be reused across multiple Campaigns.
This means most “what’s happening with my AI agent” queries are actually “what’s happening with my campaign” queries.
Last updated on