Skip to content
Luminary Luminary Luminary
Get started
API Reference

Document Summaries

List all document summaries
document_summaries.list(DocumentSummaryListParams**kwargs) -> DocumentSummaryListResponse
get/document-summaries
Get a document summary by ID
document_summaries.retrieve(strid) -> DocumentSummary
get/document-summaries/{id}
Update a document summary
document_summaries.update(strid, DocumentSummaryUpdateParams**kwargs) -> DocumentSummary
put/document-summaries/{id}
Download document summary as PDF
document_summaries.download(strid, DocumentSummaryDownloadParams**kwargs) -> BinaryResponseContent
get/document-summaries/{id}/download
ModelsExpand Collapse
class DocumentSummary: …
id: str

Unique identifier for the document summary

created_at: datetime

Timestamp when the summary was created

formatdate-time
display_name: str

Display name for the summary

document_id: str

ID of the document this summary belongs to

household_id: str

ID of the household this summary belongs to

summary: str

The summary text content

updated_at: datetime

Timestamp when the summary was last updated

formatdate-time
entry_mode: Optional[DocumentSummaryEntryMode]

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

Accepts one of the following:
"AI_AUTO"
"USER"
summary_format: Optional[DocumentSummaryFormat]

Format of the summary content

Accepts one of the following:
"MARKDOWN"
"PLAIN_TEXT"
DocumentSummaryEntryMode = Literal["AI_AUTO", "USER"]

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

Accepts one of the following:
"AI_AUTO"
"USER"
DocumentSummaryFormat = Literal["MARKDOWN", "PLAIN_TEXT"]

Format of the summary content

Accepts one of the following:
"MARKDOWN"
"PLAIN_TEXT"