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

Retrieve a paginated list of document summaries

ParametersExpand Collapse
document_id: Optional[str]

Filter summaries by document ID

household_id: Optional[str]

Filter summaries by household ID

limit: Optional[int]

Maximum number of summaries to return

maximum1000
minimum1
offset: Optional[int]

Number of summaries to skip

minimum0
ReturnsExpand Collapse
class DocumentSummaryListResponse: …
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

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"
List all document summaries
from withluminary import Luminary

client = Luminary()
document_summaries = client.document_summaries.list()
print(document_summaries.data)
{
  "data": [
    {
      "id": "document_summary_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "created_at": "2019-12-27T18:11:19.117Z",
      "display_name": "Default summary",
      "document_id": "document_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "summary": "summary",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "entry_mode": "AI_AUTO",
      "summary_format": "MARKDOWN"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 150
  }
}
Returns Examples
{
  "data": [
    {
      "id": "document_summary_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "created_at": "2019-12-27T18:11:19.117Z",
      "display_name": "Default summary",
      "document_id": "document_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "summary": "summary",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "entry_mode": "AI_AUTO",
      "summary_format": "MARKDOWN"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 150
  }
}