Skip to main content
GET
/
health
Health API
curl --request GET \
  --url http://127.0.0.1:8765/health \
  --header 'X-API-Key: <api-key>'
{
  "status": "<string>",
  "schema_version": "<string>",
  "server_name": "<string>",
  "server_version": "<string>",
  "providers": [
    {}
  ],
  "endpoint_count": 123
}

Documentation Index

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

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

​
Health API

The health endpoint provides server health status and basic information about available providers.

​
Overview

Every PraisonAI server exposes /health which returns the current health status along with provider information.

​
When to Use

  • Health checks: Kubernetes/Docker health probes
  • Load balancer: Backend health verification
  • Monitoring: Uptime and availability monitoring

​
Base URL + Playground

# Start server
praisonai serve unified --host 127.0.0.1 --port 8765
Base URL: http://127.0.0.1:8765

​
Request

​
none
none
No parameters required.

​
Example Request

curl http://127.0.0.1:8765/health

​
Response

​
status
string
required
Health status: healthy or unhealthy
​
schema_version
string
Discovery schema version
​
server_name
string
Server name
​
server_version
string
Server version
​
providers
array
List of provider types available
​
endpoint_count
integer
Number of registered endpoints

​
Example Response

{
  "status": "healthy",
  "schema_version": "1.0.0",
  "server_name": "praisonai-unified",
  "server_version": "1.0.0",
  "providers": ["agents-api", "recipe", "mcp", "a2a", "a2u"],
  "endpoint_count": 5
}

​
Errors

StatusDescription
200Server is healthy
500Server error

​
CLI Equivalent

# Health check via endpoints CLI
praisonai endpoints health --url http://127.0.0.1:8765

​
Configuration

Health endpoint is automatically added to all servers. No configuration required.

​
Notes

  • Returns 200 for healthy, 500 for unhealthy
  • Use for Kubernetes liveness/readiness probes
  • No authentication required