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

コンテナーを起動し、画像を1枚送信して、最初のイベントを受信します。

事前にDockerのインストールと起動が必要です。カメラ、GPU、クラウドアカウントは不要です。クイックスタートではテスト用ソースとJPEGを使い、APIキー、モデル、イベント、webhook、証拠のダウンロードまでを一通り検証します。

はじめに

APIの処理フロー

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

Sourceは映像の取得元を、Monitorは何をイベントとするかを定義します。Event JSONが安定した連携出力です。モデルの文章は補足情報なので、重大度やイベント種別の判定のために解析しないでください。

本番運用にコンソールは必須ではありません。テストと試運転用の任意ツールであり、閉じてもAPIランタイム、永続的なmonitors、webhookの再試行は停止しません。旧デスクトップ互換モードではセッションがUIのライフサイクルに依存する場合があるため、APIランタイムモードと混同しないでください。

製品名と提供状況

Sentinel Edge Runtime現在のソースキット

UIなしで映像取得、推論、イベント永続化、webhook処理を行うランタイム。

Sentinel API v1現在の仕様

Sentinel Edgeの公開REST/OpenAPI連携仕様。

Sentinel Console提供中 · 任意

テストと試運転用のUI。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ルートは、移行期間中の互換インターフェースとして残ります。