一括タスクを取得
一括タスクに含まれるインデックスタスクの進捗を返します。この API では、一括タスクは ドキュメントを再インデックス から作成され、それを開始した API キーでのみ読み取れます。
ドキュメントを再インデックス が not_found と報告した項目は、完了として数えられます。そのため、どのドキュメントも再インデックスされていなくても、completed_items が total_items と等しくなることがあります。これに気付くには、total_items と、そのレスポンス内の queued 項目の数を比較してください。再インデックスの流れについては、再インデックスとインデックス処理の追跡 を参照してください。
curl --request GET \
--url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/bulk-jobs/{bulk_task_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/bulk-jobs/{bulk_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}/bulk-jobs/{bulk_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}/bulk-jobs/{bulk_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}/bulk-jobs/{bulk_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}/bulk-jobs/{bulk_task_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/bulk-jobs/{bulk_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{
"canceled_items": 0,
"completed_items": 1,
"created_at": "2026-09-06T02:30:00Z",
"failed_item_ids": [],
"failed_items": 0,
"failures": [],
"id": "c7d9e1f3-5a7b-4c9d-8e0f-1a2b3c4d5e6f",
"knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
"status": "running",
"total_items": 2,
"type": "document_reindex",
"updated_at": "2026-09-06T02:31:12Z"
}Authorizations
すべてのリクエストは、Authorization: Bearer {API_KEY} ヘッダーに指定した API キーで認証します。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーがない、または無効な場合は HTTP 401(unauthorized)が返ります。
Path Parameters
一括タスク ID です。ドキュメントを再インデックス のレスポンスの bulk_job_id です。バックグラウンドタスク一覧を取得 でも、document_bulk タスクの id として返されます。ドキュメントを削除 による document_delete タスクの id は削除ジョブ ID です。削除ジョブを取得 で追跡してください。
Response
一括タスクです。
失敗した項目の ID(ドキュメントを再インデックス に送信したままの値)です。インデックスタスク ID ではありません。タスクとの対応付けには、そのレスポンスから保存しておいた items のエントリを使用してください。
全体の状態:
running:少なくとも 1 つの項目がまだ処理中です。completed:すべての項目が完了した(publishedの手前の段階であるprojection_built以上に到達した)か、not_foundと報告されました。failed:すべての項目が最終状態で、少なくとも 1 つが失敗しました。canceled:すべての項目が最終状態で、失敗はなく、少なくとも 1 つがキャンセルされました。
completed でも、新しいリビジョンがすでにアクティブになっているとは限りません。それが重要な場合は、インデックスタスクを取得 で各タスクが stage: published になっているかを確認してください。その際は、ドキュメントを再インデックス から保存しておいたタスク ID を使います。
Was this page helpful?
curl --request GET \
--url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/bulk-jobs/{bulk_task_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/bulk-jobs/{bulk_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}/bulk-jobs/{bulk_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}/bulk-jobs/{bulk_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}/bulk-jobs/{bulk_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}/bulk-jobs/{bulk_task_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/bulk-jobs/{bulk_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{
"canceled_items": 0,
"completed_items": 1,
"created_at": "2026-09-06T02:30:00Z",
"failed_item_ids": [],
"failed_items": 0,
"failures": [],
"id": "c7d9e1f3-5a7b-4c9d-8e0f-1a2b3c4d5e6f",
"knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
"status": "running",
"total_items": 2,
"type": "document_reindex",
"updated_at": "2026-09-06T02:31:12Z"
}