Skip to main content
The Akapulu API is the programmatic interface for building with Akapulu. Today, the public reference starts with Conversations endpoints. Over time, this API will also include additional resources such as Avatars, Scenarios, and more.

​
Authentication

All Akapulu API endpoints require a Bearer API key in the Authorization header. 
Authorization: Bearer <YOUR_AKAPULU_API_KEY>

​
API Keys

To get started, create an account, sign in to Akapulu, then create an API key and send it in the Authorization header for every request.

​
Base URL

https://akapulu.com/api

​
Example Request

curl -X POST "https://akapulu.com/api/conversations/connect/" \
  -H "Authorization: Bearer <YOUR_AKAPULU_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "scenario_id": "<YOUR_SCENARIO_ID>",
    "runtime_vars": {
      "user_name": "Alex",
      "company_name": "Acme Corp",
      "support_ticket_id": "TICK-1024"
    },
    "voice_only_mode": false
  }'

​
Getting Started

Start with the Conversations section to create a conversation session and connect your client.