nao-rs Docs
GuidesSafetyBrainHardwareReference
ReferenceREST API

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

StatusMeaningBody
200The API is upHealth
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

StatusMeaningBody
200OpenAPI 3.1 documentobject
curl http://$ROBOT:7702/v1/openapi.json

REST API

The HTTP/JSON API of a robot running nao-rs - port, LAN-only access, token, control leases, errors, streams, and how to try it without a robot.

Robot

REST API: Identity and versions. Generated from the OpenAPI document.

On this page

Is the API up?This API's OpenAPI 3.1 document