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

Documentation Index

Fetch the complete documentation index at: https://docs.snorbe.deskrex.ai/llms.txt

Use this file to discover all available pages before exploring further.

ツール一覧取得

エージェントが POST /agent/run / POST /agent/run/stream 実行時に内部で呼び出すツールの一覧を返します。クライアントがエージェントの能力を事前に把握したり、UI に機能バッジを表示したりするのに使います。
認証は不要です(public)。ワークスペースに依存しない静的カタログを返します。

リクエスト

GET /api/v1/agent/tools
ヘッダー・クエリパラメータともに不要です。

レスポンス

{
  "tools": [
    {
      "id": "search",
      "displayName": "Web Search",
      "category": "research",
      "description": "General web search with query generation, SERP selection, scraping, and summary."
    },
    {
      "id": "x_search",
      "displayName": "X Search",
      "category": "research",
      "description": "Search posts on X (Twitter) with optional date range and account filters."
    },
    {
      "id": "plan",
      "displayName": "Plan",
      "category": "generation",
      "description": "Draft a multi-step research plan for human review before executing the full workflow."
    },
    {
      "id": "confirm_plan",
      "displayName": "Confirm Plan",
      "category": "hitl",
      "description": "Confirm a plan draft and start execution."
    },
    {
      "id": "mention_agent",
      "displayName": "Mention Agent",
      "category": "agent_integration",
      "description": "Hand off work to another agent referenced in the input via agent:// mention."
    }
  ]
}

レスポンスフィールド

フィールド説明
tools[].idstringツールの内部 ID(エージェントが使う正式名)
tools[].displayNamestringUI 表示用の英語名
tools[].categorystringカテゴリ。詳細は下記
tools[].descriptionstring機能の英語説明
tools[].trigger?stringchat-routing プロンプトでの発火条件(該当するツールのみ)
tools[].inputs?string主要な入力パラメータ(該当するツールのみ)
tools[].modes?string[]サポートするモード(例: matrix の create / edit / continue
tools[].flow?string[]内部ワークフローのステップ列
tools[].sseEvents?string[]このツールが発行する関連 SSE イベント名
tools[].notes?string補足(外部エンドポイント、完了後フック等)
trigger / inputs / modes / flow / sseEvents / notes はオプショナル。ツールによって持つものと持たないものがある。

カテゴリ

意味
researchWeb 検索・X 検索・ブラウザ自動化・ソース要約・RAG 検索など、情報収集を担うツール
generationレポート・マトリクス・プランなど、構造化コンテンツを生成するツール
hitlドラフトの確認・再生成・中止など、ユーザー介入フローで LLM が呼ぶツール
agent_integration他エージェントへの委譲(mention_agent)、スキル実行、エージェント記憶の更新
internalSERP 選別やブラウザ内での下請けなど、chat-routing から直接は呼ばれない内部ツール
本エンドポイントが返す一覧は エージェントが持つ正本のツールセットです。ドキュメントの説明文よりも、こちらの API レスポンスを優先してください。

使用例

curl "https://app.snorbe.deskrex.ai/api/v1/agent/tools"

エラーレスポンス

HTTP ステータスコード説明
429TOO_MANY_REQUESTSレート制限超過(稀)

関連