Praison AI

Health API

Health check endpoint for PraisonAI servers

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

bash
# 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
curl http://127.0.0.1:8765/health
Python
import requests

response = requests.get("http://127.0.0.1:8765/health")
health = response.json()
print(f"Status: {health['status']}")
JavaScript
const response = await fetch("http://127.0.0.1:8765/health");
const health = await response.json();
console.log(`Status: ${health.status}`);

Response

ResponseField string

Health status: healthy or unhealthy

ResponseField string

Discovery schema version

ResponseField string

Server name

ResponseField string

Server version

ResponseField array

List of provider types available

ResponseField integer

Number of registered endpoints

ResponseField object

Gateway saturation snapshot — present only when the back-pressure machinery is wired. Classifies load as nominal, elevated, or saturated. See Pressure Telemetry.

Example Response

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

Errors

StatusDescription
200Server is healthy
500Server error

CLI Equivalent

bash
# 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

Related