Skip to main content
GET
/
health
Health check
curl --request GET \
  --url https://api.example.com/health

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.

​
Overview

A lightweight health check endpoint that returns ok if the CauseFlow API is running and accepting requests. Use this for uptime monitoring, load balancer health probes, and CI/CD pipeline readiness checks.
This is a public endpoint. No authentication required.

​
Response

Returns 200 OK with a simple status payload. 
{
  "status": "ok",
  "timestamp": "2026-04-01T12:00:00Z"
}
FieldTypeDescription
statusstringAlways "ok" when the API is running
timestampstringISO 8601 timestamp of when the response was generated

​
Examples

curl https://api.causeflow.ai/health