Skip to main content
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

Base URL: http://127.0.0.1:8765

Request

none
No parameters required.

Example Request

Response

string
required
Health status: healthy or unhealthy
string
Discovery schema version
string
Server name
string
Server version
array
List of provider types available
integer
Number of registered endpoints

Example Response

Errors

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