Watchmen REST API
Explore the public Watchmen REST API, its authentication methods, base URL, and available endpoint groups.
Overview
The Watchmen REST API provides authenticated access to the public operations documented in this reference. Select an endpoint from the navigation to view its parameters, request examples, response schemas, and interactive playground.
Base URL
https://wm.novoai.de
Authentication
Every request must use one of the authentication methods supported by the API:
- Send a JWT as
Authorization: Bearer <token>. - Send an API access key as
X-API-KEY: <key>.
Keep API access keys and JWTs out of client-side code, source control, and logs.
Available Resources
The API reference currently provides the following endpoints. Select an endpoint to view its parameters, request body, examples, response schemas, and interactive playground.
GET /v2/halls
Retrieve all halls associated with the authenticated user's company.
GET /v2/halls/{id}
Retrieve a specific hall by its unique ID.
GET /v2/machine
Retrieve the company's machines, optionally including inactive machines.
GET /v2/timeline_reason
Retrieve the timeline reasons used to classify downtime and operational events.
POST /v2/timeline/reason_assign
Assign a timeline reason to a machine for a live or historical event.
POST /v2/timeline/reason_preset
Preset a timeline reason for real-time or scheduled machine activity.
POST /v2/analytics/day
Retrieve comprehensive machine analytics for a single calendar day.
Each link opens the dedicated reference page for that callable API operation.