---
title: "Health check"
method: GET
path: "/healthz"
---

# Health check

`GET /healthz`

## Request

- Base URL: `https://api.niubai.vip` (the document declares no server; this is the origin it was published from)
- URL: `https://api.niubai.vip/healthz`
- Auth: none required

`{"status": "ok"}` when the API and its database answer. No key needed.

## Response `200`

Successful Response

- HealthOut
  - `status` string: "ok" when the API and its database answer.

## Other responses

- `500`: error.code is one of: engine_error

---

[API](https://skmtc.dev/niubai/apis/pdf-edit-api-gateway.md) · [All operations](https://skmtc.dev/niubai/apis/pdf-edit-api-gateway/llms.txt) · [OpenAPI document](https://skmtc.dev/niubai/apis/pdf-edit-api-gateway/revisions/83ed2bb54eb5?raw)