API reference
The sidebar reference is generated from a copy of the OpenAPI registered by Fastify. The current snapshot contains 199 paths. It includes native routes and the video, system, and data families. Guides explain usage; the reference shows the contract declared by the backend.
Open Swagger for my installation · View OpenAPI for my installation
Authentication
Section titled “Authentication”| Family | Authentication |
|---|---|
/v1 |
Bearer with API key |
/video/v1 |
Basic with token ID and secret |
/system/v1 |
Basic with token ID and secret |
/data/v1 |
Basic with token ID and secret |
/dashboard |
HttpOnly session and CSRF protection for writes |
| Playback | According to the playback ID’s policy and tokens |
Schema security declarations may be less specific on some internal routes. Use this table and the server’s actual authorization checks as the reference for those families. Do not send administrative credentials to the player or browser.
Update the copy
Section titled “Update the copy”From the repository root:
pnpm docs:sync-apipnpm build:docsExport registers routes without opening a port or querying application data. It does not need a running API. Keep the generated apps/docs/schema/openapi.json in the same change as routes that modify it.
The reference reflects schemas declared by the routes. It does not add fields or guarantees that the backend does not describe. SDK resources and extensions are also documented in docs/sdk-reference.md.
Read the reference alongside the guides
Section titled “Read the reference alongside the guides”Some route schemas do not declare every body or response validated by the handler. The copy is exported as registered; it does not fill these gaps or test runtime behavior. Use examples and limits from uploads, Usage, comparisons, and notifications to interpret it. Also see validation status.