メインコンテンツへスキップ

API リファレンス

Snorbe API を使うと、外部のアプリケーションやスクリプトから Snorbe のリサーチエージェントをプログラムで呼び出せます。

認証

すべての API リクエストには API キーが必要です。API キーはダッシュボードの API Keys ページで作成できます。 リクエストヘッダーに以下のいずれかの形式で API キーを含めてください。
# Authorization ヘッダー(推奨)
Authorization: Bearer snorbe_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

# または x-api-key ヘッダー
x-api-key: snorbe_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
API キーは発行時に一度だけ表示されます。紛失した場合は新しいキーを作成してください。

ベース URL

https://app.snorbe.deskrex.ai/api/v1

インタラクティブ API リファレンス

ブラウザから全エンドポイントを一覧・検索・実行できる Scalar 製の UI を用意しています。

Snorbe API Reference(Scalar UI)

  • 全エンドポイントのパラメータ・レスポンス・コード例を確認
  • 「Try it out」ボタンから自分の API キーで直接リクエストを送信
  • OpenAPI 3.1 仕様に準拠

OpenAPI JSON

機械可読な API 仕様は OpenAPI JSON で取得できます(Scalar UI もこの JSON を参照しています)。
curl "https://app.snorbe.deskrex.ai/api/v1/openapi.json"
パス一覧だけ確認する場合:
curl -s "https://app.snorbe.deskrex.ai/api/v1/openapi.json" | jq -r '.paths | keys[]'

レート制限

API キーごとに 1分あたり100リクエスト の制限があります。制限を超えた場合は 429 Too Many Requests が返ります。

エンドポイント一覧

エージェント実行

エンドポイントメソッド概要
/agent/runPOSTエージェントを実行(非ストリーミング)
/agent/run/streamPOSTエージェントを実行(SSE ストリーミング)
/agent/run/stream/{runId}POSTエージェントをレジューム(SSE ストリーミング)
/agent/run/{runId}/statusGET実行ステータスを取得
/agent/run/{runId}/resumePOSTエージェントをレジューム(非ストリーミング)

HITL(Human-in-the-Loop)

エンドポイントメソッド概要
/agent/run/{runId}/plan/answerPOSTプラン確認質問に回答
/agent/run/{runId}/plan/confirmPOSTプランを確定
/agent/run/{runId}/plan/skipPOSTプラン確認をスキップ
/agent/run/{runId}/report/answerPOSTレポート確認質問に回答
/agent/run/{runId}/report/confirmPOSTレポートを確定
/agent/run/{runId}/matrix/answerPOSTマトリクス確認質問に回答
/agent/run/{runId}/matrix/confirmPOSTマトリクスを確定

ワークスペース・ターン

エンドポイントメソッド概要
/workspaceGETAPI キーに紐づくワークスペース情報を取得
/turn/listGETターン履歴をページネーション取得

ブラウザ操作

エンドポイントメソッド概要
/browser/answer-questionPOSTbrowse 中にエージェントから出た質問に回答
/browser/spontaneous-inputPOSTbrowse 中のブラウザセッションへ追加指示を送信
/browser/answer-question-with-filesPOSTファイル付きで browse の質問に回答
/browser/spontaneous-input-with-filesPOSTファイル付きで browse へ追加指示を送信

エージェント管理

エンドポイントメソッド概要
/agent/listGETエージェント一覧を取得

シークレット

エンドポイントメソッド概要
/secretPOSTエージェント実行で使う API キーなどのシークレットを登録

グラフデータ

エンドポイントメソッド概要
/graph/workspaceGETワークスペースのグラフデータを取得
/graph/entitiesGETエンティティ一覧をフィルタ・検索・ページネーション取得
/graph/edgesGETエッジ(リレーション)一覧を取得

エージェントスキル

ページ概要
エージェントスキルSnorbe API を Claude Code / Cursor / Codex / Google Antigravity から呼び出す Agent Skill のインストールガイド