API Docs — Platform
Interactive OpenAPI documentation for the Aida Platform cloud API.
Where to open it
| Environment | URL |
|---|---|
| Production | https://api.aida-platform.com/api/docs |
| Local | http://localhost:<PORT>/api/docs (from backend .env PORT, e.g. 8002) |
| Your deployment | {platform-api-host}/api/docs |
Open the link in a browser. The Swagger UI lists active Platform routes only (sites, buildings, controllers, facility sync, agents, licensing, IoT install, auth/MFA, assistant/MCP, Webex, Kisi, accounts, and related). Legacy device/floor/zone stub APIs are hidden.
:::tip Local port
The console message and Same origin server entry follow PORT in backend/.env. You do not need a Vite setting — OpenAPI is served by the Express backend. Prefer the Same origin server in Swagger so Try it out hits whatever host/port you used to open /api/docs.
:::
:::info Platform vs controller This is the cloud API. Each on-site controller has its own docs — see API Docs — Controller. :::
What it covers
- Authentication and user/session APIs
- Sites, buildings, controllers, licensing, and facility snapshot APIs
- Assistant and related cloud intelligence endpoints
- Integration webhooks and configuration surfaces exposed by the platform
Exact paths and schemas are defined in the live OpenAPI document served with the UI.
Authentication in the docs UI
Most Platform endpoints require a signed-in user JWT (Authorization: Bearer …) or, for selected public assistant / MCP routes, an API key (X-API-Key). Create keys in the Platform app — see API Keys — Platform.
Use Authorize in Swagger when the UI offers it, or call endpoints with the same headers your integration will use.