Health API
API Endpoints
Health API
Health check endpoint for PraisonAI servers
GET
Health API
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
http://127.0.0.1:8765
Request
No parameters required.
Example Request
Response
Health status:
healthy or unhealthyDiscovery schema version
Server name
Server version
List of provider types available
Number of registered endpoints
Example Response
Errors
| Status | Description |
|---|---|
| 200 | Server is healthy |
| 500 | Server error |
CLI Equivalent
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
- Discovery API - Full discovery document
- Gateway Health - Gateway-specific health endpoint with different response format

