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

# Gateway Status Protocol • AI Agent SDK

> GatewayStatusProtocol: Protocol for agent-facing, read-only live status/health reporting.

# GatewayStatusProtocol

> Defined in the [**protocols**](../modules/protocols) module.

<Badge color="blue">AI Agent</Badge>

Protocol for agent-facing, read-only live status/health reporting.

A concrete implementation is provided by the running gateway/bot (in the
praisonai wrapper) and registered into the per-turn context so the built-in
`gateway_status` tool can resolve it. It reads the same live objects the
HTTP endpoints already serve (`health()` / `metrics_snapshot()` / the
session registry) and returns a redaction-aware, visibility-scoped
:class:`GatewayStatus`.

Example usage (implementation in praisonai\_bot.gateway)::

status = BotGatewayStatus(gateway)
token = register\_gateway\_status(status)
try:
...  # agent runs; gateway\_status tool resolves the source
finally:
clear\_gateway\_status(token)

## Methods

<CardGroup cols={2}>
  <Card title="snapshot()" icon="function" href="../functions/GatewayStatusProtocol-snapshot">
    Return a read-only snapshot of the gateway's live self-state.
  </Card>
</CardGroup>

## Source

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

***

## Related Documentation

<CardGroup cols={2}>
  <Card title="Gateway Feature" icon="tower-broadcast" href="/docs/docs/features/gateway" />
</CardGroup>