获取文档列表

列出知识库中的文档，最早的在前，包括每个文档的状态、自定义元数据、生效的修订版本和最近一次索引任务。

已禁用的文档也会列出，并带有 enabled: false。正在删除的文档，以及文件或数据源正在删除的文档，都不会列出。

一页中的文档可能少于 limit 个，因此要沿 next_cursor 一直翻页，直到它为 null。

文档 ID 与文档文件 ID 的关系，详见浏览文档和分段。

1 min read

get/knowledge-fs/spaces/{knowledge_base_id}/logical-documents

Request example

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

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/logical-documents"
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}/logical-documents', {
  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}/logical-documents',
  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}/logical-documents"

	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}/logical-documents"))
    .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}/logical-documents')

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

{
  "data": [
    {
      "active": {
        "activated_at": "2026-10-20T08:16:05Z",
        "content_hash": "4f7c2d9a1b3e5f60718293a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4",
        "created_at": "2026-10-20T08:15:42Z",
        "document_asset_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
        "document_asset_version": 1,
        "document_id": "2f6b8d1a-7c3e-4a5b-9d0e-1f2a3b4c5d6e",
        "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
        "mime_type": "application/pdf",
        "revision": 2,
        "size_bytes": 482113,
        "state": "active"
      },
      "active_revision": 2,
      "created_at": "2026-09-03T10:02:11Z",
      "disabled_at": null,
      "disabled_by_subject_id": null,
      "enabled": true,
      "id": "2f6b8d1a-7c3e-4a5b-9d0e-1f2a3b4c5d6e",
      "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
      "latest_task": {
        "can_cancel": false,
        "can_retry": false,
        "completed_at": "2026-10-20T08:16:05Z",
        "created_at": "2026-10-20T08:15:42Z",
        "document_id": "2f6b8d1a-7c3e-4a5b-9d0e-1f2a3b4c5d6e",
        "document_revision": 2,
        "document_title": null,
        "error_code": null,
        "error_message": null,
        "failure": null,
        "failures": null,
        "id": "c4e8a2f6-1b3d-4e5f-8a9b-0c1d2e3f4a5b",
        "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
        "operation": "document_processing",
        "progress_completed": 1,
        "progress_failed": 0,
        "progress_percent": 100,
        "progress_total": 1,
        "semantic_enrichment": {
          "error_code": null,
          "error_message": null,
          "failure": null,
          "nodes_completed": 0,
          "nodes_total": null,
          "provider_calls": null,
          "provider_calls_maximum": null,
          "state": "disabled",
          "updated_at": null
        },
        "source_id": null,
        "source_title": null,
        "state": "completed",
        "task_kind": "document",
        "updated_at": "2026-10-20T08:16:05Z"
      },
      "provider_item_id": null,
      "row_version": 4,
      "source_id": null,
      "status": "ready",
      "title": "handbook.pdf",
      "updated_at": "2026-10-20T08:16:05Z",
      "user_metadata": {
        "owner": "support-team",
        "product_line": "billing",
        "review_date": "2026-12-01T00:00:00Z"
      }
    },
    {
      "active": {
        "activated_at": "2026-10-19T03:04:51Z",
        "content_hash": "9c1e5b7d3f2a4c6e8b0d1f3a5c7e9b2d4f6a8c0e1b3d5f7a9c2e4b6d8f0a1c3e",
        "created_at": "2026-10-19T03:04:12Z",
        "document_asset_id": "7d2e4f6a-8b0c-4d1e-9f3a-5b7c9d1e3f5a",
        "document_asset_version": 1,
        "document_id": "3a7e9c1b-5d2f-4e8a-9b0c-1d2e3f4a5b6c",
        "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
        "mime_type": "text/markdown",
        "revision": 1,
        "size_bytes": 18342,
        "state": "active"
      },
      "active_revision": 1,
      "created_at": "2026-10-19T03:04:12Z",
      "disabled_at": null,
      "disabled_by_subject_id": null,
      "enabled": true,
      "id": "3a7e9c1b-5d2f-4e8a-9b0c-1d2e3f4a5b6c",
      "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
      "latest_task": null,
      "provider_item_id": "5e0f9a6c2b8d4e1f7a3c9b5d1e7f3a9c5b1d7e3f9a5c1b7d3e9f5a1c7b3d9e5f",
      "row_version": 1,
      "source_id": "6f1c2b0e-3d0b-4a5e-9f4c-1c0e6a7b8d90",
      "status": "ready",
      "title": "Pricing | Docs site",
      "updated_at": "2026-10-19T03:04:51Z",
      "user_metadata": {}
    }
  ],
  "next_cursor": null
}

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

