API 概要
HTTP ルート、WebSocket プロトコル、イベントタイプを一か所で確認します。
このセクションはワイヤリファレンスです。各形式がなぜこのように設計 されているかは、中心モデル で扱います。 SNA の HTTP/WebSocket API と ACP を比較している場合は、 SNA と ACP もあわせて見てください。
エンドポイントリファレンス
すべての HTTP エンドポイントの要求フィールド、レスポンス、備考。
HTTP ルート
サーバエンドポイントを表面別にまとめた一覧。
WebSocket プロトコル
Request/response op、push チャネル、再接続ルール。
イベント
15 種類の AgentEvent タイプ、delta、最終イベント。
OpenAPI 仕様
実行中サーバが直接提供するライブ仕様。
契約の基準
サーバの Hono アプリは @hono/zod-openapi ルート定義からビルドされます。
実行中サーバは、同じ Zod スキーマから生成された OpenAPI 3.1 仕様を
直接提供します。そのため、この文書のワイヤ形式、SDK 型、ライブ仕様は
同じソースから派生します。
| URL | 用途 |
|---|---|
GET /openapi.json | 生の仕様 JSON |
GET /docs | Swagger UI |
GET /spec | プレーンテキスト仕様 |
認証
GET /health 以外のランタイム HTTP ルートは
Authorization: Bearer <authToken> を要求します。SSE ストリームと
WebSocket upgrade も同じトークンで保護されます。SDK ランチャーはこの値を
handle.connection.authToken として返すため、クライアントには
handle.connection をそのまま渡すのが安全です。
OpenAPI ドキュメントは global bearerAuth を宣言し、/health の
security は空にし、保護されたルートに 401/403 response を表示します。
正確な契約を確認する場合は、ライブサーバのスペックを直接見てください。 ライブスペックが常に最終基準です。