> ## Documentation Index > Fetch the complete documentation index at: https://docs.dify.ai/llms.txt > Use this file to discover all available pages before exploring further. # List Chunks > Lists the chunks of one revision of a document, ordered by chunk ID rather than by position. Takes the document ID from [List Documents](/en/api-reference/documents-and-chunks/list-documents), not the document file ID, plus the revision number. To read chunks in document order, fetch every page and sort by `ordinal`. Any revision can be listed, including a superseded one, as long as the document file version behind it still exists. For how document IDs and document file IDs relate, see [Browse Documents and Chunks](/en/api-reference/guides/knowledge-base#browse-documents-and-chunks). ## OpenAPI ````yaml /en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks openapi: 3.0.1 info: description: >- REST API for Dify applications and knowledge bases. Application endpoints authenticate with an app API key; knowledge endpoints authenticate with a dataset API key. title: Dify Service API version: 1.0.0 servers: - description: >- Base URL of the Dify Service API. For self-hosted deployments, replace it with your own API base URL. url: https://{api_base_url} variables: api_base_url: default: api.dify.ai/v1 description: Host and path of the API base URL, without the `https://` prefix. security: - ApiKeyAuth: [] tags: - description: Operations related to chat messages and interactions. name: Chat Messages - description: File upload and preview operations. name: Files - description: Operations related to end user information. name: End Users - description: User feedback operations. name: Feedback - description: Operations related to managing conversations. name: Conversations - description: Text-to-Speech and Speech-to-Text operations. name: Audio - description: Operations to retrieve application settings and information. name: Applications - description: Operations related to managing annotations for direct replies. name: Annotations - description: Endpoints for resuming paused workflows that require human input. name: Human Input - description: Operations for executing and managing workflows. name: Workflow Runs - description: Operations related to text generation and completion. name: Completion Messages - description: >- Operations for managing knowledge bases, including creation, configuration, and retrieval. name: Knowledge Bases - description: >- Operations for creating, updating, and managing documents within a knowledge base. name: Documents - description: Operations for managing document chunks and child chunks. name: Chunks - description: >- Operations for managing knowledge base metadata fields and document metadata values. name: Metadata - description: Operations for managing knowledge base tags and tag bindings. name: Tags - description: Operations for retrieving available models. name: Models - description: >- Operations for managing and running knowledge pipelines, including datasource plugins and pipeline execution. name: Knowledge Pipeline - description: Ask a knowledge base a question and stream the answer. name: Queries - description: Inspect what a query retrieved and why. name: Query Records - description: Run a research question in the background and collect its results. name: Research Tasks - description: >- Read the documents in a knowledge base, their files, revisions, and chunks; label documents with metadata. name: Documents and Chunks - description: >- Follow, cancel, or retry indexing, and list the knowledge base's background tasks. name: Indexing Tasks - description: >- Follow the deletion of a document file, a batch of files, or a source until it finishes. name: Deletion Jobs - description: >- Manage the sources that feed a knowledge base, their sync schedules, and their connections. name: Sources - description: >- Sync a source now, import website pages or provider items, and follow, cancel, or retry the runs. name: Source Syncs and Imports - description: >- Read and change the knowledge base's models and retrieval settings, and follow the migration a change starts. name: Settings paths: /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks: get: tags: - Documents and Chunks summary: List Chunks description: >- Lists the chunks of one revision of a document, ordered by chunk ID rather than by position. Takes the document ID from [List Documents](/en/api-reference/documents-and-chunks/list-documents), not the document file ID, plus the revision number. To read chunks in document order, fetch every page and sort by `ordinal`. Any revision can be listed, including a superseded one, as long as the document file version behind it still exists. For how document IDs and document file IDs relate, see [Browse Documents and Chunks](/en/api-reference/guides/knowledge-base#browse-documents-and-chunks). operationId: listDocumentChunks parameters: - description: >- Knowledge base ID: the last segment of the Service API endpoint shown in the knowledge base's **API Access** dialog (`…/knowledge-fs/spaces/`), and the segment after `/datasets/new/` in the address bar. in: path name: knowledge_base_id required: true schema: format: uuid type: string - description: >- The document ID, from [List Documents](/en/api-reference/documents-and-chunks/list-documents) or from the address bar of the open document (`/datasets/new//documents/`). in: path name: document_id required: true schema: format: uuid type: string - description: >- Revision number. From [List Document Revisions](/en/api-reference/documents-and-chunks/list-document-revisions). in: path name: revision required: true schema: minimum: 1 type: integer - description: Cursor from the previous page's `next_cursor`. in: query name: cursor required: false schema: maxLength: 1000 minLength: 1 type: string - description: >- Case-insensitive substring to match against `text`. Not a semantic search. Omit it to list every chunk. in: query name: query required: false schema: maxLength: 512 minLength: 1 type: string - description: Chunks per page. in: query name: limit required: false schema: default: 50 maximum: 100 minimum: 1 type: integer responses: '200': content: application/json: examples: success: summary: Response Example value: data: - created_at: '2026-09-03T10:04:30Z' document_id: 3d2f1c0b-9a8e-4d7c-b6a5-4f3e2d1c0b9a document_revision: 2 enabled: true end_offset: 5120 id: 7a6b5c4d-3e2f-4a1b-9c8d-7e6f5a4b3c2d kind: chunk knowledge_space_id: 9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b ordinal: 14 parent_chunk_id: null parse_element_ids: - el-40 - el-41 section_path: - 3 Employment - 3.4 Termination start_offset: 4600 text: >- Either party may terminate this agreement with thirty days' written notice. token_count: 131 user_metadata: {} next_cursor: null schema: properties: data: description: One page of chunks, ordered by chunk ID. items: $ref: '#/components/schemas/KnowledgeBaseChunk' type: array next_cursor: description: >- Cursor for the next page, or `null` on the last page. Send it back as `cursor`. nullable: true type: string type: object description: One page of chunks. '400': content: application/json: examples: knowledge_fs_invalid_request_local: summary: knowledge_fs_invalid_request (request validation) value: code: knowledge_fs_invalid_request message: Agent Knowledge Base request is invalid. status: 400 violations: - field: - query type: string_too_long knowledge_fs_invalid_request_path: summary: knowledge_fs_invalid_request (path ID) value: code: knowledge_fs_invalid_request message: Agent Knowledge Base request is invalid. status: 400 knowledge_fs_invalid_request_upstream: summary: knowledge_fs_invalid_request (rejected) value: 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 description: >- - `knowledge_fs_invalid_request`: the request failed validation. `violations` names each failing field. - `knowledge_fs_invalid_request`: `revision` is `0`, or `document_id` is not a UUID. - `knowledge_fs_invalid_request`: `document_id` is malformed. '401': content: application/json: examples: knowledge_fs_invalid_credential: summary: knowledge_fs_invalid_credential value: code: knowledge_fs_invalid_credential message: Invalid Agent Knowledge Base service credential. status: 401 unauthorized: summary: unauthorized value: code: unauthorized message: Access token is invalid status: 401 description: >- - `unauthorized`: the `Authorization` header is missing, or the key is unknown or not a knowledge base API key. - `knowledge_fs_invalid_credential`: the key is valid, but no knowledge base with this ID exists in the key's workspace, or the key is not tied to a workspace. '403': content: application/json: examples: forbidden: summary: forbidden (rate limit) value: code: forbidden message: >- Sorry, you have reached the knowledge base request rate limit of your subscription. status: 403 knowledge_fs_access_denied_scope: summary: knowledge_fs_access_denied (key scope) value: code: knowledge_fs_access_denied message: Agent Knowledge Base operation is not allowed. status: 403 description: >- - `knowledge_fs_access_denied`: the key is scoped to other knowledge bases, **API access** is off for this knowledge base, or the knowledge base is not active. - `knowledge_fs_access_denied`: the key has no access to this knowledge base's content. - `forbidden`: on Dify Cloud, the workspace has reached the knowledge base request rate limit of its subscription. Every call counts, reads included. '404': content: application/json: examples: knowledge_fs_resource_not_found: summary: knowledge_fs_resource_not_found value: code: knowledge_fs_resource_not_found failure: category: not_found code: KNOWLEDGE_FS_NOT_FOUND message: >- The requested Agent Knowledge Base resource was not found. retryPolicy: never traceId: 7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83 message: The requested Agent Knowledge Base resource was not found. status: 404 not_found: summary: not_found (feature off) value: 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 description: >- - `knowledge_fs_resource_not_found`: no document has this ID, the revision does not exist, the document file behind it has been deleted, or the key may not read this knowledge base. All of these are reported as not found. - `not_found`: the Agent Knowledge Base feature is turned off on this deployment. '502': content: application/json: examples: knowledge_fs_upstream_unavailable: summary: knowledge_fs_upstream_unavailable (service error) value: 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 knowledge_fs_upstream_unavailable_transport: summary: knowledge_fs_upstream_unavailable (no response) value: code: knowledge_fs_upstream_unavailable message: Agent Knowledge Base is unavailable. status: 502 description: >- - `knowledge_fs_upstream_unavailable`: no answer came back in time, or the answer couldn't be read. Retry after a pause. '503': content: application/json: examples: knowledge_fs_operation_unavailable: summary: knowledge_fs_operation_unavailable value: code: knowledge_fs_operation_unavailable message: Agent Knowledge Base operation is not available. status: 503 knowledge_fs_operation_unavailable_upstream: summary: knowledge_fs_operation_unavailable (temporary) value: 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 description: >- - `knowledge_fs_operation_unavailable`: the Agent Knowledge Base feature is not set up for this workspace, this operation is not available on the deployment, or the key's access to this knowledge base changed while the request was being authorized. - `knowledge_fs_operation_unavailable`: the request can't be served right now. Follow `failure.retryPolicy`. components: schemas: KnowledgeBaseChunk: description: >- Offsets refer to the parsed document text. They are not positions in the original file. properties: created_at: description: When the chunk was created, ISO 8601. type: string document_id: description: >- Document ID: the `id` of [Get Document](/en/api-reference/documents-and-chunks/get-document). type: string document_revision: description: >- Revision the chunk belongs to. Each revision has its own chunks. A chunk ID is addressable only through its own revision. type: integer enabled: description: >- Whether the chunk takes part in retrieval. No operation in this API changes it. type: boolean end_offset: description: >- Zero-based UTF-8 byte offset in the parsed document text. Exclusive end. `null` when unknown. nullable: true type: integer id: description: >- Chunk ID. The `chunk_id` path value for [Get Chunk](/en/api-reference/documents-and-chunks/get-chunk). type: string kind: description: >- What the chunk was built from: `chunk` for a run of body text (the default), `section` for a heading section, `table` for a table, `image` for an image, `summary` for a generated summary. type: string knowledge_space_id: description: >- Internal ID of the knowledge base. Not the knowledge base ID in the path. type: string ordinal: description: >- Position of the chunk within the revision, starting at `0`. Sort by it to read chunks in document order. type: integer parent_chunk_id: description: >- ID of the parent chunk for parent-child chunking. `null` for top-level chunks. nullable: true type: string parse_element_ids: description: IDs of the parsed elements the chunk was built from. items: type: string type: array section_path: description: Headings from the document root to the chunk's section. items: type: string type: array start_offset: description: >- Zero-based UTF-8 byte offset in the parsed document text. Inclusive start. `null` when unknown. nullable: true type: integer text: description: Chunk content. type: string token_count: description: Number of tokens in `text`. type: integer user_metadata: additionalProperties: true description: Metadata attached to the chunk. Free-form object. type: object type: object securitySchemes: ApiKeyAuth: bearerFormat: API_KEY description: >- Every request authenticates with an API key: `Authorization: Bearer {API_KEY}`. App endpoints take an app API key; knowledge endpoints take a knowledge base API key ([Get Started](/en/api-reference/guides/get-started)). Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP `401` (`unauthorized`). scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.