Authentication
Every request requires two headers for token-based authentication:Base URL
All API requests are made to one of two base URLs depending on the type of operation:Common Patterns
- All requests use POST — every endpoint accepts a
POSTrequest with a JSON body, even for read operations. - All responses are JSON — responses follow a consistent JSON structure across the entire API.
- Empty body for simple queries — endpoints that do not require parameters still expect an empty JSON object (
{}).
Browse by Category
Cameras & Video
Manage cameras, retrieve clips, configure video settings, and access live and recorded footage.
Audio
Control audio devices, manage audio clips, and configure speaker settings.
Access Control
Manage doors, access points, credentials, and entry logs.
Sensors & Environment
Monitor environmental sensors, retrieve readings, and configure thresholds.
Events & Alerts
Query events, configure alert rules, and manage notification preferences.
Analytics & AI
Access face recognition, license plate detection, people counting, and other AI-powered features.
Users & Organization
Manage users, roles, permissions, and organization settings.
Integrations
Configure webhooks, third-party connections, and external system integrations.
Platform & Config
System configuration, firmware management, network settings, and platform administration.
This reference is generated directly from our production OpenAPI spec, which is fetched fresh on every site build. We also check the upstream API for changes several times a day and redeploy automatically, so the reference stays current. Use the interactive playground on any endpoint page to test requests with your API key.