リサーチタスクを取得

リサーチタスクの現在の状態を返します。stage、これまでのコスト、上限、タイムスタンプ、および失敗した場合のエラー詳細を含みます。

stage が completed、failed、canceled のいずれかになるまでポーリングしてください。回答はこのオブジェクトには含まれません。計画、作成、ポーリング、結果の読み取りの流れについては、リサーチタスクの実行を参照してください。

1 min read

get/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}

Request example

curl --request GET \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}"
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

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/{research_task_id}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
  ],
]);

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

echo $response;

package main

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

func main() {
	url := "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}"

	req, _ := http.NewRequest("GET", url, nil)
	req.Header.Add("Authorization", "Bearer <token>")

	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/{research_task_id}"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .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/{research_task_id}')

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

request = Net::HTTP::Get.new(url)
request['Authorization'] = 'Bearer <token>'

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

Response

{
  "budget_usd": 0.01,
  "completed_at": 1788681618000,
  "cost": {
    "budgetExceeded": true,
    "budgetUsd": 0.01,
    "entries": [
      {
        "costUsd": 0.0011,
        "provider": "openai",
        "recordedAt": 1788681603000,
        "step": "research.plan",
        "usage": {
          "completionTokens": 58,
          "estimated": false,
          "promptTokens": 310,
          "researchModelCallId": "attempt:1:call-4",
          "reserved": false,
          "status": "succeeded",
          "totalTokens": 368
        }
      },
      {
        "costUsd": 0.0096,
        "provider": "openai",
        "recordedAt": 1788681618000,
        "step": "research.judge",
        "usage": {
          "completionTokens": 190,
          "estimated": false,
          "promptTokens": 2640,
          "researchModelCallId": "attempt:1:call-5",
          "reserved": false,
          "status": "succeeded",
          "totalTokens": 2830
        }
      }
    ],
    "totalUsd": 0.0107
  },
  "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": "canceled",
  "top_k": 10,
  "updated_at": 1788681618000
}

{
  "budget_usd": 1.5,
  "completed_at": null,
  "cost": {
    "budgetUsd": 1.5,
    "entries": [
      {
        "costUsd": 0.0011,
        "provider": "openai",
        "recordedAt": 1788681603000,
        "step": "research.plan",
        "usage": {
          "completionTokens": 58,
          "estimated": false,
          "promptTokens": 310,
          "researchModelCallId": "attempt:1:call-6",
          "reserved": false,
          "status": "succeeded",
          "totalTokens": 368
        }
      }
    ],
    "totalUsd": 0.0011
  },
  "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": "retrieving",
  "top_k": 10,
  "updated_at": 1788681610000
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "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_access_denied",
  "failure": {
    "action": "contact_admin",
    "category": "authorization",
    "code": "KNOWLEDGE_FS_ACCESS_DENIED",
    "message": "You do not have permission to perform this Agent Knowledge Base operation.",
    "retryPolicy": "never",
    "traceId": "2a4d92fd-f0a6-4a39-abca-8944fc1b87b5"
  },
  "message": "You do not have permission to perform this Agent Knowledge Base operation.",
  "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": "e533c301-cd9c-48b7-a546-3bdce751dc31"
  },
  "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_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
}

get/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}

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/ の後のセグメントです。

research_task_idstringrequired#

リサーチタスク ID です。リサーチタスクを作成から取得します。

Responses

application/json

リサーチタスクです。

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#

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

リサーチタスクを計画リサーチタスクをキャンセル