Reference Realtime

realtime API

The WebSocket for live state and command results (protocol in the guide).

Base path /api/v1/realtime behind the gateway. Authentication, rate limits and the error format are the same for every service: see Scripting MowDeck. Rendered from apps/web/openapi/realtime.json (OpenAPI 3.1), which you can also load into any OpenAPI tool.

Operations

This service has no HTTP operations for clients.

WebSocket

GET /api/v1/realtime/ws upgrades to a WebSocket (not part of the OpenAPI document). The first message authenticates with an access token ({"type": "auth", "token": "..."}), then subscribe names the mowers. Messages, close codes and limits: ADR 0018 and the realtime README; a complete client is in Scripting MowDeck.

---

Mirrored from docs/reference/api/realtime.md at commit 14af01c2a57ec5adc34136f7375ca93f2a5b7226. Edit the file in the repository, not this wiki page.