获取文档详情

返回单个文档的详细信息。

GET /datasets/{dataset_id}/documents/{document_id}

获取文档详情

cURL

curl --request GET \
  --url https://{api_base_url}/datasets/{dataset_id}/documents/{document_id} \
  --header 'Authorization: Bearer <token>'

200

success

{
  "archived": false,
  "average_segment_length": 70,
  "completed_at": 1741267260,
  "created_at": 1741267200,
  "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
  "created_from": "api",
  "data_source_info": {
    "upload_file": {
      "created_at": 1741267200,
      "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
      "extension": "txt",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "mime_type": "text/plain",
      "name": "guide.txt",
      "size": 2048
    }
  },
  "data_source_type": "upload_file",
  "dataset_process_rule": {
    "id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
    "mode": "custom"
  },
  "dataset_process_rule_id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
  "disabled_at": null,
  "disabled_by": null,
  "display_status": "available",
  "doc_form": "text_model",
  "doc_language": "English",
  "doc_metadata": [],
  "doc_type": null,
  "document_process_rule": {
    "mode": "custom",
    "rules": {
      "pre_processing_rules": [],
      "segmentation": {
        "chunk_overlap": 50,
        "max_tokens": 500,
        "separator": "###"
      }
    }
  },
  "enabled": true,
  "error": null,
  "hit_count": 0,
  "id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
  "indexing_latency": 60,
  "indexing_status": "completed",
  "name": "guide.txt",
  "need_summary": false,
  "position": 1,
  "segment_count": 5,
  "summary_index_status": null,
  "tokens": 512,
  "updated_at": 1741267260
}

Authorizations

Authorization · string · header · required

每个请求都通过 API Key 认证：Authorization: Bearer {API_KEY}。应用接口使用应用 API Key，知识库接口使用知识库 API Key（快速开始）。

API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401（unauthorized）。

Path Parameters

dataset_id · string<uuid> · required

知识库 ID，通过 获取知识库列表 获取。使用限定范围的密钥时，从 Dify 页面 URL 复制 ID。

document_id · string<uuid> · required

文档 ID。从 获取知识库的文档列表 获取。

Query Parameters

metadata · enum<string> · default: all

all 返回所有字段（包括元数据）。only 仅返回 id、doc_type 和 doc_metadata。without 返回除 doc_type 和 doc_metadata 外的所有字段。

Available options: all, only, without

Response

200

application/json

文档详情。返回的字段取决于 metadata 查询参数。

archived · boolean

文档是否已归档。

average_segment_length · number

分段的平均字符长度。

completed_at · number | null

处理完成的 Unix 时间戳，尚未完成时为 null。

created_at · number

文档创建的 Unix 时间戳。

created_by · string

创建该文档的用户 ID。

created_from · string

文档来源。通过 API 创建时为 api，通过 UI 创建时为 web。

data_source_info · object

数据源详情。文件上传时，此详情接口在 upload_file 下返回完整的文件对象，而列表接口仅返回 upload_file_id。

Show child attributes

data_source_type · string

文档的上传方式。文件上传为 upload_file，Notion 导入为 notion_import。

dataset_process_rule · object

知识库级别的处理规则配置。

dataset_process_rule_id · string

应用于该文档的处理规则 ID。

disabled_at · number | null

文档被禁用的 Unix 时间戳，启用时为 null。

disabled_by · string | null

禁用该文档的用户 ID，启用时为 null。

display_status · string

适合 UI 显示的索引状态。

doc_form · string

文档分块模式。text_model 表示标准文本，hierarchical_model 表示父子结构，qa_model 表示问答对。

doc_language · string

文档内容的语言。

doc_metadata · object[]

此文档的自定义元数据键值对。

Show child attributes

doc_type · string | null

文档类型分类，未设置时为 null。

document_process_rule · object

文档级别的处理规则配置。

enabled · boolean

该文档是否启用检索。

error · string | null

索引失败时的错误消息，否则为 null。

hit_count · integer

该文档被检索的次数。

id · string

文档标识符。

indexing_latency · number | null

索引耗时（秒），未完成时为 null。

indexing_status · string

当前索引状态，例如 waiting、parsing、cleaning、splitting、indexing、completed、error、paused。

name · string

文档名称。

need_summary · boolean

该文档是否需要生成摘要。

position · integer

在知识库中的位置索引。

segment_count · integer

文档中的分段数。

summary_index_status · string | null

摘要索引的状态，未启用摘要索引时为 null。

tokens · integer

文档中的令牌数。

updated_at · number | null

最后更新的 Unix 时间戳，从未更新时为 null。