Sign in

v1

latestOpenAPI 3.1.02026-07-1255227258.8 KB
documents

Get Document Chunk Content

Returns the content of a document chunk in the requested format. Can be used to stream media of the content for audio/video documents.

get/documents/{document_id}/chunks/{chunk_id}/content

Path parameters

document_idstring uuid required

The id of the document.

Example:00000000-0000-0000-0000-000000000000

The id of the document.

chunk_idstring uuid required

The ID of the chunk.

Example:00000000-0000-0000-0000-000000000000

The ID of the chunk.

Query parameters

media_type'text/plain' | 'audio/mpeg' | 'video/mp4' | 'image/webp' | 'image/heic' | 'image/bmp' | 'image/png' | 'image/jpeg' | 'image/tiff' nullable

The desired media type of the content to return described as a mime type. An error will be returned if the requested media type is not supported for the chunk's document type.

Example:text/plain

The desired media type of the content to return described as a mime type. An error will be returned if the requested media type is not supported for the chunk's document type.

downloadboolean

Whether to return the content as a file download or a raw stream. If set to true, the content will be returned as a named file for download.

Whether to return the content as a file download or a raw stream. If set to true, the content will be returned as a named file for download.

Headers

partitionstring nullable

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 support@ragie.ai. Older accounts using the partitions feature are strongly recommended to scope the request to a partition.

Example:acme_customer_id

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 support@ragie.ai. Older accounts using the partitions feature are strongly recommended to scope the request to a partition.

rangestring nullable

Response

Returns the source content of the document chunk.

{"stackTrail":"paths:/documents/{document_id}/chunks/{chunk_id}/content:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}