Skip to main content

​
Authentication

All requests use a project API key in the header: 
X-API-Key: YOUR_API_KEY

​
Base URL

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

​
Response shape

Most endpoints return a data object: 
{
  "data": {
    "id": "..."
  }
}
List endpoints can also include meta pagination fields.

​
Rate limits

Platform API requests are rate limited by project plan.
PlanRequests per minute
legacy100
free100
pro500
enterprise1000
platform1000
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.
PlanRequests per second per workflow
legacy5
free5
pro15
enterprise30
platform30
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, database, and other resources.
  • See the workflow execution endpoint for the burst-limited trigger route.