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

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}

Update an existing document summary

ParametersExpand Collapse
id: string
body: DocumentSummaryUpdateParams { display_name, entry_mode, summary, summary_format }
display_name?: string

Display name for the summary

entry_mode?: DocumentSummaryEntryMode

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

Accepts one of the following:
"AI_AUTO"
"USER"
summary?: string

The summary text content

summary_format?: DocumentSummaryFormat

Format of the summary content

Accepts one of the following:
"MARKDOWN"
"PLAIN_TEXT"
ReturnsExpand 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"
Update a document summary
import Luminary from 'withluminary';

const client = new Luminary();

const documentSummary = await client.documentSummaries.update('id');

console.log(documentSummary.id);
{
  "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"
}
Returns Examples
{
  "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"
}