Authentication

All API requests require a Bearer token (API key).

API Key Authentication

Include your API key in the Authorization header:

Authorization: Bearer sk_your_api_key_here
http

Key Details

  • API keys start with sk_ and are 68 characters long.
  • Each key is scoped to your organization with granular module permissions.
  • Rate limiting: 100 requests/minute per key.
  • Keys support rotation, expiration dates, and environment labels (production, staging, development).

Permissions

Each API key has granular permissions per module.

ModulePermissions
emailsendinbox_readinbox_replyhistory
whatsappsendreceivetemplateshistory
smssendreceivehistory
trackingreadexport
suppressionsreadwrite
webhooksreadwrite
verifyuse
aiconversationsdraftsgenerateagents_readkb_read
contactsreadwrite

Error Responses

All errors follow a consistent format:

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}
json

Common error codes:

HTTPCodeDescription
401UNAUTHORIZEDMissing or invalid API key
403FORBIDDENAPI key lacks required permission
429RATE_LIMITEDToo many requests (100/min limit)
400VALIDATION_ERRORInvalid request body or parameters