リサーチタスクを取得
リサーチタスクの現在の状態を返します。stage、これまでのコスト、上限、タイムスタンプ、および失敗した場合のエラー詳細を含みます。
stage が completed、failed、canceled のいずれかになるまでポーリングしてください。回答はこのオブジェクトには含まれません。計画、作成、ポーリング、結果の読み取りの流れについては、リサーチタスクの実行 を参照してください。
curl --request GET \
--url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{api_base_url}/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))
}HttpResponse<String> response = Unirest.get("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
}Authorizations
すべてのリクエストは API キーで認証します：Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401（unauthorized）で失敗します。
Path Parameters
ナレッジベース ID です。ナレッジベースの API アクセス ダイアログに表示されるサービス API エンドポイントの最後のセグメント（…/knowledge-fs/spaces/<knowledge base ID>）です。アドレスバーでは /datasets/new/ の後のセグメントです。
リサーチタスク ID です。リサーチタスクを作成 から取得します。
Response
リサーチタスクです。
リクエストで指定された支出上限（USD）です。設定されていない場合は null です。
タスクが completed、failed、canceled のいずれかに達した日時（エポックミリ秒）です。タスクの実行中は null です。
これまでに記録された支出です。
Show child attributes
Show child attributes
タスクの作成日時（エポックミリ秒）です。
失敗コードで、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 のいずれかです。
エラー詳細です。stage が failed の場合にのみ設定され、それ以外の場合は null です。ここでは、値のないメンバーは null になります。traceId はタスク ID です。
action が retry の場合は、リサーチタスクを作成 で新しいタスクを作成してください。
Show child attributes
Show child attributes
リサーチタスク ID です。タスクに対する各操作で research_task_id として使用します。
ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。
リクエストで指定された制限で、キーはスネークケースです。リクエストに limits が含まれていなかった場合は null です。送信されなかったメンバーは null になります。リサーチタスクを作成 に再度送信する前に、キーをキャメルケースに戻してください。
Show child attributes
Show child attributes
作成時に送信された metadata オブジェクトです。__knowledgeFs で始まるキーは除かれます。
タスクの検索の深度で、fast、deep、research のいずれかです。
保存されたとおりのリサーチの質問です。
元のクエリで使用された画像です。テキストのみのクエリでは省略されます。
Show child attributes
Show child attributes
ライフサイクル上でのタスクの現在位置です。タスクは 1 段階ずつ進みます：
queued：受け付け済みで、ワーカーを待っています。planning：検索計画を決定しています。retrieving：ナレッジベースを検索しています。検索のチェックポイントが書き込まれることがあります。analyzing：検索されたチャンクを読み、評価しています。generating：回答を作成しています。最終結果はこの段階で書き込まれます。completed：完了しました。結果は リサーチタスクの結果一覧を取得 で取得します。failed：エラーで停止しました。errorとfailureを参照してください。canceled：リサーチタスクをキャンセル または予算によって停止しました。paused：タスクは一時停止中です。失敗の詳細をデプロイ環境の運用担当者に確認するか、タスクをキャンセルしてください。
completed、failed、canceled は最終状態です。
検索結果をマージしてリランクした後に残すチャンクの最大数です。リクエストの topK、または省略時はナレッジベースの トップ K の値です。
タスクレコードの最終更新日時（エポックミリ秒）です。内部のチェックポイントや再試行のスケジュール設定による更新も含みます。
Was this page helpful?
curl --request GET \
--url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{api_base_url}/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))
}HttpResponse<String> response = Unirest.get("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
}