> Documentation index: https://nao-rs.lukaloehr.com/llms.txt, a list of every page in this documentation.

# System

> REST API: Health and the spec. Generated from the OpenAPI document.

## Is the API up?

`GET /v1/health`

Public. Also says how old the latest robot state is.

**Token:** not needed · **Lease:** not needed

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | The API is up | [Health](https://nao-rs.lukaloehr.com/reference/rest-api/schemas.md#health) |

```bash
curl http://$ROBOT:7702/v1/health
```

## This API's OpenAPI 3.1 document

`GET /v1/openapi.json`

Public. Generated from the code, so it always matches the running API.

**Token:** not needed · **Lease:** not needed

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | OpenAPI 3.1 document | object |

```bash
curl http://$ROBOT:7702/v1/openapi.json
```

## Related topics

- [REST API](https://nao-rs.lukaloehr.com/reference/rest-api.md)
- [Robot](https://nao-rs.lukaloehr.com/reference/rest-api/robot.md)
- [State](https://nao-rs.lukaloehr.com/reference/rest-api/state.md)
- [Events](https://nao-rs.lukaloehr.com/reference/rest-api/events.md)
- [Safety](https://nao-rs.lukaloehr.com/reference/rest-api/safety.md)
- [Control](https://nao-rs.lukaloehr.com/reference/rest-api/control.md)
- [LEDs](https://nao-rs.lukaloehr.com/reference/rest-api/leds.md)
- [Audio](https://nao-rs.lukaloehr.com/reference/rest-api/audio.md)
- [Cameras](https://nao-rs.lukaloehr.com/reference/rest-api/cameras.md)
- [Power](https://nao-rs.lukaloehr.com/reference/rest-api/power.md)
- [Motion](https://nao-rs.lukaloehr.com/reference/rest-api/motion.md)
- [Schemas](https://nao-rs.lukaloehr.com/reference/rest-api/schemas.md)
- Previous: [REST API](https://nao-rs.lukaloehr.com/reference/rest-api.md)
- Next: [Robot](https://nao-rs.lukaloehr.com/reference/rest-api/robot.md)