API Reference
Start typing to search…

Get Document Chunks

get
https://api.ragie.ai/documents//chunks

List all document chunks sorted by index in ascending order. May be limited to a range of chunk indices with the start_index and end_index parameters. Documents created prior to 9/18/2024, which have not been updated since, have chunks which do not include an index and their index will be returned as -1. They will be sorted by their ID instead. Updating the document using the Update Document File or Update Document Raw endpoint will regenerate document chunks, including their index. Results are paginated with a max limit of 100. When more chunks are available, a cursor will be provided. Use the cursor parameter to retrieve the subsequent page.

Path Params
uuid
required

The id of the document.

Query Params

The inclusive starting index of the chunk range to list. If omitted and end_index is present effectively limits results to at most one chunk matching end_index. If both start_index and end_index are omitted, results are not limited by index.

The inclusive ending index of the chunk range to list. If omitted and start_index is present effectively limits results to at most one chunk matching start_index. If both start_index and end_index are omitted, results are not limited by index.

An opaque cursor for pagination

integer
1 to 100
Defaults to 10

The number of items per page (must be greater than 0 and less than or equal to 100)

Headers

An optional partition to scope the request to. If omitted, accounts created after 1/9/2025 will have the request scoped to the default partition, while older accounts will have the request scoped to all partitions. Older accounts may opt in to strict partition scoping by contacting [email protected]. Older accounts using the partitions feature are strongly recommended to scope the request to a partition.

Responses

Updated 5 months ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago