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

> 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 theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
# Start server
praisonai serve unified --host 127.0.0.1 --port 8765
```

**Base URL:** `http://127.0.0.1:8765`

## Request

<ParamField path="none" type="none">
  No parameters required.
</ParamField>

### Example Request

<CodeGroup>
  ```bash curl theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
  curl http://127.0.0.1:8765/health
  ```

  ```python Python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
  import requests

  response = requests.get("http://127.0.0.1:8765/health")
  health = response.json()
  print(f"Status: {health['status']}")
  ```

  ```javascript JavaScript theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
  const response = await fetch("http://127.0.0.1:8765/health");
  const health = await response.json();
  console.log(`Status: ${health.status}`);
  ```
</CodeGroup>

## Response

<ResponseField name="status" type="string" required>
  Health status: `healthy` or `unhealthy`
</ResponseField>

<ResponseField name="schema_version" type="string">
  Discovery schema version
</ResponseField>

<ResponseField name="server_name" type="string">
  Server name
</ResponseField>

<ResponseField name="server_version" type="string">
  Server version
</ResponseField>

<ResponseField name="providers" type="array">
  List of provider types available
</ResponseField>

<ResponseField name="endpoint_count" type="integer">
  Number of registered endpoints
</ResponseField>

### Example Response

```json theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
{
  "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

| Status | Description       |
| ------ | ----------------- |
| 200    | Server is healthy |
| 500    | Server error      |

## CLI Equivalent

```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
# 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

* [Discovery API](/docs/deploy/api/discovery-api) - Full discovery document
* [Gateway Health](/features/gateway-cli) - Gateway-specific health endpoint with different response format