Watch由 Tensor Dynamics 开发

Sentinel API v1

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

API reference

Use the runtime's OpenAPI as authority

This page maps the current v1.0.0 public contract. The exact deployed schema comes from that node's /v1/openapi.json. The public contract contains only /v1 operations.

Public, versioned full schema

Inspect all 44 paths, 55 operations, request/response schemas, errors, security, and examples before installing a node.

Open OpenAPI v1.0.0 JSON ↗Download JSON
The machine-readable schema exposes a configurable sentinelBaseUrl with the safe default http://127.0.0.1:8000. For a remote deployment, set it to your Edge node or trusted TLS proxy. Never send a Bearer key to watch.tensordynamics.org. Generator setting names differ, so inspect the actual destination before the first authenticated request.

Used only to generate the links below. This public page never asks for, sends, or stores an API key.

Check readiness ↗Swagger UI ↗ReDoc ↗OpenAPI JSON ↗

Resource map

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

Common headers

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

OpenAPI quality requirements

  • The schema includes only /v1; legacy /api and internal paths do not leak.
  • Operation IDs are stable, with tags, security, success examples, and non-2xx responses.
  • Examples contain no keys, RTSP passwords, unredacted URLs, or file paths.
The resource map reflects the current v1.0.0 contract; a deployed node's /v1/openapi.json is the final schema authority, and documentation text never substitutes for runtime evidence.