重新索引文档

为每个选中的文档排入一个索引任务，根据其当前文件重建索引。返回一个批量任务 ID，用于统一跟踪这些任务。

all: true 和 documentIds 必须且只能提供其中一个。

不会重新上传任何文件。用 compilation_job.id 通过获取索引任务跟踪单个任务，通过获取批量任务跟踪整个请求。

1 min read

post/knowledge-fs/spaces/{knowledge_base_id}/documents/reindex

Request example

curl --request POST \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/reindex \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <string>' \
  --header 'Content-Type: application/json' \
  --data '{
  "all": true
}'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/reindex"
headers = {
    "Authorization": "Bearer <token>",
    "Idempotency-Key": "<string>",
    "Content-Type": "application/json",
}
payload = {
    "all": True
}

response = requests.request("POST", url, headers=headers, json=payload)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/reindex', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Idempotency-Key': '<string>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "all": true
  })
});

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}/documents/reindex',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
  "all": true
}',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
    'Idempotency-Key: <string>',
    'Content-Type: application/json',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	url := "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/reindex"
	payload := strings.NewReader("{\n  \"all\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Idempotency-Key", "<string>")
	req.Header.Add("Content-Type", "application/json")

	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}/documents/reindex"))
    .header("Authorization", "Bearer <token>")
    .header("Idempotency-Key", "<string>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"all\": true\n}"))
    .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}/documents/reindex')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

request = Net::HTTP::Post.new(url)
request['Authorization'] = 'Bearer <token>'
request['Idempotency-Key'] = '<string>'
request['Content-Type'] = 'application/json'
request.body = '{
  "all": true
}'

response = http.request(request)
puts response.read_body

Response

{
  "bulk_job_id": "5a1c2e3d-7b8f-4a9c-8d1e-2f3a4b5c6d7e",
  "items": [
    {
      "asset": {
        "created_at": "2026-09-03T10:02:11Z",
        "filename": "handbook.pdf",
        "id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
        "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
        "metadata": {},
        "mime_type": "application/pdf",
        "object_key": "1a7c9e40-2b3d-4f56-8a90-b1c2d3e4f506/spaces/9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b/documents/6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b/handbook.pdf",
        "parser_status": "parsed",
        "sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
        "size_bytes": 482113,
        "source_id": null,
        "updated_at": null,
        "version": 1
      },
      "code": null,
      "compilation_job": {
        "id": "e4a1f0b2-7c3d-4e5f-9a1b-2c3d4e5f6a7b",
        "stage": "queued"
      },
      "document_id": null,
      "error": null,
      "status": "queued",
      "status_url": "/knowledge-spaces/9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b/documents/3d2f1c0b-9a8e-4d7c-b6a5-4f3e2d1c0b9a/processing-tasks/e4a1f0b2-7c3d-4e5f-9a1b-2c3d4e5f6a7b"
    },
    {
      "asset": null,
      "code": null,
      "compilation_job": null,
      "document_id": "8f14e45f-ceea-467a-9575-62c9a2d3e6b1",
      "error": null,
      "status": "not_found",
      "status_url": null
    }
  ],
  "total": 2
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400,
  "violations": [
    {
      "field": [
        "documentIds"
      ],
      "type": "too_long"
    }
  ]
}

{
  "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_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": "7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"
  },
  "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": "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_conflict",
  "failure": {
    "action": "retry",
    "category": "conflict",
    "code": "KNOWLEDGE_FS_CONFLICT",
    "message": "The Agent Knowledge Base operation conflicts with the current resource state.",
    "retryPolicy": "manual",
    "traceId": "7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"
  },
  "message": "The Agent Knowledge Base operation conflicts with the current resource state.",
  "status": 409
}

{
  "code": "knowledge_fs_request_too_large",
  "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": 413
}

{
  "code": "knowledge_fs_request_too_large",
  "message": "Agent Knowledge Base request is too large.",
  "status": 413
}

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

post/knowledge-fs/spaces/{knowledge_base_id}/documents/reindex

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/ 之后的那一段。

Headers

Idempotency-Keystring#

每次调用都应发送幂等键，这样重试才安全。使用 8～255 个可打印 ASCII 字符，首尾不得有空白；格式不正确的键返回 400。

重复发送相同的键和请求体，会返回原批量任务，不会启动新的索引任务。以不同的请求体、通过其他 API 密钥、在其他知识库中或为其他操作复用该键，会返回 409。

Length: 8–255

Body

application/json

One of

allenum<boolean>required#

Options:true

documentIdsenum<array>#

Options:null

allenum<boolean>#

Options:falsenull

documentIdsany[]required#

Items: min 1

Responses

application/json

索引任务已排入队列。

bulk_job_idstring#

批量任务 ID。通过获取批量任务轮询。

itemsobject[]#

发送的每个不同 ID 对应一个条目，按请求顺序排列；all 为 true 时，其后是每个选中文件对应的条目。解析为同一文档文件的多个 ID 共用一个条目。

Show child attributes

assetobject#

正在重新索引的文档文件。仅当 status 为 queued 时有值，否则为 null。

Show child attributes

created_atstring#

文件存储时间，ISO 8601 格式。

filenamestring#

原始文件名。

idstring#

文档文件 ID。与在 Dify 中打开文档时地址栏里的文档 ID 不同。

knowledge_space_idstring#

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

metadataobject#

上传或导入文件时随文件记录的元数据。

mime_typestring#

文件的 MIME 类型。

object_keystring#

文件在对象存储中的键。此 API 中没有返回文件内容的操作。

parser_statusstring#

该版本文件的解析状态：pending、parsed 或 failed。解析是索引的一个步骤。parsed 的文件也可能没有大纲和分段。

sha256string#

文件内容的 SHA-256 哈希值，十六进制编码。

size_bytesinteger#

文件大小，单位为字节。

source_idstring#

文件导入来源的数据源 ID。上传的文件为 null。

updated_atstring#

文件记录最后变更时间，ISO 8601 格式。创建后未变更时为 null。

versioninteger#

对此文件 ID 始终为 1。内容更新（包括数据源同步）会生成新的文件 ID，而不会递增此值。此值与文档内容的修订版本相互独立。调用删除文档文件时将其作为 expectedRevision 传入。

codestring#

status 为 failed 时的失败代码，否则为 null。

compilation_jobobject#

索引任务。仅当 status 为 queued 时有值，否则为 null。

Show child attributes

idstring#

索引任务 ID。通过获取索引任务轮询。

stagestring#

此时始终为 queued。

document_idstring#

请求中发送的 ID；对于通过 all: true 选中的条目，则为文档文件 ID。status 为 disabled、not_found、failed 或 pending 时有值。queued 条目为 null，其文档文件 ID 见 asset.id。

errorstring#

status 为 failed 时的失败信息，否则为 null。

statusstring#

queued：已启动索引任务，asset、compilation_job 和 status_url 均有值。
disabled：文档已禁用，因此没有排入任务，批量任务将其计为已取消。此 API 中没有可启用文档的操作。
not_found：没有与该 ID 匹配的可读文档文件。
failed：未启动索引任务，原因见 code 和 error。
pending：无法确认是否已启动索引任务。

status_urlstring#

任务的内部路径，仅供参考。跟踪任务应改用获取批量任务。仅当 status 为 queued 时有值，否则为 null。

totalinteger#

items 中的条目数。

批量删除文档文件获取索引任务