API

Specifications for interaction with PlaceOS via the API.

In order to use the PlaceOS API and Staff API, you will need to obtain an API Key to accompany all API Requests.
To generate an API Key you can follow the instructions to generate an X-API Key.
PlaceOS has two main API, you can navigate to the API Swagger using the links in the left navigation menu or navigate directly:
Rest API: https://placeos.github.io/staff-api-swagger-ui/​
Staff API: https://placeos.github.io/rest-api-swagger-ui/​

Elevated Privileges

Real-time Websocket

Last modified 5mo ago