Skip to main content

Base URL

https://your-domain.com/api

Authentication

All protected endpoints require a Bearer token in the Authorization header:
Authorization: Bearer YOUR_API_TOKEN
You can generate an API token from Profile Settings → Generate API Token in the platform. Alternatively, session-based auth (HTTP-only cookies) is used by the web app automatically.

Response format

All responses return JSON. Successful responses vary by endpoint — most return the created/updated object or a list. Errors return:
{
  "error": "Human-readable error message"
}

HTTP status codes

CodeMeaning
200Success
201Created
400Bad request / validation error
401Unauthorized — missing or invalid token
403Forbidden — insufficient permissions
404Resource not found
500Internal server error

Endpoints

Auth

Sign up, login, logout, token refresh, OAuth

Bots

Create and manage AI bots, attach channels and tools

Channels

Connect WhatsApp, Gmail, Twitter and other messaging platforms

Campaigns

Broadcast, drip, and trigger-based messaging campaigns

Contacts

Manage customer contacts and contact lists

Webhooks

Configure bot-triggered HTTP request actions