Sentinel API v1

從第一個 API 呼叫到正式環境

Sentinel API v1

為既有攝影機建置事件工作流

用 Web GUI 設定攝影機與監看條件,再讓你的系統接收 Webhook 事件。需要自行開發介面或包入產品時,再使用完整 REST API。

只需要接收告警?從這裡開始。

部署 Docker → Web GUI 設定 → 接收 Webhook。附可下載的接收器原始碼。

快速整合指南
Source

RTSP 或測試圖片

Monitor

要監看的條件

Event

版本化事件

Evidence

受保護的 JPEG URL

API 開發與測試

啟動容器,送出第一張圖片,收到第一則事件。

必須先安裝並啟動 Docker;不需要攝影機、GPU 或雲端帳號。Quickstart 使用測試 Source 與 JPEG,確認 API key、模型、事件、Webhook 與證據下載完整串通。

開始

最小心智模型

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

Source 定義影像從哪裡來;Monitor 定義什麼情況值得形成事件。事件 JSON 是系統整合的穩定輸出,模型文字只是補充資訊,不應被下游程式解析成嚴重度或事件類型。

正式執行時不需要控制台。UI 只是選配的測試與現場驗收工具;關閉 UI 不會停止 API Runtime、持久化 Monitor 或 Webhook 重試。舊版桌面相容模式仍可能由畫面生命週期管理 Session,請勿與新的 API Runtime 模式混用。

產品名稱與可用狀態

Sentinel Edge Runtime目前提供

無介面的取流、推理、事件保存與 Webhook 執行環境。

Sentinel API v1目前提供

Edge Runtime 的公開 REST/OpenAPI 整合契約。

Sentinel Console目前提供 · 選配

測試與現場驗收介面;不是 API Runtime 的執行前提。

cloud_gemini目前提供 · 明確選用

只有模型狀態、模型測試與代表性影像驗收都成功後才投入 production;啟用後有限推理圖片與必要 metadata 會離開 Edge。

託管控制平面路線圖 · 尚未提供

目前沒有公開、多租戶的 Sentinel 雲端控制平面。

依工作瀏覽

開始

先理解契約並跑通第一則事件。

建置

連接影像並把事件送進你的系統。

維運

部署、選模型、監測健康並準備上線。

參考

查欄位、共通行為、範例與版本政策。

相容介面

僅供既有整合遷移;這些路由不屬於公開 /v1 OpenAPI,也不應混進新的 Build 流程。

介面與版本

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 在遷移期間屬於相容介面。