Skip to content
Luminary Luminary Luminary
Get started
API Reference

Documents

List all documents
documents.list(DocumentListParams**kwargs) -> SyncCursorPagination[Document]
GET/documents
Upload a new document
documents.create(DocumentCreateParams**kwargs) -> Document
POST/documents
Delete a document
documents.delete(strid)
DELETE/documents/{id}
Get a document by ID
documents.retrieve(strid) -> Document
GET/documents/{id}
Update a document
documents.update(strid, DocumentUpdateParams**kwargs) -> Document
PUT/documents/{id}
Get summaries for a document
documents.get_summaries(strid) -> DocumentGetSummariesResponse
GET/documents/{id}/document-summaries
Download document file content
documents.download(strid) -> BinaryResponseContent
GET/documents/{id}/download
ModelsExpand Collapse
class Document: …
id: str

Unique identifier with document_ prefix

created_at: datetime

Timestamp when the document was created

formatdate-time
household_id: str

Household ID this document belongs to

name: str

Display name of the document

type: DocumentType

Type of document

One of the following:
"GRAT_DESIGN_SUMMARY"
"GENERATED_PRESENTATION"
"ASSET_VALUATION"
"SIGNED_TRUST_DOCUMENT"
"TRUST_AMENDMENT"
"TRANSFER_CONFIRMATION"
"EXISTING_REMAINDER_TRUST_DOCUMENT"
"BALANCE_SHEET"
"WILL"
"WILL_CODICIL"
"POWER_OF_ATTORNEY"
"ASSIGNMENT_OF_INTEREST"
"ASSIGNMENT_OF_TANGIBLE_PROPERTY"
"LOAN_NOTE_AGREEMENT"
"ARTICLES_OF_INCORPORATION"
"OPERATING_AGREEMENT"
"PARTNERSHIP_AGREEMENT"
"ACCOUNT_DOCUMENTATION_STATEMENT"
"TAX_ID_CONFIRMATION"
"GIFT_TAX_RETURN"
"INCOME_TAX_RETURN"
"TAX_RECEIPT"
"TAX_FILING"
"CORPORATE_BYLAWS"
"LLC_AGREEMENT"
"LLC_AGREEMENT_AMENDMENT"
"OPERATING_AGREEMENT_AMENDMENT"
"PARTNERSHIP_AGREEMENT_AMENDMENT"
"SHAREHOLDERS_AGREEMENT"
"STATE_BUSINESS_FILING"
"LOGGED_CONTRIBUTION"
"LOGGED_DISTRIBUTION"
"INSURANCE_POLICY"
"CRUMMEY_LETTER"
"INSURANCE_PREMIUM_PAYMENT"
"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"
"FINCEN_FILING"
"HEALTHCARE_PROXY"
"LIVING_WILL"
"DRIVERS_LICENSE"
"PASSPORT"
"DEED"
"OTHER"
updated_at: datetime

Timestamp when the document was last updated

formatdate-time
enable_ai_suggestions: Optional[bool]

Whether this document should be used for AI suggestions

entity_id: Optional[str]

Entity ID if this document is owned by an entity

individual_id: Optional[str]

Individual ID if this document is associated with an individual

class DocumentList: …
data: List[Document]
id: str

Unique identifier with document_ prefix

created_at: datetime

Timestamp when the document was created

formatdate-time
household_id: str

Household ID this document belongs to

name: str

Display name of the document

type: DocumentType

Type of document

