Chunks

List Chunks

Returns a paginated list of chunks within a document, optionally filtered by keyword or indexing status.

get/datasets/{dataset_id}/documents/{document_id}/segments

Request

Base URL
https://api.dify.ai/v1
URL
https://api.dify.ai/v1/datasets/{dataset_id}/documents/{document_id}/segments
Auth
HTTP bearer

dataset_idstring uuid required

Knowledge base ID, from List Knowledge Bases. For a scoped key, copy the ID from the Dify URL.

document_idstring uuid required

Document ID. Obtain it from List Documents.

pageinteger

Page number.

limitinteger

Number of items per page. Server caps at 100.

statusstring[]

Filter chunks by indexing status, e.g. completed, indexing, error.

keywordstring

Search keyword.

List of chunks.

doc_formstring

Document chunking mode used by this document.

has_moreboolean

Whether more items exist on the next page.

limitinteger

Number of items per page.

pageinteger

Current page number.

totalinteger

Total number of matching chunks.