API reference

Kapso exposes three APIs. They are documented separately because they have different base URLs and different jobs, but a single project API key authenticates all of them.

WhatsApp
Platform
Workflows

Send and read messages, templates, and media. Mirrors Meta’s Graph API shapes, so existing Cloud API code ports over with a base URL change.

https://api.kapso.ai/meta/whatsapp/v24.0

Browse endpoints

Everything around the messages: onboarding customers, provisioning numbers, generating setup links, running broadcasts, and managing webhooks.

https://api.kapso.ai/platform/v1

Browse endpoints

Trigger and inspect automation runs, read execution history, and deploy serverless functions.

https://api.kapso.ai/platform/v1

Shares a base URL with the Platform API and is the same service. They are split here only to keep the reference navigable.Browse endpoints

Authentication

Send your project API key in the X-API-Key header:

curl https://api.kapso.ai/platform/v1/customers \
  -H "X-API-Key: YOUR_API_KEY"

The WhatsApp API also accepts a bearer token, which is what lets Meta Cloud API code work unchanged:

curl https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/messages \
  -H "Authorization: Bearer YOUR_TOKEN"

Response shape

Most endpoints return a data object:

{
  "data": {
    "id": "..."
  }
}

List endpoints also include a meta object with pagination state.

Before you start

All requests are HTTPS. Plain HTTP is rejected
Requests and responses are JSON unless the endpoint handles media
Rate limits apply per API key and depend on your plan

Overview

WhatsApp API

Platform API

Workflows API

Authentication

Response shape

Before you start

​Authentication

​Response shape

​Before you start

Authentication

Response shape

Before you start