SNA

HTTP ルート

すべてのサーバエンドポイントを表面別にまとめます。

HTTP API は表面別にまとまっています。以下の各パスはエンドポイント別の詳細仕様ページへリンクします。

認証

GET /health は公開されています。SNA ランタイムのその他すべてのルートは /api/sna-port、SSE ルート、chat image 取得も含めて Authorization: Bearer <authToken> を要求します。トークンがない場合や 一致しない場合は 401、許可されていない browser origin は 403 を返します。

SDK が管理する host では、handle.connectionSnaClient または SnaProvider に渡します。別の app-owned discovery endpoint が信頼済み renderer に { baseUrl, authToken } を返すことはできますが、SNA ランタイム 自身の /api/sna-port ルートは引き続き保護されます。

システム

メソッドパス用途
GET/healthHealth check
GET/api/sna-port現在の SNA API ポート取得

セッション

メソッドパス用途
POST/agent/sessionsセッションレコード作成
GET/agent/sessionsセッション一覧取得
PATCH/agent/sessions/{id}label、meta、cwd を更新
DELETE/agent/sessions/{id}セッション、履歴、runtime chain、保留中の権限を削除

エージェントライフサイクル

メソッドパス用途
POST/agent/startセッション内でエージェントを spawn
POST/agent/sendメッセージ送信
POST/agent/restart終了後に re-spawn
POST/agent/resume正規化履歴で再開
POST/agent/interrupt現在のターンを取り消し
POST/agent/set-modelランタイム中にモデル変更
POST/agent/set-permission-modeランタイム中に権限モード変更
PATCH/agent/session統一設定 mutator
POST/agent/killエージェントプロセス終了
GET/agent/status状態スナップショット

単発呼び出し

メソッドパス用途
POST/agent/run-once1 回実行して結果返却
POST/agent/run-once/streamSSE イベントで単発実行
POST/agent/completion単発 completion

権限

メソッドパス用途
POST/agent/permission-request権限要求を送信して待機
POST/agent/permission-respond承認または拒否
GET/agent/permission-pendingpending 要求一覧

モデルとイベント

メソッドパス用途
POST/agent/list-modelsランタイムモデル introspection
GET/agent/eventsセッションイベント SSE ストリーム

Chat (正規化履歴表面)

メソッドパス用途
GET/chat/sessionsDB の chat セッション一覧
POST/chat/sessionschat セッション作成
DELETE/chat/sessions/{id}chat セッション削除
GET/chat/sessions/{id}/messagesメッセージ一覧
POST/chat/sessions/{id}/messagesメッセージ追加
DELETE/chat/sessions/{id}/messagesメッセージをクリア
GET/chat/images/{sessionId}/{filename}画像 embed を提供

レスポンス形

ほとんどの SDK-facing レスポンスは server/api-types.ts の envelope に従います。streaming と binary エンドポイントは wire-native なレスポンス本文を使います。正確な schema はライブ OpenAPI ドキュメントで確認してください。

type ApiResponse<T> =
  | { status: "ok"; data: T }
  | { status: "error"; message: string; code?: string };

目次