Upsert Document Summary

Create or update a document summary with optional versioning.

PUT /documents/{document_id}/summary

JavaScript

JavaScript

import Morphik from 'morphik';

const client = new Morphik({
  apiKey: process.env['MORPHIK_API_KEY'], // This is the default and can be omitted
});

const summaryResponse = await client.documents.upsertSummary('document_id', { content: 'content' });

console.log(summaryResponse.content);

200

{
  "content": "<string>",
  "storage_key": "<string>",
  "version": 123,
  "bucket": "<string>",
  "updated_at": "<string>"
}

Headers

authorization · string | null

Path Parameters

document_id · string · required

Body

application/json

Request payload for writing or updating an entity summary.

content · string · required

Summary content to persist (markdown/text)

versioning · boolean · default: true

When true, automatically increments the summary version instead of overwriting the latest version

overwrite_latest · boolean · default: false

Allow overwriting the latest summary when versioning is disabled

Response

200

application/json

Successful Response

Response payload returned when reading or writing summaries.

content · string · required

storage_key · string · required

version · integer · required

bucket · string | null

updated_at · string | null