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

Selection operations

ReferenceSelection

Selection operations

Read the editor's current selection as a portable, addressable target.

This page

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

Use with AI

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

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

Filter operations in this namespace

Operations

selection.currentRead the editor's current selection as a portable SelectionInfo with text targets or V2 browser table/cell metadata. Primitive for building custom comments UIs, floating toolbars, and other selection-driven components without reaching into ProseMirror internals.read selection.extractOoxmlCapture a nonempty current or addressed selection as portable OOXML with native dependencies. Optional retain:true keeps an exact same-session restoration handle for one complete standalone body paragraph; release it when unused. Unsupported retained contexts and collaboration reject.read selection.releaseSnapshotRelease a retained exact-selection snapshot without changing document content or Undo history. Available on v2-backed sessions only; v1-backed sessions currently return `CAPABILITY_UNAVAILABLE`.read

Sections operations

Section structure and page-setup operations.

Styles operations

Document-level stylesheet mutations (docDefaults, style definitions).