Skip to content
Luminary Luminary Luminary
Get started
API Reference

Document Summaries

List all document summaries
GET/document-summaries
Get a document summary by ID
GET/document-summaries/{id}
Update a document summary
PUT/document-summaries/{id}
Download document summary as PDF
GET/document-summaries/{id}/download
ModelsExpand Collapse
DocumentSummary object { id, created_at, display_name, 6 more }
id: string

Unique identifier for the document summary

created_at: string

Timestamp when the summary was created

formatdate-time
display_name: string

Display name for the summary

document_id: string

ID of the document this summary belongs to

household_id: string

ID of the household this summary belongs to

summary: string

The summary text content

updated_at: string

Timestamp when the summary was last updated

formatdate-time
entry_mode: optional DocumentSummaryEntryMode

Indicates if the summary was AI-generated or user-entered

One of the following:
"AI_AUTO"
"USER"
summary_format: optional DocumentSummaryFormat

Format of the summary content

One of the following:
"MARKDOWN"
"PLAIN_TEXT"
DocumentSummaryEntryMode = "AI_AUTO" or "USER"

Indicates if the summary was AI-generated or user-entered

One of the following:
"AI_AUTO"
"USER"
DocumentSummaryFormat = "MARKDOWN" or "PLAIN_TEXT"

Format of the summary content

One of the following:
"MARKDOWN"
"PLAIN_TEXT"
PageInfo object { has_next_page, has_previous_page, end_cursor, start_cursor }
has_next_page: boolean

When paginating forwards, are there more items?

has_previous_page: boolean

When paginating backwards, are there more items?

end_cursor: optional string

Cursor pointing to the last item in the current page

start_cursor: optional string

Cursor pointing to the first item in the current page