获取批量任务

返回批量任务中各索引任务的进度。在此 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 Key 认证：Authorization: Bearer {API_KEY}。应用接口使用应用 API Key，知识库接口使用知识库 API Key（快速开始）。

API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 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。获取后台任务列表也会返回该 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。它们不是索引任务 ID。可借助你从该响应中保留的 items 条目，将它们对应到具体任务。

failed_itemsinteger#

任务失败的条目数。

failuresobject[]#

每个失败条目对应一项。没有失败时为空。

Show child attributes

document_idstring#

该条目的 ID，即提交给重新索引文档时的 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：至少有一个条目仍在进行中。
completed：每个条目都已完成（至少到达 projection_built，该阶段在 published 之前）或被报告为 not_found。
failed：每个条目都已进入终态，且至少有一个失败。
canceled：每个条目都已进入终态，没有失败，且至少有一个被取消。

completed 不能保证新的修订版本已经生效。如果这一点很重要，用你从重新索引文档保留的任务 ID，通过获取索引任务逐个检查任务是否为 stage: published。

total_itemsinteger#

提交的条目数。

typestring#

来自此 API 的批量任务为 document_reindex。document_upload 和 document_delete 只会由 Dify 中的操作产生。通过此 API 删除时，返回的是删除作业，而不是批量任务：通过获取删除作业或获取删除批次跟踪。

updated_atstring#

批量任务及其索引任务中最近一次变更的时间，ISO 8601 格式。

重试索引任务获取文档的索引任务列表