Get started Editor Agents & automation Document API

909 Talk to an engineerBook a chat

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

Fields operations

ReferenceFields

Fields operations

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

This page

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

Use with AI

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

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

Filter operations in this namespace

Operations

fields.getGet detailed information about a specific field.read fields.insertInsert a raw field code at a target location, optionally preserving cached result text. The current v1 runtime supports rebuild flows; `cachedResultText` / `updatePolicy: "preserveCached"` currently return `CAPABILITY_UNAVAILABLE`.mutates fields.listList all fields in the document.read fields.rebuildRebuild (recalculate) a field.mutates fields.removeRemove a field from the document.mutates

Export operations

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

Footnotes operations

Footnote and endnote lifecycle and numbering configuration.