Skip to main content
GET
获取文档文件

Authorizations

Authorization
string
header
required

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

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

Path Parameters

knowledge_base_id
string<uuid>
required

知识库 ID:即知识库 API 访问 对话框中所示服务 API 端点的最后一段(…/knowledge-fs/spaces/<knowledge base ID>),也是地址栏中 /datasets/new/ 之后的那一段。

document_file_id
string<uuid>
required

文档文件 ID。从 获取文档文件列表 获取。

Response

文档文件。

created_at
string

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

filename
string

原始文件名。

id
string

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

knowledge_space_id
string

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

metadata
object

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

mime_type
string

文件的 MIME 类型。

object_key
string

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

parser_status
string

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

sha256
string

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

size_bytes
integer

文件大小,单位为字节。

source_id
string | null

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

updated_at
string | null

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

version
integer

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