Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

API リファレンス

この部では、ブラウザクライアント、CLI、第三者検証で使う公開 API を、現行実装に基づいて説明します。

この部の章

想定読者と前提

  • 想定読者: ブラウザクライアントや第三者検証ツールから API を呼び出す実装者
  • 前提: HTTP とセッションヘッダーの基本、および本書 全体像 のフローを把握していること

この部で扱わないもの

通常の browser / CLI contract は active route と capability 保護 API に限ります。 以下はこの部では扱いません。

  • retired な debug / private inspection route（GET /api/debug/enable、GET /api/botdata/:id）の詳細
  • 置換済みの flat route（POST /api/finalize/callback、GET /api/zkvm-input-hash）の詳細
  • internal/operator-only callback（POST /api/internal/sessions/:sessionId/finalizations/:finalizationId/callback）の protocol details
  • input commitment の private-data variant。active な GET /api/sessions/:sessionId/finalizations/current/input-commitment は hash-only で、includeData query を受理しません（詳細はエンドポイント一覧）
  • raw S3 URL / presigned URL を通常の browser / CLI contract として扱う取得経路。bundle/report の取得契約はエンドポイント一覧に委譲します
  • レート制限、Turnstile、capability TTL などの環境変数チューニング
  • API Gateway、Hono、Lambda 側の認可とルーティング実装

関連する章