Skip to main content

​
GET /health

Returns the health status of the API, including version information and Redis connection status.

​
Authentication

No authentication required.

​
Response

​
status
string
required
Service status. Values: "healthy" or "degraded"
​
version
string
required
API version number
​
redis_connected
boolean
required
Whether Redis is connected and responsive
​
timestamp
string
required
ISO 8601 timestamp of the health check

​
Response Example

{
  "status": "healthy",
  "version": "1.0.0",
  "redis_connected": true,
  "timestamp": "2026-03-08T10:30:00.000000"
}

​
Status Codes

CodeDescription
200Health check successful

​
cURL Example

curl -X GET "https://api.example.com/health"

​
GET /

API root endpoint that returns basic API information and navigation links.

​
Authentication

No authentication required.

​
Response Example

{
  "name": "Agentic-PAL API",
  "version": "1.0.0",
  "docs": "/docs",
  "health": "/health"
}

​
Status Codes

CodeDescription
200Successful response

​
cURL Example

curl -X GET "https://api.example.com/"

Build docs developers (and LLMs) love

Get started for freeTalk to us