Skip to content

docs: document nat serve /health endpoint in REST API guide #2094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
valter-silva-au wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs: document nat serve /health endpoint in REST API guide #2094

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/source/reference/rest-api/api-server-endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,31 @@ uv pip install -e examples/getting_started/simple_calculator
nat serve --config_file examples/getting_started/simple_calculator/configs/config.yml
```

## Health Check Endpoint
- **Route:** `/health`
- **Method:** GET
- **Description:** A liveness/readiness probe for the running server. It is registered automatically

@willkill07 willkill07 Jul 8, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Description:** A liveness/readiness probe for the running server. It is registered automatically
- **Description:** A liveness and readiness probe for the running server. It is registered automatically

whenever you start `nat serve`, returns immediately without executing a workflow, and requires no
model or API credentials. This makes it suitable for reverse proxies, process supervisors, Docker
health checks, and Kubernetes-style readiness/liveness probes.

@willkill07 willkill07 Jul 8, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
health checks, and Kubernetes-style readiness/liveness probes.
health checks, and Kubernetes-style readiness and liveness probes.

- **HTTP Request Example:**
```bash
curl -s http://localhost:8000/health
```
- **HTTP Response Example:**
```json
{"status":"healthy"}
```

:::{note}
This endpoint checks the FastAPI server started by `nat serve` (default port `8000`). The MCP and
FastMCP servers expose their own separate `/health` routes on their own default ports — see
[Verifying MCP Server Health](../../run-workflows/mcp-server.md#verifying-mcp-server-health)
(default port `9901`) and
[Verifying FastMCP Server Health](../../run-workflows/fastmcp-server.md#verifying-fastmcp-server-health)
(default port `9902`).
:::

## Generate Non-Streaming Transaction
- **Route:** `/v1/workflow` (legacy: `/generate`)
- **Description:** A non-streaming transaction that waits until all workflow data is available before sending the
Expand Down
Loading