Reference Index

API reference

Every MowDeck service publishes an HTTP API under /api/v1/<service> on the same origin as the web app. The pages below are generated from the OpenAPI documents the services export, so they always match the code of this version. Start with Scripting MowDeck for authentication with a personal access token, rate limits, the error format and examples in curl, Python and JavaScript.

Service	Base path	Operations	What it does
billing	/api/v1/billing	6	Plans, checkout and the Stripe webhook (only with billing enabled).
device-gateway	/api/v1/device-gateway	1	Mower links of the installation (operator view).
entitlements	/api/v1/entitlements	8	What the account's plan allows; usage and limits.
fleet	/api/v1/fleet	55	Mowers, sites, groups, linked cloud accounts, base stations and commands.
identity	/api/v1/identity	75	Accounts, users, roles, sessions, API tokens and personal access tokens.
notifications	/api/v1/notifications	22	Inbox, rules, channels and push devices.
planner	/api/v1/planner	8	Mowing patterns, spot paths and plans.
realtime	/api/v1/realtime	0	The WebSocket for live state and command results (protocol in the guide).
scheduler	/api/v1/scheduler	14	Schedules, their runs, rain pause and the weather.
telemetry	/api/v1/telemetry	44	Current state, history, positions, maps, health and reports.
vision	/api/v1/vision	16	AI assisted recovery: proposals, approvals and the provider settings.

The raw OpenAPI 3.1 documents are in apps/web/openapi: load them into Swagger UI, Redoc, Scalar, Insomnia, Bruno or a client generator of your choice.

Try it live on the demo: a public demo installation has an interactive explorer of these documents at /api-explorer (after "Try the demo"; simulated mowers, refused actions answer 403 demo-mode). See Scripting MowDeck and ADR 0072.

---

Mirrored from docs/reference/api/index.md at commit 0e88d466ecb9fb0d526fc18d42f47e2cece5eb05. Edit the file in the repository, not this wiki page.