インデックスタスク

一括タスクを取得

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

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

GET

knowledge-fs

spaces

{knowledge_base_id}

bulk-jobs

{bulk_task_id}

一括タスクを取得

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))

}

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

string

header

required

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

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

Path Parameters

knowledge_base_id

string<uuid>

required

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

bulk_task_id

string<uuid>

required

一括タスク ID です。ドキュメントを再インデックスのレスポンスの bulk_job_id です。バックグラウンドタスク一覧を取得でも、document_bulk タスクの id として返されます。

Response

一括タスクです。

canceled_items

integer

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

completed_items

integer

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

created_at

string

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

failed_item_ids

string[]

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

failed_items

integer

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

failures

object[]

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

Show child attributes

string

一括タスク ID です。

knowledge_space_id

string

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

status

string

全体の状態：

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

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

total_items

integer

送信された項目数です。

type

string

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

updated_at

string

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

一括タスクを取得

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))

}

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

ガイド

アプリ API

ナレッジ API

一括タスクを取得

Authorizations

Path Parameters

Response