Skip to content
Luminary Luminary Luminary
Get started
API Reference

Document Summaries

List all document summaries
client.documentSummaries.list(DocumentSummaryListParams { after, before, document_id, 2 more } query?, RequestOptionsoptions?): CursorPagination<DocumentSummary { id, created_at, display_name, 6 more } >
get/document-summaries
Get a document summary by ID
client.documentSummaries.retrieve(stringid, RequestOptionsoptions?): DocumentSummary { id, created_at, display_name, 6 more }
get/document-summaries/{id}
Update a document summary
client.documentSummaries.update(stringid, DocumentSummaryUpdateParams { display_name, entry_mode, summary, summary_format } body, RequestOptionsoptions?): DocumentSummary { id, created_at, display_name, 6 more }
put/document-summaries/{id}
Download document summary as PDF
client.documentSummaries.download(stringid, DocumentSummaryDownloadParams { format } query?, RequestOptionsoptions?): Response
get/document-summaries/{id}/download
ModelsExpand Collapse
DocumentSummary { 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?: DocumentSummaryEntryMode

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

Accepts one of the following:
"AI_AUTO"
"USER"
summary_format?: DocumentSummaryFormat

Format of the summary content

Accepts one of the following:
"MARKDOWN"
"PLAIN_TEXT"
DocumentSummaryEntryMode = "AI_AUTO" | "USER"

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

Accepts one of the following:
"AI_AUTO"
"USER"
DocumentSummaryFormat = "MARKDOWN" | "PLAIN_TEXT"

Format of the summary content

Accepts one of the following:
"MARKDOWN"
"PLAIN_TEXT"
PageInfo { 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?: string | null

Cursor pointing to the last item in the current page

start_cursor?: string | null

Cursor pointing to the first item in the current page