API Reference

The full OpenAPI 3.1 spec is rendered below. Use the search bar to find an endpoint by operationId or path. For per-group narrative reference (with curl / TypeScript / Python examples), see the pages under /developer/rest/.

Download

• OpenAPI 3.1 (YAML)
• OpenAPI 3.1 (JSON)

Per-group references

• Auth endpoints
• User endpoints
• Camera endpoints
• Event endpoints
• Alert endpoints
• Gateway endpoints

Authentication

All endpoints require a Bearer access token unless the spec marks the operation with security: []. See the auth how-to for the JWT + refresh flow.

Versioning

The spec is versioned in lockstep with the API. The info.version field tracks the current production API version. Major-version bumps indicate breaking changes and ship with a migration guide.