Watch由 Tensor Dynamics 打造

Sentinel API v1

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

API reference

以 Runtime 的 OpenAPI 為準

此頁提供目前 v1.0.0 公開契約的資源地圖；實際部署的精確 schema 由該節點的 /v1/openapi.json 產生。公開契約只包含 /v1 operation。

公開、版本化的完整 schema

不需要先安裝節點即可檢查 44 paths、55 operations、request/response schema、錯誤、security 與範例。

開啟 OpenAPI v1.0.0 JSON ↗下載 JSON
這份 machine-readable schema 的 server 是可設定的 sentinelBaseUrl，安全預設為 http://127.0.0.1:8000。遠端部署必須把它改成你的 Edge node 或可信 TLS proxy；不要把 Bearer key 傳到 watch.tensordynamics.org。不同 generator 的設定名稱不同，請在第一個 authenticated request 前檢查實際目的地。

只用來產生下方連結；此公開頁面不會要求、傳送或保存 API key。

檢查 readiness ↗Swagger UI ↗ReDoc ↗OpenAPI JSON ↗

資源地圖

Bootstrap

GET /healthz
GET /readyz
GET /v1/openapi.json
GET /v1/docs
GET /v1/redoc

System

GET /v1/system
GET /v1/system/resources
GET /v1/system/models
POST /v1/system/models/test

Settings

GET|PUT /v1/settings/alert-policy
GET|PUT /v1/settings/prompt-map

API keys

GET|POST /v1/api-keys
DELETE /v1/api-keys/{key_id}

Sources

GET|POST /v1/sources
GET|PATCH|DELETE /v1/sources/{source_id}
POST /v1/sources/{source_id}/test
POST /v1/sources/{source_id}/frames
GET /v1/sources/{source_id}/image
GET /v1/sources/{source_id}/stream

Analyses

GET /v1/analyses
GET /v1/analyses/stream

Monitors

GET|POST /v1/monitors
GET|PATCH|DELETE /v1/monitors/{monitor_id}
POST /v1/monitors/{monitor_id}/start
POST /v1/monitors/{monitor_id}/stop
POST /v1/monitors/{monitor_id}/test

Events

GET /v1/events
GET /v1/events/stream
POST /v1/events/test
GET /v1/events/{event_id}
GET /v1/events/{event_id}/image
GET /v1/events/{event_id}/clip
POST /v1/events/{event_id}/acknowledge

Incidents

GET /v1/incidents
GET /v1/incidents/{incident_id}
GET /v1/incidents/{incident_id}/activity
GET /v1/incidents/{incident_id}/export
POST /v1/incidents/{incident_id}/claim
POST /v1/incidents/{incident_id}/release
POST /v1/incidents/{incident_id}/close
POST /v1/incidents/{incident_id}/reopen
POST /v1/incidents/{incident_id}/notes
PUT /v1/incidents/{incident_id}/tags

Webhooks

GET|POST /v1/webhook-endpoints
PATCH|DELETE /v1/webhook-endpoints/{endpoint_id}
POST /v1/webhook-endpoints/{endpoint_id}/test
GET /v1/webhook-deliveries
GET /v1/webhook-deliveries/{delivery_id}
POST /v1/webhook-deliveries/{delivery_id}/retry

共通 Header

Authorization: Bearer <api-key>
Content-Type: application/json
X-Request-ID: req_optional_correlation
Idempotency-Key: idem_required_for_retryable_mutation

對 OpenAPI 的品質要求

  • schema 只包含 /v1；舊 /api 與內部路徑不會洩漏。
  • operationId 穩定，tag、security、成功範例與非 2xx response 完整。
  • 範例中沒有 key、RTSP 密碼、未遮罩 URL 或檔案路徑。
文件資源地圖對應目前 v1.0.0 contract；部署節點的 /v1/openapi.json 是 schema 最終權威，文件文字不能取代 runtime evidence。