{
  "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": "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}/logical-documents

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

Query parameters

cursorstring#

游标，取自上一页的 next_cursor。

Length: 1–1000

limitinteger#

每页文档数。

Default: 50

Range: 1–100

Responses

application/json

一页文档。

dataobject[]#

一页文档，最早的在前。

Show child attributes

activeobject#

当前生效的修订版本，即知识库当前提供的内容。将其 revision 传给获取分段列表，将其 document_asset_id 传给获取文档文件。没有生效的修订版本时为 null。

Show child attributes

activated_atstring#

修订版本生效的时间，ISO 8601 格式。从未生效的修订版本为 null。

content_hashstring#

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

created_atstring#

修订版本创建时间，ISO 8601 格式。

document_asset_idstring#

此修订版本对应的文档文件 ID，可用于获取文档文件。

document_asset_versioninteger#

创建此修订版本时文档文件的 version。

document_idstring#

文档 ID，即获取文档中的 id。

knowledge_space_idstring#

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

mime_typestring#

文档文件的 MIME 类型。

revisioninteger#

修订版本号，从 1 开始。用作获取分段列表的路径参数 revision。

size_bytesinteger#

文档文件大小，单位为字节。

statestring#

修订版本正在索引时为 candidate，知识库当前提供的修订版本为 active，有更新的修订版本生效后为 superseded，索引失败时为 failed。

active_revisioninteger#

生效修订版本的编号。没有生效的修订版本时为 null。

created_atstring#

文档创建时间，ISO 8601 格式。

disabled_atstring#

在 Dify 中禁用该文档的时间，ISO 8601 格式。

disabled_by_subject_idstring#

禁用该文档的操作者的内部 ID。调用此 API 时无需使用。

enabledboolean#

在 Dify 中禁用文档后为 false。重新索引文档会跳过已禁用的文档。

idstring#

文档 ID。文档内容更新后保持不变。

knowledge_space_idstring#

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

latest_taskobject#

为该文档生成修订版本的最新索引任务（task_kind: document）。可用其 id 调用获取文档的索引任务跟踪该任务。没有索引任务时为 null，在更新文档元数据的响应中始终为 null。

Show child attributes

can_cancelboolean#

当前能否取消该任务。task_kind: document 的任务可用 id 调用取消索引任务取消。即使 can_cancel 为 true，此 API 也没有取消批量任务的操作。

can_retryboolean#

当前能否重试该任务。task_kind: document 的任务可用 id 调用重试索引任务重试。

completed_atstring#

任务结束时间，ISO 8601 格式。运行期间为 null。

created_atstring#

任务创建时间，ISO 8601 格式。

document_idstring#

索引任务的文档 ID。批量任务只有一个文档时才设置此字段。

document_revisioninteger#

索引任务构建的修订版本。

document_titlestring#

文档标题，仅当批量任务只有一个文档时设置。

error_codestring#

state 为 failed 时的错误码。

error_messagestring#

error_code 对应的错误消息，可能与 failure.message 不同。

failureobject#

state 为 failed 时的错误详情，否则为 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 错误响应体中可能不出现。

failuresobject[]#

批量任务中每个失败的文档对应一项。其他类型的任务为 null。

Show child attributes

document_idstring#

文档 ID。

document_titlestring#

文档标题。

error_codestring#

失败的错误码。

error_messagestring#

error_code 对应的错误消息。

failureobject#

Show child attributes

actionstring#

categorystring#

失败类别：authorization、canceled、configuration、conflict、dependency、internal、not_found、rate_limit、timeout 或 validation。

codestring#

稳定的错误码，采用大写蛇形命名，例如 KNOWLEDGE_FS_CONFLICT 或 SOURCE_CREDENTIAL_TEST_FAILED。

messagestring#

错误码或失败类别对应的公开消息。不会暴露提供商的错误详情。

parametersobject#

retryPolicystring#

重试是否有用：automatic（服务会自动重试）、manual（需自行重试）、after_configuration（先在 Dify 中修正知识库配置）或 never（需修改请求）。

stagestring#

失败所在的阶段，例如 query_generation 或 credential-test。不适用时为 null。HTTP 错误响应体中不包含此字段。

traceIdstring#

联系管理员时需提供的参考编号。在包含失败详情的成功响应中可能为 null，在 HTTP 错误响应体中可能不出现。

job_idstring#

该文档对应任务的 ID（如有）。

idstring#

任务 ID：task_kind: document 时为索引任务 ID，document_bulk 时为批量任务 ID，source 时为数据源运行 ID。由删除文档产生的 document_delete 任务，则为删除作业 ID：用它轮询获取删除作业。

knowledge_space_idstring#

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

operationstring#

任务执行的操作：

document_processing：索引任务。
document_reindex、document_upload、document_delete：批量任务。批量上传和批量删除来自 Dify。删除文档发起的删除也会作为 document_delete 任务出现。此 API 的其他删除操作只创建删除作业。
source_sync、source_crawl_preview、source_crawl_import、source_online_document_import、source_online_drive_import：数据源运行。

progress_completedinteger#

已完成的项数。索引任务按其文档计，批量任务按其中的各个文档计，数据源运行按其条目计。

progress_failedinteger#

失败的项数，计数方式同 progress_completed。

progress_percentinteger#

进度，取值 0～100。索引任务的进度取决于任务所处的阶段。

progress_totalinteger#

任务中的总项数，计数方式同 progress_completed。索引任务为 1。

semantic_enrichmentobject#

索引任务发布后的知识图谱构建；其他类型的任务为 null。索引会在发布前建好知识图谱，因此不会安排这一步。任务运行期间 state 为 not_scheduled，任务结束后为 disabled。nodes_completed 始终为 0。

Show child attributes

error_codestring#

state 为 failed 时的错误码。

error_messagestring#

error_code 对应的错误消息，可能与 failure.message 不同。

failureobject#

state 为 failed 时的错误详情，否则为 null。

Show child attributes

actionstring#

categorystring#

失败类别：authorization、canceled、configuration、conflict、dependency、internal、not_found、rate_limit、timeout 或 validation。

codestring#

稳定的错误码，采用大写蛇形命名，例如 KNOWLEDGE_FS_CONFLICT 或 SOURCE_CREDENTIAL_TEST_FAILED。

messagestring#

错误码或失败类别对应的公开消息。不会暴露提供商的错误详情。

parametersobject#

retryPolicystring#

重试是否有用：automatic（服务会自动重试）、manual（需自行重试）、after_configuration（先在 Dify 中修正知识库配置）或 never（需修改请求）。

stagestring#

失败所在的阶段，例如 query_generation 或 credential-test。不适用时为 null。HTTP 错误响应体中不包含此字段。

traceIdstring#

联系管理员时需提供的参考编号。在包含失败详情的成功响应中可能为 null，在 HTTP 错误响应体中可能不出现。

nodes_completedinteger#

已构建的知识图谱节点数：state 变为 ready 之前为 0，之后与 nodes_total 相同。

nodes_totalinteger#

需构建的知识图谱节点数。确定之前为 null。

provider_callsinteger#

目前已发起的模型调用次数。

provider_calls_maximuminteger#

构建知识图谱最多可发起的模型调用次数。

statestring#

not_scheduled、pending、running、ready、failed 或 disabled。

updated_atstring#

语义增强最后变更时间，ISO 8601 格式。

source_idstring#

数据源运行所属的数据源。

source_titlestring#

数据源运行所属数据源的名称。仅在未传 task_ids 列出任务时设置。

statestring#

queued、running、completed、failed 或 canceled，由任务自身的状态映射而来。抓取预览在等待选择页面期间为 completed。

要查看确切状态，用获取索引任务读取索引任务，用获取数据源运行读取数据源运行。

task_kindstring#

document（索引任务）、document_bulk（批量任务）或 source（数据源运行）。

updated_atstring#

任务最后变更时间，ISO 8601 格式。

provider_item_idstring#

从数据源导入的文档在该数据源中的条目标识，即发送给导入数据源条目的 providerItemId，或网站页面的 page_id。

row_versioninteger#

变更计数器。调用更新文档元数据时将其作为 expectedRowVersion 传入，调用删除文档时将其作为 expectedRevision 传入。更新元数据、新修订版本生效、删除生效修订版本的文件、以 documents=keep 删除文档所属的数据源，以及在 Dify 中启用或禁用文档时，该值都会递增。

source_idstring#

文档的来源数据源。上传的文件为 null。

statusstring#

pending（尚无生效的修订版本）、ready（已有修订版本生效）、failed（首个修订版本索引失败，且没有生效的修订版本）或 deleting。ready 的文档在后续修订版本失败时仍保持 ready。

titlestring#

文档标题。

updated_atstring#

文档最后变更时间，ISO 8601 格式。

user_metadataobject#

自定义元数据，以元数据字段名为键。可通过更新文档元数据或在 Dify 中修改。

next_cursorstring#

下一页的游标，最后一页时为 null。将其作为 cursor 传回。

获取研究任务结果列表获取文档