Skip to main content
get/datasets/{dataset_id}/documents/{document_id}/segments
Request example
Response
get/datasets/{dataset_id}/documents/{document_id}/segments

Authorization

Authorizationstringheaderrequired#

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

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

Path parameters

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

Query parameters

pageinteger#
页码。

Default: 1

Range: >= 1

limitinteger#
每页的项目数量。服务器上限为 100。

Default: 20

Range: >= 1

statusstring[]#
按索引状态筛选分段,例如 completed、indexing、error。
keywordstring#
搜索关键词。

Responses

application/json
分段列表。
dataobject[]#
分段列表。
doc_formstring#
该文档使用的分块模式。
has_moreboolean#
下一页是否还有更多项目。
limitinteger#
每页条目数。
pageinteger#
当前页码。
totalinteger#
匹配的分段总数。