Update a document summary

PUT/document-summaries/{id}

Update an existing document summary

Path ParametersExpand Collapse

id: string

Body ParametersJSONExpand Collapse

display_name: optional string

Display name for the summary

minLength1

entry_mode: optional DocumentSummaryEntryMode

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

One of the following:

"AI_AUTO"

"USER"

summary: optional string

The summary text content

summary_format: optional DocumentSummaryFormat

Format of the summary content

One of the following:

"MARKDOWN"

"PLAIN_TEXT"

ReturnsExpand Collapse

DocumentSummary object { 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

One of the following:

"AI_AUTO"

"USER"

summary_format: optional DocumentSummaryFormat

Format of the summary content

One of the following:

"MARKDOWN"

"PLAIN_TEXT"

Update a document summary

curl https://$WITHLUMINARY_SUBDOMAIN.withluminary.com/api/public/v1/document-summaries/$ID \
    -X PUT \
    -H 'Content-Type: application/json' \
    -d '{}'

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