リサーチタスクを作成

post/knowledge-fs/spaces/{knowledge_base_id}/research-tasks

Request example

curl --request POST \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <string>' \
  --header 'Content-Type: application/json' \
  --data '{
  "budgetUsd": 1.5,
  "limits": {
    "maxRetrievalSteps": 8,
    "maxScannedResources": 800,
    "maxToolCalls": 12,
    "timeoutMs": 120000
  },
  "metadata": {
    "client_request_id": "client-20260907-0001",
    "ticket": "SUP-1042"
  },
  "mode": "research",
  "query": "What changed in the 2025 refund policy, and which regions are affected?",
  "topK": 10
}'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks"
headers = {
    "Authorization": "Bearer <token>",
    "Idempotency-Key": "<string>",
    "Content-Type": "application/json",
}
payload = {
    "budgetUsd": 1.5,
    "limits": {
        "maxRetrievalSteps": 8,
        "maxScannedResources": 800,
        "maxToolCalls": 12,
        "timeoutMs": 120000
    },
    "metadata": {
        "client_request_id": "client-20260907-0001",
        "ticket": "SUP-1042"
    },
    "mode": "research",
    "query": "What changed in the 2025 refund policy, and which regions are affected?",
    "topK": 10
}

response = requests.request("POST", url, headers=headers, json=payload)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Idempotency-Key': '<string>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "budgetUsd": 1.5,
    "limits": {
      "maxRetrievalSteps": 8,
      "maxScannedResources": 800,
      "maxToolCalls": 12,
      "timeoutMs": 120000
    },
    "metadata": {
      "client_request_id": "client-20260907-0001",
      "ticket": "SUP-1042"
    },
    "mode": "research",
    "query": "What changed in the 2025 refund policy, and which regions are affected?",
    "topK": 10
  })
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
  "budgetUsd": 1.5,
  "limits": {
    "maxRetrievalSteps": 8,
    "maxScannedResources": 800,
    "maxToolCalls": 12,
    "timeoutMs": 120000
  },
  "metadata": {
    "client_request_id": "client-20260907-0001",
    "ticket": "SUP-1042"
  },
  "mode": "research",
  "query": "What changed in the 2025 refund policy, and which regions are affected?",
  "topK": 10
}',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
    'Idempotency-Key: <string>',
    'Content-Type: application/json',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	url := "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks"
	payload := strings.NewReader("{\n  \"budgetUsd\": 1.5,\n  \"limits\": {\n    \"maxRetrievalSteps\": 8,\n    \"maxScannedResources\": 800,\n    \"maxToolCalls\": 12,\n    \"timeoutMs\": 120000\n  },\n  \"metadata\": {\n    \"client_request_id\": \"client-20260907-0001\",\n    \"ticket\": \"SUP-1042\"\n  },\n  \"mode\": \"research\",\n  \"query\": \"What changed in the 2025 refund policy, and which regions are affected?\",\n  \"topK\": 10\n}")

	req, _ := http.NewRequest("POST", url, payload)
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Idempotency-Key", "<string>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks"))
    .header("Authorization", "Bearer <token>")
    .header("Idempotency-Key", "<string>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"budgetUsd\": 1.5,\n  \"limits\": {\n    \"maxRetrievalSteps\": 8,\n    \"maxScannedResources\": 800,\n    \"maxToolCalls\": 12,\n    \"timeoutMs\": 120000\n  },\n  \"metadata\": {\n    \"client_request_id\": \"client-20260907-0001\",\n    \"ticket\": \"SUP-1042\"\n  },\n  \"mode\": \"research\",\n  \"query\": \"What changed in the 2025 refund policy, and which regions are affected?\",\n  \"topK\": 10\n}"))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

