Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.causeflow.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
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:
PlanRequests per minute
Starter100
Pro500
Business2,000
Enterprise2,000

​
Rate limit headers

Every API response includes the following headers:
HeaderDescription
X-RateLimit-LimitThe maximum number of requests allowed in the current window
X-RateLimit-RemainingThe number of requests remaining in the current window
X-RateLimit-ResetUnix 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.

​
Event subscriptions

CauseFlow publishes 21 real-time events across seven domains — from incident creation to remediation execution. Events are delivered today via Server-Sent Events on GET /v1/notifications/stream. Programmatic webhook subscription is on the roadmap. See the outbound event catalog for the full event list and payload samples.

​
Next steps

Authentication

Learn how to authenticate your API requests

Errors and pagination

Understand error responses and how to page through results

Outbound events

All 20 EventBus events with payload samples and delivery details

Notifications stream

Subscribe to real-time events via SSE