API concepts and conventions
Streams and camera access
Section titled “Streams and camera access”A stream represents a camera or another configured video source. Its id is a stable UUID. Fields such as externalId, name, and location help your integration associate the source with your own records.
The server projects resources into the caller’s organization and camera access. The same query can return different results for different callers. A missing result can reflect resource access or a resource that was removed.
Configuration and runtime state
Section titled “Configuration and runtime state”A configuration revision identifies a version of saved settings. Runtime state describes processing, such as starting, running, or stopped. Saving configuration and completing a lifecycle operation are separate events.
Use the resource’s current revision when an operation requires If-Match. Fetch again after a conflict, reconcile your intended changes, and submit against the revision you reviewed.
Jobs and long-running work
Section titled “Jobs and long-running work”Some requests return 202 Accepted and an operation or job resource. Search results can arrive progressively. Check the returned resource and its state using the workflow-specific read operation.
Polling endpoints vary by resource. The reference lists the actual routes for searches, image analysis, imports, and cleanup jobs.
Response shapes and limits
Section titled “Response shapes and limits”Some collection operations return an array, while others return a page object. Use the specific operation’s limit, offset, or cursor parameters where available. Preserve opaque cursor values exactly and use the same filters across successive pages.
Reference tables distinguish required fields from optional fields. A required nullable field must be present and can contain null. An optional field can be omitted. Check each schema’s additionalProperties, bounds, enums, and discriminator fields before writing.