request = Net::HTTP::Post.new(url)
request['Authorization'] = 'Bearer <token>'
request['Idempotency-Key'] = '<string>'
request['Content-Type'] = 'application/json'
request.body = '{
  "budgetUsd": 1.5,
  "limits": {
    "maxRetrievalSteps": 8,
    "maxScannedResources": 800,
    "maxToolCalls": 12,
    "timeoutMs": 120000
  },
  "metadata": {
    "client_request_id": "client-20260907-0001",
    "ticket": "SUP-1042"
  },
  "mode": "research",
  "query": "What changed in the 2025 refund policy, and which regions are affected?",
  "topK": 10
}'

response = http.request(request)
puts response.read_body

Response

{
  "budget_usd": 1.5,
  "completed_at": null,
  "cost": {
    "budgetUsd": 1.5,
    "entries": [],
    "totalUsd": 0
  },
  "created_at": 1788681600000,
  "error": null,
  "failure": null,
  "id": "e4d1b7a2-3c5f-4d8e-9a0b-1c2d3e4f5a6b",
  "knowledge_space_id": "b2f1d3a4-5e6c-4a7b-8c9d-0e1f2a3b4c5d",
  "limits": {
    "max_retrieval_steps": 8,
    "max_scanned_resources": 800,
    "max_tool_calls": 12,
    "timeout_ms": 120000
  },
  "metadata": {
    "client_request_id": "client-20260907-0001",
    "ticket": "SUP-1042"
  },
  "mode": "research",
  "query": "What changed in the 2025 refund policy, and which regions are affected?",
  "stage": "queued",
  "top_k": 10,
  "updated_at": 1788681600000
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400,
  "violations": [
    {
      "field": [
        "topK"
      ],
      "type": "less_than_equal"
    }
  ]
}

{
  "code": "knowledge_fs_invalid_request",
  "failure": {
    "category": "validation",
    "code": "KNOWLEDGE_FS_INVALID_REQUEST",
    "message": "The Agent Knowledge Base request is invalid.",
    "retryPolicy": "never",
    "traceId": "30692184-e927-4398-b8f9-a6e1eda1ea7b"
  },
  "message": "The Agent Knowledge Base request is invalid.",
  "status": 400
}

{
  "code": "knowledge_fs_invalid_credential",
  "message": "Invalid Agent Knowledge Base service credential.",
  "status": 401
}

{
  "code": "unauthorized",
  "message": "Access token is invalid",
  "status": 401
}

{
  "code": "forbidden",
  "message": "Sorry, you have reached the knowledge base request rate limit of your subscription.",
  "status": 403
}

{
  "code": "knowledge_fs_access_denied",
  "message": "Agent Knowledge Base operation is not allowed.",
  "status": 403
}

{
  "code": "knowledge_fs_resource_not_found",
  "failure": {
    "category": "not_found",
    "code": "KNOWLEDGE_FS_NOT_FOUND",
    "message": "The requested Agent Knowledge Base resource was not found.",
    "retryPolicy": "never",
    "traceId": "8f3a2c14-9d6b-4c07-b5a1-2e7d0c93f5b2"
  },
  "message": "The requested Agent Knowledge Base resource was not found.",
  "status": 404
}

{
  "code": "not_found",
  "message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.",
  "status": 404
}

