v1

latestOpenAPI 3.1.02026-07-1255227258.8 KB
documents

Get Document Summary

Get a LLM generated summary of the document. The summary is created when the document is first created or updated. Documents of types ['xls', 'xlsx', 'csv', 'json'] are not supported for summarization. Documents greater than 1M in token length are not supported. This feature is in beta and may change in the future.

get/documents/{document_id}/summary

Path parameters

document_idstring uuid required

The id of the document.

Example:00000000-0000-0000-0000-000000000000

The id of the document.

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.

Response

Successful Response

document_idstring required
summarystring required