Sentinel API v1

从第一次 API 调用到生产部署

Sentinel API v1

用现有摄像头构建事件工作流程

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 guide
Source

RTSP 或测试画面

Monitor

需要留意的情况

Event

版本化事件

证据

受保护的 JPEG URL

API development & testing

启动容器,发送一张图片,接收第一条事件。

请先安装并启动 Docker;无需摄像头、GPU 或云端账户。快速入门使用测试来源和 JPEG,端到端验证 API 密钥、模型、事件、webhook 和证据下载。

入门

API 工作流程

Camera / JPEG → Source → Monitor → Event → image_url → your system

Source 定义视频来源;Monitor 定义什么情况应成为事件。Event JSON 是稳定的集成输出。模型文字仅作补充,不应通过解析文字判断严重程度或事件类型。

生产环境无需控制台。它是可选的测试和调试工具;关闭控制台不会停止 API 运行环境、持久化监控任务或 webhook 重试。旧版桌面兼容模式仍可能将会话与界面生命周期绑定,不能与 API 运行模式混为一谈。

产品名称与可用状态

Sentinel Edge Runtime当前源码套件

提供无界面的视频采集、推论、事件持久化和 webhook 运行环境。

Sentinel API v1当前契约

Sentinel Edge 的公开 REST/OpenAPI 集成契约。

Sentinel Console当前可用 · 可选

用于测试和调试的界面;API 运行环境无需依赖它。

cloud_gemini当前可用 · 需明确启用

生产使用需通过模型状态检查、模型测试和代表性图片验收;启用后,受限的推论图片及必要元数据会传出 Edge 节点。

托管控制平面规划中 · 尚不可用

目前尚未提供面向公众的多租户 Sentinel 云端控制平面。

按任务浏览

入门

了解契约并验证第一条事件。

开发

连接视频,将事件传入你的系统。

运维

部署、选择模型、观察健康状态,并准备生产上线。

参考

查阅字段、通用行为、示例及版本政策。

兼容性

仅用于迁移现有集成。这些路由不在公开 /v1 OpenAPI 中,也不属于新的开发流程。

接口与版本

Base URL   http://localhost:8000
API prefix /v1
Auth       Authorization: Bearer <api-key>
OpenAPI    GET /v1/openapi.json
Reference  GET /v1/docs

只有 /v1 是新的公开集成契约。现有 /api/*、WebSocket 和 MCP 路由在迁移期间保留为兼容接口。