API & SDKsDocuments

List document chunks

Retrieves the text chunks that were generated from a document during ingestion. Chunks represent semantic sections of the document and are used for retrieval and analysis. Users can only access chunks from documents they own or have access to through collections. Vector embeddings are only included if specifically requested. Results are returned in chunk sequence order, representing their position in the original document.

Path parameters

idstringRequired
The ID of the document to retrieve chunks for.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-API-KeystringRequired

Query parameters

offsetintegerOptional>=0Defaults to 0
Specifies the number of objects to skip. Defaults to 0.
limitintegerOptional>=1<=1000Defaults to 100
Specifies a limit on the number of objects to return, ranging between 1 and 100. Defaults to 100.
include_vectorsbooleanOptional
Whether to include vector embeddings in the response.

Response

Successful Response
resultslist of objects
total_entriesinteger

Errors