Editor Agents & automation Document API

909 Talk to an engineerBook a chat

Agents & automation Document API

Migrate from v1

Mental model Application data Query content Capture selection as OOXML Output projections Rich content Replace and delete Mutation plans Tracked changes Document comparison Comments Templates Style guides Receipts and errors

Mutations operations

ReferenceMutations

Mutations operations

Atomic mutation plan preview and execution.

This page

View as Markdown/md/document-api/reference/mutations.md

Use with AI

Open in ChatGPT Open in Claude All docs as one filellms-full.txt Document API referencellms-reference.txt

7 operations. Names, descriptions, and behavior flags come from the canonical contract.

Filter operations in this namespace

Operations

mutations.applyExecute a mutation plan atomically against the document.mutatestracked mutations.beginTemporaryApply temporary text and review operations without changing undo history.mutates mutations.commitTemporaryCommit the visible temporary preview as one undo entry, optionally applying final operations atomically.mutates mutations.previewDry-run a mutation plan, returning resolved targets without applying changes.read mutations.replaceTemporaryReplace an active temporary preview against its original document state.mutates mutations.rollbackTemporaryRestore the original document and release a temporary preview.mutates plan.executeExecute a compiled batch of plan-safe operation entries with per-entry transactions, capture resolution between entries, and keep-prefix-and-continue failure semantics. Hosts may support atomic: true for all-or-nothing single-commit execution with operation restrictions.mutates

Anchored Metadata operations

Attach a JSON payload to a span of text and read it back across DOCX round-trips. Backed by hidden inline content controls and namespaced Custom XML Data Storage Parts; consumers see one operation set.

Permission Ranges operations

Permission range exception operations for protected documents.