API Reference

The Akol REST API lets you create agents, manage campaigns, place calls, fetch transcripts, and receive webhook events. Every dashboard action is also available via the API — the dashboard itself is a client.

Base URL

https://api.akol.ai

All endpoints are versioned. Both of these resolve to the same handler:

We won’t break v1 endpoints. New incompatible behavior will live under v2.

Quick start

# 1. Get a token (see Authentication)
TOKEN="ey..."
 
# 2. List your agents
curl https://api.akol.ai/api/v1/agents \
  -H "Authorization: Bearer $TOKEN"

Response envelope

Every JSON response is wrapped in a consistent envelope:

Success:

{
  "success": true,
  "data": { ... },
  "pagination": { ... }   // when applicable
}

Error:

{
  "success": false,
  "error": "Human-readable message",
  "errors": [{ "field": "email", "message": "Invalid format" }]  // when validation fails
}

The errors array is populated for 422 Unprocessable Entity responses; otherwise just error.

Pagination

List endpoints accept ?page=N&limit=M (max limit is 100) and return:

{
  "success": true,
  "data": [ ... ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 137,
    "totalPages": 7,
    "hasNext": true,
    "hasPrev": false
  }
}

What’s next

• Authentication — how to obtain and use API tokens
• Rate Limits — per-endpoint limits and what to do when throttled
• Errors — error format and common HTTP status codes
• Webhooks — receive call events and other notifications
• Endpoints — REST endpoint reference grouped by resource