> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kapso.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API overview

> Base URL, authentication, response shape, and rate limits for the Kapso Platform API

## Authentication

All requests use a project API key in the header:

```bash theme={null}
X-API-Key: YOUR_API_KEY
```

## Base URL

```bash theme={null}
https://api.kapso.ai/platform/v1
```

## Response shape

Most endpoints return a `data` object:

```json theme={null}
{
  "data": {
    "id": "..."
  }
}
```

List endpoints can also include `meta` pagination fields.

## Rate limits

Platform API requests are rate limited by project plan.

| Plan         | Requests per minute |
| ------------ | ------------------: |
| `legacy`     |                 100 |
| `free`       |                 100 |
| `pro`        |                 500 |
| `enterprise` |                1000 |
| `platform`   |                1000 |

The limiter is tracked per API key.

## Workflow execution burst limit

`POST /workflows/{workflow_id}/executions` has an extra per-workflow burst limiter on top of the general per-minute limit.

| Plan         | Requests per second per workflow |
| ------------ | -------------------------------: |
| `legacy`     |                                5 |
| `free`       |                                5 |
| `pro`        |                               15 |
| `enterprise` |                               30 |
| `platform`   |                               30 |

Successful responses include:

* `X-Burst-RateLimit-Limit`
* `X-Burst-RateLimit-Remaining`

If the burst limit is exceeded, the API returns `429 Too Many Requests` with `Retry-After: 1`.

## Rate limit headers

Successful responses can include:

* `X-RateLimit-Limit`
* `X-RateLimit-Remaining`

When you hit the general Platform API limit, the API returns `429 Too Many Requests` with:

* `X-RateLimit-Limit`
* `X-RateLimit-Remaining: 0`
* `Retry-After: 60`

## Next steps

* Use the Platform API reference sidebar to jump to customers, setup links, phone numbers, webhooks, WhatsApp data, broadcasts, logs, and team resources.
* See the workflow execution endpoint for the burst-limited trigger route.