# Health Check APIs

### Health Check Endpoint

Use the public health check endpoint `GET /api/health/` to automatically verify if the PixieBrix API is operational.

A successful response will return a **200 OK** status code with the following JSON payload:

```
{"status": "ok"}
```

> Note: Any other status code or response indicates that the PixieBrix API may be unavailable.

### Status Page

For more detailed status updates and to subscribe to maintenance and uptime notifications, visit the [PixieBrix Status Page](https://pixiebrix.statuspage.io/).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.pixiebrix.com/developer-api/health-check-apis.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.