One of the following:
"GRAT_DESIGN_SUMMARY"
"GENERATED_PRESENTATION"
"ASSET_VALUATION"
"SIGNED_TRUST_DOCUMENT"
"TRUST_AMENDMENT"
"TRANSFER_CONFIRMATION"
"EXISTING_REMAINDER_TRUST_DOCUMENT"
"BALANCE_SHEET"
"WILL"
"WILL_CODICIL"
"POWER_OF_ATTORNEY"
"ASSIGNMENT_OF_INTEREST"
"ASSIGNMENT_OF_TANGIBLE_PROPERTY"
"LOAN_NOTE_AGREEMENT"
"ARTICLES_OF_INCORPORATION"
"OPERATING_AGREEMENT"
"PARTNERSHIP_AGREEMENT"
"ACCOUNT_DOCUMENTATION_STATEMENT"
"TAX_ID_CONFIRMATION"
"GIFT_TAX_RETURN"
"INCOME_TAX_RETURN"
"TAX_RECEIPT"
"TAX_FILING"
"CORPORATE_BYLAWS"
"LLC_AGREEMENT"
"LLC_AGREEMENT_AMENDMENT"
"OPERATING_AGREEMENT_AMENDMENT"
"PARTNERSHIP_AGREEMENT_AMENDMENT"
"SHAREHOLDERS_AGREEMENT"
"STATE_BUSINESS_FILING"
"LOGGED_CONTRIBUTION"
"LOGGED_DISTRIBUTION"
"INSURANCE_POLICY"
"CRUMMEY_LETTER"
"INSURANCE_PREMIUM_PAYMENT"
"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"
"FINCEN_FILING"
"HEALTHCARE_PROXY"
"LIVING_WILL"
"DRIVERS_LICENSE"
"PASSPORT"
"DEED"
"OTHER"
updated_at: datetime

Timestamp when the document was last updated

formatdate-time
enable_ai_suggestions: Optional[bool]

Whether this document should be used for AI suggestions

entity_id: Optional[str]

Entity ID if this document is owned by an entity

individual_id: Optional[str]

Individual ID if this document is associated with an individual

page_info: PageInfo
has_next_page: bool

When paginating forwards, are there more items?

has_previous_page: bool

When paginating backwards, are there more items?

end_cursor: Optional[str]

Cursor pointing to the last item in the current page

start_cursor: Optional[str]

Cursor pointing to the first item in the current page

total_count: int

Total number of items matching the query (across all pages)

Literal["GRAT_DESIGN_SUMMARY", "GENERATED_PRESENTATION", "ASSET_VALUATION", 40 more]

Type of document

One of the following:
"GRAT_DESIGN_SUMMARY"
"GENERATED_PRESENTATION"
"ASSET_VALUATION"
"SIGNED_TRUST_DOCUMENT"
"TRUST_AMENDMENT"
"TRANSFER_CONFIRMATION"
"EXISTING_REMAINDER_TRUST_DOCUMENT"
"BALANCE_SHEET"
"WILL"
"WILL_CODICIL"
"POWER_OF_ATTORNEY"
"ASSIGNMENT_OF_INTEREST"
"ASSIGNMENT_OF_TANGIBLE_PROPERTY"
"LOAN_NOTE_AGREEMENT"
"ARTICLES_OF_INCORPORATION"
"OPERATING_AGREEMENT"
"PARTNERSHIP_AGREEMENT"
"ACCOUNT_DOCUMENTATION_STATEMENT"
"TAX_ID_CONFIRMATION"
"GIFT_TAX_RETURN"
"INCOME_TAX_RETURN"
"TAX_RECEIPT"
"TAX_FILING"
"CORPORATE_BYLAWS"
"LLC_AGREEMENT"
"LLC_AGREEMENT_AMENDMENT"
"OPERATING_AGREEMENT_AMENDMENT"
"PARTNERSHIP_AGREEMENT_AMENDMENT"
"SHAREHOLDERS_AGREEMENT"
"STATE_BUSINESS_FILING"
"LOGGED_CONTRIBUTION"
"LOGGED_DISTRIBUTION"
"INSURANCE_POLICY"
"CRUMMEY_LETTER"
"INSURANCE_PREMIUM_PAYMENT"
"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"
"FINCEN_FILING"
"HEALTHCARE_PROXY"
"LIVING_WILL"
"DRIVERS_LICENSE"
"PASSPORT"
"DEED"
"OTHER"
class DocumentGetSummariesResponse: …
data: List[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

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

Format of the summary content

One of the following:
"MARKDOWN"
"PLAIN_TEXT"