Get started Editor Agents & automation Document API

909 Talk to an engineerBook a chat

Get started Editor Agents & automation Document API Mental model Query content Replace and delete Mutation plans Tracked changes Comments Receipts and errors

Export operations

ReferenceExport

Export operations

Modeful DOCX export (review-preserving / final / original) with a structured degradation report.

This page

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

Use with AI

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

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

Filter operations in this namespace

Operations

export.toDocxSerialize the current document to DOCX bytes under an explicit tracked-change export mode. `review-preserving` (default) keeps open tracked changes as Word revision markup, `final` resolves them as accepted, and `original` resolves them as rejected. Returns the exported bytes plus a structured degradation report of allowed warnings. An invalid mode fails closed with INVALID_INPUT before any work happens.read

Index operations

Index (TABLE OF AUTHORITIES / INDEX field) lifecycle and XE entry operations.

Fields operations

Raw field code inspection, insertion, rebuild, and removal.