Skip to content
Luminary Luminary Luminary
Get started
API Reference
Document Summaries

List all document summaries

document_summaries.list(DocumentSummaryListParams**kwargs) -> SyncCursorPagination[DocumentSummary]
get/document-summaries

Retrieve a paginated list of document summaries using cursor-based pagination

ParametersExpand Collapse
after: Optional[str]

Cursor for forward pagination. Returns items after this cursor.

before: Optional[str]

Cursor for backward pagination. Returns items before this cursor.

document_id: Optional[str]

Filter summaries by document ID

household_id: Optional[str]

Filter summaries by household ID

limit: Optional[int]

Maximum number of items to return

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

client = Luminary()
page = client.document_summaries.list()
page = page.data[0]
print(page.id)
{
  "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"
    }
  ],
  "page_info": {
    "has_next_page": true,
    "has_previous_page": false,
    "end_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9",
    "start_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9"
  },
  "total_count": 100
}
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"
    }
  ],
  "page_info": {
    "has_next_page": true,
    "has_previous_page": false,
    "end_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9",
    "start_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9"
  },
  "total_count": 100
}