Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.climatifai.com/llms.txt

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

The health endpoint gives you a fast, lightweight way to confirm that the API is reachable and accepting requests. It returns immediately with no side effects, making it suitable as a polling target for uptime monitors or a quick sanity check before sending data requests.

Endpoint

GET api.climatifai.com/health

Parameters

This endpoint accepts no query parameters, path parameters, or request body.

Response

A successful response always returns HTTP 200 with the following JSON body:
{ "status": "ok" }
status
string
required
Always "ok" when the service is running.

Example

curl https://api.climatifai.com/health
{
  "status": "ok"
}