List all document summaries

get/document-summaries

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

Query ParametersExpand Collapse

after: optional string

Cursor for forward pagination. Returns items after this cursor.

before: optional string

Cursor for backward pagination. Returns items before this cursor.

document_id: optional string

Filter summaries by document ID

household_id: optional string

Filter summaries by household ID

limit: optional number

Maximum number of items to return

maximum1000

minimum1

ReturnsExpand Collapse

data: array of 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: 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"

page_info: 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: optional string

Cursor pointing to the last item in the current page

start_cursor: optional string

Cursor pointing to the first item in the current page

total_count: number

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

List all document summaries

curl https://$WITHLUMINARY_SUBDOMAIN.withluminary.com/api/public/v1/document-summaries

{
  "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
}