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/run | POST | エージェントを実行(非ストリーミング) |
/agent/run/stream | POST | エージェントを実行(SSE ストリーミング) |
/agent/run/stream/{runId} | POST | エージェントをレジューム(SSE ストリーミング) |
/agent/run/{runId}/status | GET | 実行ステータスを取得 |
/agent/run/{runId}/resume | POST | エージェントをレジューム(非ストリーミング) |
HITL(Human-in-the-Loop)
| エンドポイント | メソッド | 概要 |
|---|
/agent/run/{runId}/plan/answer | POST | プラン確認質問に回答 |
/agent/run/{runId}/plan/confirm | POST | プランを確定 |
/agent/run/{runId}/plan/skip | POST | プラン確認をスキップ |
/agent/run/{runId}/report/answer | POST | レポート確認質問に回答 |
/agent/run/{runId}/report/confirm | POST | レポートを確定 |
/agent/run/{runId}/matrix/answer | POST | マトリクス確認質問に回答 |
/agent/run/{runId}/matrix/confirm | POST | マトリクスを確定 |
ワークスペース・ターン
| エンドポイント | メソッド | 概要 |
|---|
/workspace | GET | API キーに紐づくワークスペース情報を取得 |
/turn/list | GET | ターン履歴をページネーション取得 |
ブラウザ操作
| エンドポイント | メソッド | 概要 |
|---|
/browser/answer-question | POST | browse 中にエージェントから出た質問に回答 |
/browser/spontaneous-input | POST | browse 中のブラウザセッションへ追加指示を送信 |
/browser/answer-question-with-files | POST | ファイル付きで browse の質問に回答 |
/browser/spontaneous-input-with-files | POST | ファイル付きで browse へ追加指示を送信 |
エージェント管理
| エンドポイント | メソッド | 概要 |
|---|
/agent/list | GET | エージェント一覧を取得 |
シークレット
| エンドポイント | メソッド | 概要 |
|---|
/secret | POST | エージェント実行で使う API キーなどのシークレットを登録 |
グラフデータ
| エンドポイント | メソッド | 概要 |
|---|
/graph/workspace | GET | ワークスペースのグラフデータを取得 |
/graph/entities | GET | エンティティ一覧をフィルタ・検索・ページネーション取得 |
/graph/edges | GET | エッジ(リレーション)一覧を取得 |
エージェントスキル
| ページ | 概要 |
|---|
| エージェントスキル | Snorbe API を Claude Code / Cursor / Codex / Google Antigravity から呼び出す Agent Skill のインストールガイド |