一括タスクを取得

一括タスクに含まれるインデックスタスクの進捗を返します。この API では、一括タスクはドキュメントを再インデックスから作成され、それを開始した API キーでのみ読み取れます。

ドキュメントを再インデックスが not_found と報告した項目は、完了として数えられます。そのため、どのドキュメントも再インデックスされていなくても、completed_items が total_items と等しくなることがあります。これに気付くには、total_items と、そのレスポンス内の queued 項目の数を比較してください。再インデックスの流れについては、再インデックスとインデックス処理の追跡を参照してください。

1 min read

get/knowledge-fs/spaces/{knowledge_base_id}/bulk-jobs/{bulk_task_id}

Request example

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

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/bulk-jobs/{bulk_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}/bulk-jobs/{bulk_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}/bulk-jobs/{bulk_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}/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))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/bulk-jobs/{bulk_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}/bulk-jobs/{bulk_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

{
  "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"
}

{
  "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": "8f3a2c14-9d6b-4c07-b5a1-2e7d0c93f5b2"
  },
  "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": "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_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}/bulk-jobs/{bulk_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/ の後のセグメントです。

bulk_task_idstringrequired#

一括タスク ID です。ドキュメントを再インデックスのレスポンスの bulk_job_id です。バックグラウンドタスク一覧を取得でも、document_bulk タスクの id として返されます。ドキュメントを削除による document_delete タスクの id は削除ジョブ ID です。削除ジョブを取得で追跡してください。

Responses

application/json

一括タスクです。

canceled_itemsinteger#

タスクがキャンセルされた項目数です。再インデックスのリクエスト時に無効化されていたドキュメントも含みます。

completed_itemsinteger#

完了した項目、または not_found と報告された項目の数です。

created_atstring#

一括タスクが作成された日時（ISO 8601）です。

failed_item_idsstring[]#

失敗した項目の ID（ドキュメントを再インデックスに送信したままの値）です。インデックスタスク ID ではありません。タスクとの対応付けには、そのレスポンスから保存しておいた items のエントリを使用してください。

failed_itemsinteger#

タスクが失敗した項目数です。

failuresobject[]#

失敗した項目ごとに 1 つのエントリが入ります。失敗がない場合は空です。

Show child attributes

document_idstring#

項目の ID（ドキュメントを再インデックスに送信したままの値）です。

document_titlestring#

ドキュメントのタイトルです。不明な場合は null です。

error_codestring#

失敗コードです。

error_messagestring#

失敗メッセージです。

failureobject#

エラー詳細です。記録されていない場合は null です。

Show child attributes

actionstring#

推奨される次の対応です。ある場合は configure_model、configure_parser、configure_source、contact_admin、reupload、retry のいずれかです。該当しない場合は null で、HTTP エラーのボディでは省略されます。

categorystring#

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

codestring#

大文字のスネークケースで表される固定のエラーコードです（例：KNOWLEDGE_FS_CONFLICT、SOURCE_CREDENTIAL_TEST_FAILED）。

messagestring#

エラーコードまたは失敗の種類に対応する公開用メッセージです。プロバイダーのエラー詳細は公開されません。

parametersobject#

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

retryPolicystring#

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

stagestring#

失敗が発生した段階です（例：query_generation、credential-test）。該当しない場合は null で、HTTP エラーのボディでは省略されます。

traceIdstring#

管理者に問い合わせる際に伝える参照情報です。失敗の詳細を含む成功レスポンスでは null になることがあり、HTTP エラーのボディでは省略されることがあります。

job_idstring#

項目のジョブ ID です。記録されていない場合は null です。

idstring#

一括タスク ID です。

knowledge_space_idstring#

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

statusstring#

全体の状態：

running：少なくとも 1 つの項目がまだ処理中です。
completed：すべての項目が完了した（published の手前の段階である projection_built 以上に到達した）か、not_found と報告されました。
failed：すべての項目が最終状態で、少なくとも 1 つが失敗しました。
canceled：すべての項目が最終状態で、失敗はなく、少なくとも 1 つがキャンセルされました。

completed でも、新しいリビジョンがすでにアクティブになっているとは限りません。それが重要な場合は、インデックスタスクを取得で各タスクが stage: published になっているかを確認してください。その際は、ドキュメントを再インデックスから保存しておいたタスク ID を使います。

total_itemsinteger#

送信された項目数です。

typestring#

この API から作成された一括タスクでは document_reindex です。document_upload と document_delete は、Dify 上の操作からのみ発生します。この API による削除では、一括タスクではなく削除ジョブが返ります。削除ジョブは削除ジョブを取得または削除バッチを取得で追跡してください。

updated_atstring#

一括タスクとそのインデックスタスク全体での最終変更日時（ISO 8601）です。

インデックスタスクを再試行ドキュメントのインデックスタスク一覧を取得