Sentinel API v1
Build event workflows on the cameras you already have
Configure cameras and monitoring rules in the Web GUI, then receive webhook events in your system. Use the full REST API when building your own interface or embedding the runtime in your product.
Just need alerts? Start here.
Deploy Docker → Configure in the Web GUI → Receive webhooks. Receiver source included.
Quick integration guideRTSP or test frames
What to watch for
Versioned event
Protected JPEG URL
API development & testing
Start the container, send one image, receive the first event.
Docker must be installed and running first; no camera, GPU, or cloud account is required. The quickstart uses a test source and JPEG to verify the API key, model, event, webhook, and evidence download end to end.
The API workflow
Camera / JPEG → Source → Monitor → Event → image_url → your systemA Source defines where video comes from; a Monitor defines what should become an event. Event JSON is the stable integration output. Model prose is supplementary and should never be parsed for severity or event type.
Product names and availability
The headless capture, inference, event persistence, and webhook runtime.
The public REST/OpenAPI integration contract for Sentinel Edge.
A test and commissioning UI; it is not required by the API runtime.
Production-gated: require model status, model test, and representative-image acceptance; bounded inference images and required metadata leave the Edge when enabled.
A public, multi-tenant Sentinel cloud control plane is not currently offered.
Browse by task
Start
Understand the contract and prove the first event.
Build
Connect video and deliver events into your systems.
Operate
Deploy, select models, observe health, and prepare production.
Reference
Look up fields, shared behavior, examples, and version policy.
Compatibility
For migration of existing integrations only. These routes are outside the public /v1 OpenAPI and are not part of the new Build journey.
Interface and version
Base URL http://localhost:8000
API prefix /v1
Auth Authorization: Bearer <api-key>
OpenAPI GET /v1/openapi.json
Reference GET /v1/docsOnly /v1 is the new public integration contract. Existing /api/*, WebSocket, and MCP routes remain compatibility surfaces during migration.