{
  "code": "knowledge_fs_conflict",
  "failure": {
    "action": "retry",
    "category": "conflict",
    "code": "KNOWLEDGE_FS_CONFLICT",
    "message": "The Agent Knowledge Base operation conflicts with the current resource state.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "message": "The Agent Knowledge Base operation conflicts with the current resource state.",
  "status": 409
}

{
  "code": "knowledge_fs_request_too_large",
  "message": "Agent Knowledge Base request is too large.",
  "status": 413
}

{
  "code": "knowledge_fs_request_rejected",
  "failure": {
    "category": "validation",
    "code": "KNOWLEDGE_FS_INVALID_REQUEST",
    "message": "The Agent Knowledge Base request is invalid.",
    "retryPolicy": "never",
    "traceId": "9c729446-ba49-4733-9cc1-dbe73542d014"
  },
  "message": "The Agent Knowledge Base request is invalid.",
  "status": 422,
  "violations": [
    {
      "estimatedValue": 14,
      "limit": "maxToolCalls",
      "limitValue": 12
    }
  ]
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "failure": {
    "action": "contact_admin",
    "category": "internal",
    "code": "KNOWLEDGE_FS_INTERNAL_ERROR",
    "message": "Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "message": "Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.",
  "status": 502
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "message": "Agent Knowledge Base is unavailable.",
  "status": 502
}

{
  "code": "knowledge_fs_operation_unavailable",
  "message": "Agent Knowledge Base operation is not available.",
  "status": 503
}

{
  "code": "knowledge_fs_operation_unavailable",
  "failure": {
    "action": "retry",
    "category": "dependency",
    "code": "KNOWLEDGE_FS_UNAVAILABLE",
    "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
  "status": 503
}

post/knowledge-fs/spaces/{knowledge_base_id}/research-tasks

Authorization

Authorizationstringheaderrequired#

すべてのリクエストは API キーで認証します：Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401（unauthorized）で失敗します。

Path parameters

knowledge_base_idstringrequired#

ナレッジベース ID です。ナレッジベースの API アクセス ダイアログに表示されるサービス API エンドポイントの最後のセグメント（…/knowledge-fs/spaces/<knowledge base ID>）です。アドレスバーでは /datasets/new/ の後のセグメントです。

Headers

Idempotency-Keystring#

作成を安全に再試行できるようにする任意のキーです。前後に空白を含まない、8〜255 文字の印字可能な ASCII 文字を使用してください。キーの形式が正しくない場合は 400 が返ります。

同じ API キーと冪等キーで同一のボディを再送信すると、新しいタスクは作成されず、元のタスクが現在の状態のまま 202 で返されます。キーはワークスペース内で一意です。異なるボディ、別の API キー、別のナレッジベース、または別の操作で同じキーを再利用すると 409 が返ります。

Length: 8–255

Body

application/json

budgetUsdnumber#

支出の上限（USD）です。作成時ではなく、タスクの実行中に適用されます。リサーチタスクを計画の見積もりがこの上限を超えていても、タスクは受け付けられます。タスクはモデルを呼び出す前に毎回、その呼び出しで最悪の場合にかかるコストを予算と照合します。予算を超える可能性がある場合は、呼び出しを行わずにキャンセルされます。

それでも、呼び出しのコストが最悪の場合の見積もりを上回ることはあるため、最終的に cost.totalUsd が budgetUsd を超える場合があります。generating 段階より前に予算によってキャンセルされると、タスクには回答が残りません。最悪の場合のコストは計画の見積もりを大きく上回ることが多いため、回答が必要な場合は、estimates.costUsd.max を大きく上回る上限を設定してください。topK が大きい場合は、さらに高くします。

予算によって停止したタスクは、stage が canceled になります。

Range: >= 0

limitsobject#

作成時に 1 回だけ、計画の見積もりと照合されます。見積もりがいずれかの上限を超えるタスクは 422 で拒否されます。limits を省略すると、このチェックは行われません。タスク実行中の支出を制限するには budgetUsd を使用してください。

見積もりが上限と等しい場合は通過します。これらの値は、リサーチタスクを計画の estimates をもとに決めてください。

Show child attributes

maxRetrievalStepsinteger#

estimates.retrievalSteps と照合されます。

Range: >= 1

maxScannedResourcesinteger#

estimates.scannedResources と照合されます。

Range: >= 1

maxToolCallsinteger#

estimates.toolCalls と照合されます。

Range: >= 1

timeoutMsinteger#

estimates.latencyMs.p95 と照合されます（ミリ秒）。

Range: >= 1

metadataobject#

タスクとともに保存され、metadata として返される自由形式のオブジェクトです。__knowledgeFs で始まるキーは予約されており、破棄されます。

作成のレスポンスが失われた場合にタスクを識別できるよう、client_request_id などの一意の値を含めてください。これはタスクを探す手がかりになります。再試行時に新しいタスクを作成せず、元のタスクを返すようにするには、Idempotency-Key を送信してください。

modeenum<string>#

検索の深度です。fast、deep、research のいずれかを指定します（検索の深度を参照）。省略すると、ナレッジベースのデフォルトの深度が使われます。これはナレッジベース設定を取得の retrieval.default_mode です。

Options:fastdeepresearchnull

querystringrequired#

質問です。空白のみではないクエリを指定してください。また、UTF-8 で 16,384 バイトまでに制限されます。

Length: max 16000Pattern: \S

topKinteger#

検索結果をマージしてリランクした後に残すチャンクの最大数です。明示的に指定する場合は 1〜50 の値にしてください。省略すると、ナレッジベースで公開されている トップ K 設定（最大 100）が使われます。値を大きくするとモデルに渡るコンテキストが増えますが、ノイズも増えます。値を小さくすると焦点は絞られますが、関連するチャンクを取りこぼすことがあります。

Range: 1–50

Responses

application/json

タスクが受け付けられました。stage は queued、mode は決定された深度、cost.totalUsd は 0 です。同じ Idempotency-Key とボディで再送信すると、元のタスクが現在の状態で返されます。

budget_usdnumber#

リクエストで指定された支出上限（USD）です。設定されていない場合は null です。

completed_atnumber#

タスクが completed、failed、canceled のいずれかに達した日時（エポックミリ秒）です。タスクの実行中は null です。

costobject#

これまでに記録された支出です。

Show child attributes

budgetExceededboolean#

支出が budgetUsd を超え、それを理由にタスクがキャンセルされた場合は true です。それ以外の場合は含まれません。

budgetUsdnumber#

リクエストの budgetUsd です。予算が設定されていない場合は含まれません。

entriesobject[]#

記録されたモデル呼び出しごとに 1 つのエントリが入り、古い順に並びます。

Show child attributes

costUsdnumber#

呼び出しのコスト（USD）です。

providerstring#

呼び出しを処理したモデルプロバイダーです。

recordedAtnumber#

コストが記録された日時（エポックミリ秒）です。

stepstring#

呼び出しを行ったステップで、pageindex.layer、pageindex.semantic、pageindex.whole-tree、research.judge、research.plan、graph.plan、query.answer、query.image-expand のいずれかです。

usageobject#

呼び出しのトークン使用量です。promptTokens、completionTokens、totalTokens、estimated、reserved、status（reserved、succeeded、failed のいずれか）、researchModelCallId を含みます。実行中の呼び出しの予約もエントリとして記録され、totalUsd に計上されます。

totalUsdnumber#

entries[].costUsd の合計（USD）です。最初のモデル呼び出しが記録されるまでは 0 です。

created_atnumber#

タスクの作成日時（エポックミリ秒）です。

errorstring#

失敗コードで、failure.code と同じ値です。stage が failed の場合にのみ設定され、それ以外の場合は、キャンセルされたタスクも含めて null です。

失敗したリサーチタスクでは、failure.code は RESEARCH_TASK_CAPABILITY_REVOKED、RESEARCH_TASK_DISPATCH_DEAD、RESEARCH_TASK_EXECUTION_ATTEMPTS_EXHAUSTED、RESEARCH_TASK_FAILED、RESEARCH_TASK_PERMISSION_SNAPSHOT_INVALID、RESEARCH_TASK_RUNTIME_SNAPSHOT_INVALID のいずれかです。

failureobject#

エラー詳細です。stage が failed の場合にのみ設定され、それ以外の場合は null です。ここでは、値のないメンバーは null になります。traceId はタスク ID です。

action が retry の場合は、リサーチタスクを作成で新しいタスクを作成してください。

Show child attributes

actionstring#

推奨される次の対応です。ある場合は configure_model、configure_parser、configure_source、contact_admin、reupload、retry のいずれかです。該当しない場合は null です。

categorystring#

失敗の種類で、authorization、canceled、configuration、conflict、dependency、internal、not_found、rate_limit、timeout、validation のいずれかです。

codestring#

リサーチタスクの失敗コードで、このタスクの error と一致します。

messagestring#

タスクの失敗に対する公開用メッセージです。プロバイダーのエラー詳細は公開されません。

parametersobject#

失敗の内容を補足する最大 8 個の値です。キーは attempt、currentRowVersion、documentCount、expectedRowVersion、fileSizeBytes、limit、maxFileSizeBytes、maxItems、modelType、providerKind、retryAfterSeconds、status のいずれかです。値がない場合は null です。

retryPolicystring#

再試行で解決できるかどうかです。automatic（サービスが自動で再試行）、manual（呼び出し側で再試行）、after_configuration（先に Dify でナレッジベースの設定を修正）、never（リクエストを変更）のいずれかです。

stagestring#

常に research です。

traceIdstring#

リサーチタスク ID です。管理者に問い合わせる際に伝えてください。

idstring#

リサーチタスク ID です。タスクに対する各操作で research_task_id として使用します。

knowledge_space_idstring#

ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。

limitsobject#

リクエストで指定された制限で、キーはスネークケースです。リクエストに limits が含まれていなかった場合は null です。送信されなかったメンバーは null になります。リサーチタスクを作成に再度送信する前に、キーをキャメルケースに戻してください。

Show child attributes

max_retrieval_stepsinteger#

リクエストの limits.maxRetrievalSteps の値です。

max_scanned_resourcesinteger#

リクエストの limits.maxScannedResources の値です。

max_tool_callsinteger#

リクエストの limits.maxToolCalls の値です。

timeout_msinteger#

リクエストの limits.timeoutMs の値です。

metadataobject#

作成時に送信された metadata オブジェクトです。__knowledgeFs で始まるキーは除かれます。

modestring#

タスクの検索の深度で、fast、deep、research のいずれかです。

querystring#

保存されたとおりのリサーチの質問です。

query_imagesobject[]#

元のクエリで使用された画像です。テキストのみのクエリでは省略されます。

Show child attributes

byte_sizeinteger#

この API では常に null です。

Range: >= 0

mime_typestring#

この API では常に null です。

namestring#

この API では常に null です。

preview_urlstring#

この API では常に null です。

upload_file_idstringrequired#

元のクエリで使用された画像ファイルの ID です。

stagestring#

ライフサイクル上でのタスクの現在位置です。タスクは 1 段階ずつ進みます：

queued：受け付け済みで、ワーカーを待っています。
planning：検索計画を決定しています。
retrieving：ナレッジベースを検索しています。検索のチェックポイントが書き込まれることがあります。
analyzing：検索されたチャンクを読み、評価しています。
generating：回答を作成しています。最終結果はこの段階で書き込まれます。
completed：完了しました。結果はリサーチタスクの結果一覧を取得で取得します。
failed：エラーで停止しました。error と failure を参照してください。
canceled：リサーチタスクをキャンセルまたは予算によって停止しました。
paused：タスクは一時停止中です。失敗の詳細をデプロイ環境の運用担当者に確認するか、タスクをキャンセルしてください。

completed、failed、canceled は最終状態です。

top_kinteger#

検索結果をマージしてリランクした後に残すチャンクの最大数です。リクエストの topK、または省略時はナレッジベースの トップ K の値です。

updated_atnumber#

タスクレコードの最終更新日時（エポックミリ秒）です。内部のチェックポイントや再試行のスケジュール設定による更新も含みます。

リサーチタスク一覧を取得リサーチタスクを計画