获取删除批次

返回一次批量删除文档文件请求，包括每个文件的处理结果，以及每个已受理文件的删除作业当前状态。只有发送该批次的 API 密钥能读取它。

当 results 中的每个条目都为 rejected，或其 job.run_state 为 completed 或 failed 时，该批次即告完成。读取批次不会推进处于 pending 的文件。仍处于 pending 的文件，是批次中途停止时尚未受理的文件。如需重试这些文件，使用同一个 Idempotency-Key 再次发送原请求。

删除流程详见删除文档和数据源。

1 min read

get/knowledge-fs/spaces/{knowledge_base_id}/deletion-batches/{deletion_batch_id}

Request example

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

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/deletion-batches/{deletion_batch_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}/deletion-batches/{deletion_batch_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}/deletion-batches/{deletion_batch_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}/deletion-batches/{deletion_batch_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}/deletion-batches/{deletion_batch_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}/deletion-batches/{deletion_batch_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

{
  "batch_id": "3e5a7c9b-1d2f-4a6b-8c0d-2e4f6a8b0c1d",
  "items": [
    {
      "document_id": "2c1e7a44-5b6d-4e8f-9a0b-1c2d3e4f5a6b",
      "document_title": null,
      "job": {
        "checkpoint": "completed",
        "completed_at": "2026-10-20T09:00:09Z",
        "created_at": "2026-10-20T09:00:00Z",
        "error": null,
        "id": "b7e1c2d3-4f5a-4b6c-8d9e-0f1a2b3c4d5e",
        "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
        "mode": "cascade",
        "progress": null,
        "retry_at": null,
        "run_state": "completed",
        "target_id": "2c1e7a44-5b6d-4e8f-9a0b-1c2d3e4f5a6b",
        "target_type": "document",
        "updated_at": "2026-10-20T09:00:09Z"
      },
      "status_url": "https://api.example.com/v1/knowledge-fs/spaces/8d2c6a1e-5b3f-4c7d-9e01-2a3b4c5d6e7f/deletion-jobs/b7e1c2d3-4f5a-4b6c-8d9e-0f1a2b3c4d5e"
    },
    {
      "document_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
      "document_title": null,
      "job": {
        "checkpoint": "deleting_derived_data",
        "completed_at": null,
        "created_at": "2026-10-20T09:00:00Z",
        "error": null,
        "id": "0c9d8e7f-6a5b-4c3d-9e2f-1a0b9c8d7e6f",
        "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
        "mode": "cascade",
        "progress": null,
        "retry_at": null,
        "run_state": "running",
        "target_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
        "target_type": "document",
        "updated_at": "2026-10-20T09:00:04Z"
      },
      "status_url": "https://api.example.com/v1/knowledge-fs/spaces/8d2c6a1e-5b3f-4c7d-9e01-2a3b4c5d6e7f/deletion-jobs/0c9d8e7f-6a5b-4c3d-9e2f-1a0b9c8d7e6f"
    }
  ],
  "results": [
    {
      "document_id": "2c1e7a44-5b6d-4e8f-9a0b-1c2d3e4f5a6b",
      "error": null,
      "job": {
        "checkpoint": "completed",
        "completed_at": "2026-10-20T09:00:09Z",
        "created_at": "2026-10-20T09:00:00Z",
        "error": null,
        "id": "b7e1c2d3-4f5a-4b6c-8d9e-0f1a2b3c4d5e",
        "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
        "mode": "cascade",
        "progress": null,
        "retry_at": null,
        "run_state": "completed",
        "target_id": "2c1e7a44-5b6d-4e8f-9a0b-1c2d3e4f5a6b",
        "target_type": "document",
        "updated_at": "2026-10-20T09:00:09Z"
      },
      "status": "accepted",
      "status_url": "https://api.example.com/v1/knowledge-fs/spaces/8d2c6a1e-5b3f-4c7d-9e01-2a3b4c5d6e7f/deletion-jobs/b7e1c2d3-4f5a-4b6c-8d9e-0f1a2b3c4d5e"
    },
    {
      "document_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
      "error": null,
      "job": {
        "checkpoint": "deleting_derived_data",
        "completed_at": null,
        "created_at": "2026-10-20T09:00:00Z",
        "error": null,
        "id": "0c9d8e7f-6a5b-4c3d-9e2f-1a0b9c8d7e6f",
        "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
        "mode": "cascade",
        "progress": null,
        "retry_at": null,
        "run_state": "running",
        "target_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
        "target_type": "document",
        "updated_at": "2026-10-20T09:00:04Z"
      },
      "status": "accepted",
      "status_url": "https://api.example.com/v1/knowledge-fs/spaces/8d2c6a1e-5b3f-4c7d-9e01-2a3b4c5d6e7f/deletion-jobs/0c9d8e7f-6a5b-4c3d-9e2f-1a0b9c8d7e6f"
    },
    {
      "document_id": "9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a",
      "error": {
        "code": "DURABLE_DELETION_NOT_FOUND",
        "message": "Deletion request was rejected",
        "retryable": false
      },
      "job": null,
      "status": "rejected",
      "status_url": null
    }
  ],
  "status_url": "https://api.example.com/v1/knowledge-fs/spaces/8d2c6a1e-5b3f-4c7d-9e01-2a3b4c5d6e7f/deletion-batches/3e5a7c9b-1d2f-4a6b-8c0d-2e4f6a8b0c1d",
  "total": 3
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400
}

{
  "code": "knowledge_fs_invalid_request",
  "failure": {
    "category": "validation",
    "code": "KNOWLEDGE_FS_INVALID_REQUEST",
    "message": "The Agent Knowledge Base request is invalid.",
    "retryPolicy": "never",
    "traceId": "7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"
  },
  "message": "The 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_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": "7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"
  },
  "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",
  "failure": {
    "action": "contact_admin",
    "category": "internal",
    "code": "KNOWLEDGE_FS_INTERNAL_ERROR",
    "message": "Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "message": "Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.",
  "status": 502
}

{
  "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}/deletion-batches/{deletion_batch_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/ 之后的那一段。

deletion_batch_idstringrequired#

删除批次 ID：即批量删除文档文件返回的 batch_id。该响应中的 status_url 指向此接口。

Responses

application/json

删除批次，附带每个已受理文件的删除作业当前状态。

batch_idstring#

记录本次请求的批次 ID。

itemsobject[]#

每个已受理的文件对应一项。

Show child attributes

document_idstring#

文档文件 ID。

document_titlestring#

删除文档文件时始终为 null。

jobobject#

Show child attributes

checkpointstring#

删除进行到哪一步：从 requested（刚受理）开始，依次经过 quiescing、deleting_objects、deleting_derived_data、deleting_primary_data，直到 completed。

completed_atstring#

作业完成时间，ISO 8601 格式。完成前以及作业为 failed 时为 null。

created_atstring#

作业的受理时间，ISO 8601 格式。

errorobject#

最近一次错误，没有错误时为 null。run_state 为 retry_wait 时也会设置此字段，因此判断作业是否失败应看 run_state，而不是 error。

Show child attributes

codestring#

最近一次错误的错误码。

messagestring#

最近一次错误的公开消息，不含内部错误详情。

retryableboolean#

run_state 为 failed 时为 true。此 API 无法重试失败的删除。

idstring#

删除作业 ID。

knowledge_space_idstring#

知识库的内部 ID，并非路径中的知识库 ID。

modestring#

删除数据源时如何处理其文档：cascade 一并删除，keep 保留。删除文档文件或文档时，忽略该值。

progressobject#

多项删除的项数统计。此 API 不填充该字段，始终为 null。

Show child attributes

completed_itemsinteger#

已删除的项数。

current_item_kindstring#

正在删除的项的类型。

total_itemsinteger#

待删除的项数。

retry_atstring#

下次自动重试的时间，ISO 8601 格式。未安排重试时为 null。

run_statestring#

调度状态：

dispatch_pending（刚受理）、queued、running：进行中。
retry_wait：已安排在 retry_at 自动重试。
completed：已全部移除。
failed：清理已停止，删除目标仍保持隐藏，且无法重试。

target_idstring#

删除目标的 ID：document 时为文档文件 ID，logical_document 时为文档 ID，source 时为数据源 ID。

target_typestring#

作业删除的对象：document 表示文档文件，logical_document 表示整个文档，source 表示数据源。

updated_atstring#

作业最后变更时间，ISO 8601 格式。

status_urlstring#

该文件对应作业的获取删除作业 URL。

resultsobject[]#

请求中的每个文件对应一项，包含其处理结果。

Show child attributes

document_idstring#

文档文件 ID。

errorobject#

拒绝该文件的原因。其他情况下为 null。

Show child attributes

codestring#

错误码：DURABLE_DELETION_NOT_FOUND、DURABLE_DELETION_REVISION_CONFLICT、DURABLE_DELETION_STATE_CONFLICT 或 DURABLE_DELETION_FORBIDDEN。

messagestring#

始终为 Deletion request was rejected。

retryableboolean#

始终为 false。

jobobject#

status 为 accepted 时的删除作业，否则为 null。

Show child attributes

checkpointstring#

删除进行到哪一步：从 requested（刚受理）开始，依次经过 quiescing、deleting_objects、deleting_derived_data、deleting_primary_data，直到 completed。

completed_atstring#

作业完成时间，ISO 8601 格式。完成前以及作业为 failed 时为 null。

created_atstring#

作业的受理时间，ISO 8601 格式。

errorobject#

最近一次错误，没有错误时为 null。run_state 为 retry_wait 时也会设置此字段，因此判断作业是否失败应看 run_state，而不是 error。

Show child attributes

codestring#

最近一次错误的错误码。

messagestring#

最近一次错误的公开消息，不含内部错误详情。

retryableboolean#

run_state 为 failed 时为 true。此 API 无法重试失败的删除。

idstring#

删除作业 ID。

knowledge_space_idstring#

知识库的内部 ID，并非路径中的知识库 ID。

modestring#

删除数据源时如何处理其文档：cascade 一并删除，keep 保留。删除文档文件或文档时，忽略该值。

progressobject#

多项删除的项数统计。此 API 不填充该字段，始终为 null。

Show child attributes

completed_itemsinteger#

已删除的项数。

current_item_kindstring#

正在删除的项的类型。

total_itemsinteger#

待删除的项数。

retry_atstring#

下次自动重试的时间，ISO 8601 格式。未安排重试时为 null。

run_statestring#

调度状态：

dispatch_pending（刚受理）、queued、running：进行中。
retry_wait：已安排在 retry_at 自动重试。
completed：已全部移除。
failed：清理已停止，删除目标仍保持隐藏，且无法重试。

target_idstring#

删除目标的 ID：document 时为文档文件 ID，logical_document 时为文档 ID，source 时为数据源 ID。

target_typestring#

作业删除的对象：document 表示文档文件，logical_document 表示整个文档，source 表示数据源。

updated_atstring#

作业最后变更时间，ISO 8601 格式。

statusstring#

accepted：删除请求已受理，job 和 status_url 有值。
rejected：未删除该文件，原因见 error。
pending：尚未受理该文件。如需重试，使用同一个 Idempotency-Key 再次发送原请求。

status_urlstring#

该文件对应作业的获取删除作业 URL。仅当 status 为 accepted 时有值，否则为 null。

status_urlstring#

此批次的获取删除批次 URL：部署设置了 SERVICE_API_URL 时为绝对 URL，否则为以 /v1/ 开头的路径。批量删除文档文件也会在 Location 响应头中返回该值。

totalinteger#

原请求中的文件数。

获取删除作业获取数据源连接列表