> ## Documentation Index
> Fetch the complete documentation index at: https://praison.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# health • AI Agent SDK

> health: Get gateway health status.

# health

<div className="flex items-center gap-2">
  <Badge color="purple">Method</Badge>
</div>

> This is a method of the [**GatewayProtocol**](../classes/GatewayProtocol) class in the [**protocols**](../modules/protocols) module.

Get gateway health status.

## Signature

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
def health() -> Dict[str, Any]
```

### Returns

<ResponseField name="Returns" type="Dict[str, Any]">
  * status: "healthy" or "unhealthy"
    * uptime: Seconds since start
    * agents: Number of registered agents
    * sessions: Number of active sessions
    * clients: Number of connected clients
    * reload: Optional :class:`ReloadStatus` dict (config hot-reload
      outcome + watcher liveness), when the gateway runs from a config
      file. See :class:`ReloadStatus`.
    * applied\_config\_revision: Optional stable revision id (see
      :func:`compute_config_revision`) of the config the gateway is
      *actually running*, comparable against the on-disk revision to
      detect drift.
    * pressure: Optional :class:`HealthPressure` dict (admission /
      inbound / outbound backlog + event-loop lag and a derived
      `pressure` classification), when the gateway runs back-pressure
      machinery. See :class:`HealthPressure` and :func:`evaluate_pressure`.
</ResponseField>

## Source

<Card title="View on GitHub" icon="github" href="https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-agents/praisonaiagents/gateway/protocols.py#L1085">
  `praisonaiagents/gateway/protocols.py` at line 1085
</Card>