API introduction

Getting started with the CauseFlow API — base URL, versioning, and rate limits.

Base URL

All CauseFlow API requests are made to the following base URL:

https://api.causeflow.ai

Versioning

Every endpoint is prefixed with /v1/. The current version is v1.

https://api.causeflow.ai/v1/incidents

CauseFlow uses path-based versioning. When a new major version is released, existing /v1/ endpoints remain available during the deprecation window.

Content type

All requests and responses use JSON. Include the Content-Type header on requests that send a body:

Content-Type: application/json

Rate limits

Rate limits are enforced per tenant and vary by plan:

Plan	Requests per minute
Starter	100
Pro	500
Business	2,000
Enterprise	2,000

Rate limit headers

Every API response includes the following headers:

Header	Description
X-RateLimit-Limit	The maximum number of requests allowed in the current window
X-RateLimit-Remaining	The number of requests remaining in the current window
X-RateLimit-Reset	Unix timestamp (seconds) when the rate limit window resets

When you exceed your rate limit, the API returns a 429 Too Many Requests response. Retry after the timestamp in X-RateLimit-Reset.

HTTP/1.1 429 Too Many Requests
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1711929600

{
  "error": "rate_limit_exceeded",
  "message": "Rate limit exceeded. Retry after 1711929600."
}

Authentication

CauseFlow uses JWT Bearer tokens for authenticated API endpoints and API keys with HMAC signatures for webhook endpoints. See the Authentication page for full details.

Next steps

Authentication

Learn how to authenticate your API requests

Errors and pagination

Understand error responses and how to page through results