Skip to content

Health

Endpoint for checking the operational status of the IPTO API.


Health Check

Check whether the API is healthy and responding to requests.

GET /health

Authentication: None required

Scope: Public

Request

curl -X GET https://api.ipto.ai/health
import requests

response = requests.get("https://api.ipto.ai/health")
data = response.json()
const response = await fetch("https://api.ipto.ai/health");
const data = await response.json();

Parameters

No parameters required.

Response

{
  "status": "healthy",
  "version": "0.1.0"
}

Response Fields

Field Type Description
status string Current health status. Returns "healthy" when the API is operating normally.
version string Current API version string.

No response envelope

The health check endpoint returns a plain JSON object without the standard data / request_id / timestamp envelope used by other endpoints. This keeps the health check lightweight and compatible with standard monitoring tools.

Monitoring integration

Use this endpoint for uptime monitoring and load balancer health checks. A 200 OK response with "status": "healthy" indicates the API is ready to accept traffic. Any other status code should be treated as unhealthy.