# Check the service is up

> Page: https://docs.plotwork.dev/api/get-health. Index of every page: https://docs.plotwork.dev/llms.txt

Always answers 200 with the package version and the diagram kinds this build renders.

`GET /health`

## TL;DR

| Question | Answer |
|---|---|
| What does it do? | Check the service is up. |
| What does it take? | Nothing. |
| What does it return? | Status 200 with a body of type [`HealthResponse`](https://docs.plotwork.dev/api/schemas.md#healthresponse). |
| What can go wrong? | Nothing beyond a server error. |

## What it does

Always answers 200 with the package version and the diagram kinds this build renders.

## Responses

| Status | Meaning | Body |
|---|---|---|
| 200 | Service is up. | [`HealthResponse`](https://docs.plotwork.dev/api/schemas.md#healthresponse) |

## Response body

A 200 answer has the type [`HealthResponse`](https://docs.plotwork.dev/api/schemas.md#healthresponse).

| Field | Type | Required | Description |
|---|---|---|---|
| `status` | `"ok"` | yes |  |
| `version` | `string` | yes | Package version of the running service. |
| `kinds` | `string[]` | yes | Diagram kinds this build can render. |

## See also

| Doc | Why |
|---|---|
| [API reference](https://docs.plotwork.dev/api/reference.md) | Every endpoint, and the error envelope |
| [Schemas](https://docs.plotwork.dev/api/schemas.md) | Every request and response type |
| [Tool reference](https://docs.plotwork.dev/mcp/tools.md) | The operations as callable tools |