Skip to main content
Document API is in alpha and subject to breaking changes while the contract continues to evolve. See the full operation reference for detailed input/output schemas.

Available operations

Use the tables below to see what operations are available and where each one is documented.
NamespaceCanonical opsAliasesTotal surfaceReference
Blocks101Reference
Bookmarks505Reference
Capabilities101Reference
Captions606Reference
Citations15015Reference
Comments505Reference
Content Controls55055Reference
Core13013Reference
Create606Reference
Cross-References505Reference
Fields505Reference
Footnotes606Reference
Format44145Reference
Headers & Footers909Reference
History303Reference
Hyperlinks606Reference
Images27027Reference
Index11011Reference
Lists29029Reference
Mutations202Reference
Paragraph Formatting17017Reference
Paragraph Styles202Reference
Query101Reference
Sections18018Reference
Styles101Reference
Table of Authorities11011Reference
Table of Contents10010Reference
Tables42042Reference
Track Changes303Reference
Editor methodOperation
editor.doc.blocks.delete(…)blocks.delete
editor.doc.bookmarks.list(…)bookmarks.list
editor.doc.bookmarks.get(…)bookmarks.get
editor.doc.bookmarks.insert(…)bookmarks.insert
editor.doc.bookmarks.rename(…)bookmarks.rename
editor.doc.bookmarks.remove(…)bookmarks.remove
editor.doc.capabilities()capabilities.get
editor.doc.captions.list(…)captions.list
editor.doc.captions.get(…)captions.get
editor.doc.captions.insert(…)captions.insert
editor.doc.captions.update(…)captions.update
editor.doc.captions.remove(…)captions.remove
editor.doc.captions.configure(…)captions.configure
editor.doc.citations.list(…)citations.list
editor.doc.citations.get(…)citations.get
editor.doc.citations.insert(…)citations.insert
editor.doc.citations.update(…)citations.update
editor.doc.citations.remove(…)citations.remove
editor.doc.citations.sources.list(…)citations.sources.list
editor.doc.citations.sources.get(…)citations.sources.get
editor.doc.citations.sources.insert(…)citations.sources.insert
editor.doc.citations.sources.update(…)citations.sources.update
editor.doc.citations.sources.remove(…)citations.sources.remove
editor.doc.citations.bibliography.get(…)citations.bibliography.get
editor.doc.citations.bibliography.insert(…)citations.bibliography.insert
editor.doc.citations.bibliography.rebuild(…)citations.bibliography.rebuild
editor.doc.citations.bibliography.configure(…)citations.bibliography.configure
editor.doc.citations.bibliography.remove(…)citations.bibliography.remove
editor.doc.comments.create(…)comments.create
editor.doc.comments.patch(…)comments.patch
editor.doc.comments.delete(…)comments.delete
editor.doc.comments.get(…)comments.get
editor.doc.comments.list(…)comments.list
editor.doc.create.contentControl(…)create.contentControl
editor.doc.contentControls.list(…)contentControls.list
editor.doc.contentControls.get(…)contentControls.get
editor.doc.contentControls.listInRange(…)contentControls.listInRange
editor.doc.contentControls.selectByTag(…)contentControls.selectByTag
editor.doc.contentControls.selectByTitle(…)contentControls.selectByTitle
editor.doc.contentControls.listChildren(…)contentControls.listChildren
editor.doc.contentControls.getParent(…)contentControls.getParent
editor.doc.contentControls.wrap(…)contentControls.wrap
editor.doc.contentControls.unwrap(…)contentControls.unwrap
editor.doc.contentControls.delete(…)contentControls.delete
editor.doc.contentControls.copy(…)contentControls.copy
editor.doc.contentControls.move(…)contentControls.move
editor.doc.contentControls.patch(…)contentControls.patch
editor.doc.contentControls.setLockMode(…)contentControls.setLockMode
editor.doc.contentControls.setType(…)contentControls.setType
editor.doc.contentControls.getContent(…)contentControls.getContent
editor.doc.contentControls.replaceContent(…)contentControls.replaceContent
editor.doc.contentControls.clearContent(…)contentControls.clearContent
editor.doc.contentControls.appendContent(…)contentControls.appendContent
editor.doc.contentControls.prependContent(…)contentControls.prependContent
editor.doc.contentControls.insertBefore(…)contentControls.insertBefore
editor.doc.contentControls.insertAfter(…)contentControls.insertAfter
editor.doc.contentControls.getBinding(…)contentControls.getBinding
editor.doc.contentControls.setBinding(…)contentControls.setBinding
editor.doc.contentControls.clearBinding(…)contentControls.clearBinding
editor.doc.contentControls.getRawProperties(…)contentControls.getRawProperties
editor.doc.contentControls.patchRawProperties(…)contentControls.patchRawProperties
editor.doc.contentControls.validateWordCompatibility(…)contentControls.validateWordCompatibility
editor.doc.contentControls.normalizeWordCompatibility(…)contentControls.normalizeWordCompatibility
editor.doc.contentControls.normalizeTagPayload(…)contentControls.normalizeTagPayload
editor.doc.contentControls.text.setMultiline(…)contentControls.text.setMultiline
editor.doc.contentControls.text.setValue(…)contentControls.text.setValue
editor.doc.contentControls.text.clearValue(…)contentControls.text.clearValue
editor.doc.contentControls.date.setValue(…)contentControls.date.setValue
editor.doc.contentControls.date.clearValue(…)contentControls.date.clearValue
editor.doc.contentControls.date.setDisplayFormat(…)contentControls.date.setDisplayFormat
editor.doc.contentControls.date.setDisplayLocale(…)contentControls.date.setDisplayLocale
editor.doc.contentControls.date.setStorageFormat(…)contentControls.date.setStorageFormat
editor.doc.contentControls.date.setCalendar(…)contentControls.date.setCalendar
editor.doc.contentControls.checkbox.getState(…)contentControls.checkbox.getState
editor.doc.contentControls.checkbox.setState(…)contentControls.checkbox.setState
editor.doc.contentControls.checkbox.toggle(…)contentControls.checkbox.toggle
editor.doc.contentControls.checkbox.setSymbolPair(…)contentControls.checkbox.setSymbolPair
editor.doc.contentControls.choiceList.getItems(…)contentControls.choiceList.getItems
editor.doc.contentControls.choiceList.setItems(…)contentControls.choiceList.setItems
editor.doc.contentControls.choiceList.setSelected(…)contentControls.choiceList.setSelected
editor.doc.contentControls.repeatingSection.listItems(…)contentControls.repeatingSection.listItems
editor.doc.contentControls.repeatingSection.insertItemBefore(…)contentControls.repeatingSection.insertItemBefore
editor.doc.contentControls.repeatingSection.insertItemAfter(…)contentControls.repeatingSection.insertItemAfter
editor.doc.contentControls.repeatingSection.cloneItem(…)contentControls.repeatingSection.cloneItem
editor.doc.contentControls.repeatingSection.deleteItem(…)contentControls.repeatingSection.deleteItem
editor.doc.contentControls.repeatingSection.setAllowInsertDelete(…)contentControls.repeatingSection.setAllowInsertDelete
editor.doc.contentControls.group.wrap(…)contentControls.group.wrap
editor.doc.contentControls.group.ungroup(…)contentControls.group.ungroup
editor.doc.get(…)get
editor.doc.find(…)find
editor.doc.getNode(…)getNode
editor.doc.getNodeById(…)getNodeById
editor.doc.getText(…)getText
editor.doc.getMarkdown(…)getMarkdown
editor.doc.getHtml(…)getHtml
editor.doc.markdownToFragment(…)markdownToFragment
editor.doc.info(…)info
editor.doc.clearContent(…)clearContent
editor.doc.insert(…)insert
editor.doc.replace(…)replace
editor.doc.delete(…)delete
editor.doc.create.paragraph(…)create.paragraph
editor.doc.create.heading(…)create.heading
editor.doc.create.sectionBreak(…)create.sectionBreak
editor.doc.create.table(…)create.table
editor.doc.create.tableOfContents(…)create.tableOfContents
editor.doc.create.image(…)create.image
editor.doc.crossRefs.list(…)crossRefs.list
editor.doc.crossRefs.get(…)crossRefs.get
editor.doc.crossRefs.insert(…)crossRefs.insert
editor.doc.crossRefs.rebuild(…)crossRefs.rebuild
editor.doc.crossRefs.remove(…)crossRefs.remove
editor.doc.fields.list(…)fields.list
editor.doc.fields.get(…)fields.get
editor.doc.fields.insert(…)fields.insert
editor.doc.fields.rebuild(…)fields.rebuild
editor.doc.fields.remove(…)fields.remove
editor.doc.footnotes.list(…)footnotes.list
editor.doc.footnotes.get(…)footnotes.get
editor.doc.footnotes.insert(…)footnotes.insert
editor.doc.footnotes.update(…)footnotes.update
editor.doc.footnotes.remove(…)footnotes.remove
editor.doc.footnotes.configure(…)footnotes.configure
editor.doc.format.apply(…)format.apply
editor.doc.format.bold(…)format.bold
editor.doc.format.italic(…)format.italic
editor.doc.format.strike(…)format.strike
editor.doc.format.underline(…)format.underline
editor.doc.format.highlight(…)format.highlight
editor.doc.format.color(…)format.color
editor.doc.format.fontSize(…)format.fontSize
editor.doc.format.fontFamily(…)format.fontFamily
editor.doc.format.letterSpacing(…)format.letterSpacing
editor.doc.format.vertAlign(…)format.vertAlign
editor.doc.format.position(…)format.position
editor.doc.format.dstrike(…)format.dstrike
editor.doc.format.smallCaps(…)format.smallCaps
editor.doc.format.caps(…)format.caps
editor.doc.format.shading(…)format.shading
editor.doc.format.border(…)format.border
editor.doc.format.outline(…)format.outline
editor.doc.format.shadow(…)format.shadow
editor.doc.format.emboss(…)format.emboss
editor.doc.format.imprint(…)format.imprint
editor.doc.format.charScale(…)format.charScale
editor.doc.format.kerning(…)format.kerning
editor.doc.format.vanish(…)format.vanish
editor.doc.format.webHidden(…)format.webHidden
editor.doc.format.specVanish(…)format.specVanish
editor.doc.format.rtl(…)format.rtl
editor.doc.format.cs(…)format.cs
editor.doc.format.bCs(…)format.bCs
editor.doc.format.iCs(…)format.iCs
editor.doc.format.eastAsianLayout(…)format.eastAsianLayout
editor.doc.format.em(…)format.em
editor.doc.format.fitText(…)format.fitText
editor.doc.format.snapToGrid(…)format.snapToGrid
editor.doc.format.lang(…)format.lang
editor.doc.format.oMath(…)format.oMath
editor.doc.format.rStyle(…)format.rStyle
editor.doc.format.rFonts(…)format.rFonts
editor.doc.format.fontSizeCs(…)format.fontSizeCs
editor.doc.format.ligatures(…)format.ligatures
editor.doc.format.numForm(…)format.numForm
editor.doc.format.numSpacing(…)format.numSpacing
editor.doc.format.stylisticSets(…)format.stylisticSets
editor.doc.format.contextualAlternates(…)format.contextualAlternates
editor.doc.format.strikethrough(…)format.strike
editor.doc.headerFooters.list(…)headerFooters.list
editor.doc.headerFooters.get(…)headerFooters.get
editor.doc.headerFooters.resolve(…)headerFooters.resolve
editor.doc.headerFooters.refs.set(…)headerFooters.refs.set
editor.doc.headerFooters.refs.clear(…)headerFooters.refs.clear
editor.doc.headerFooters.refs.setLinkedToPrevious(…)headerFooters.refs.setLinkedToPrevious
editor.doc.headerFooters.parts.list(…)headerFooters.parts.list
editor.doc.headerFooters.parts.create(…)headerFooters.parts.create
editor.doc.headerFooters.parts.delete(…)headerFooters.parts.delete
editor.doc.history.get(…)history.get
editor.doc.history.undo(…)history.undo
editor.doc.history.redo(…)history.redo
editor.doc.hyperlinks.list(…)hyperlinks.list
editor.doc.hyperlinks.get(…)hyperlinks.get
editor.doc.hyperlinks.wrap(…)hyperlinks.wrap
editor.doc.hyperlinks.insert(…)hyperlinks.insert
editor.doc.hyperlinks.patch(…)hyperlinks.patch
editor.doc.hyperlinks.remove(…)hyperlinks.remove
editor.doc.images.list(…)images.list
editor.doc.images.get(…)images.get
editor.doc.images.delete(…)images.delete
editor.doc.images.move(…)images.move
editor.doc.images.convertToInline(…)images.convertToInline
editor.doc.images.convertToFloating(…)images.convertToFloating
editor.doc.images.setSize(…)images.setSize
editor.doc.images.setWrapType(…)images.setWrapType
editor.doc.images.setWrapSide(…)images.setWrapSide
editor.doc.images.setWrapDistances(…)images.setWrapDistances
editor.doc.images.setPosition(…)images.setPosition
editor.doc.images.setAnchorOptions(…)images.setAnchorOptions
editor.doc.images.setZOrder(…)images.setZOrder
editor.doc.images.scale(…)images.scale
editor.doc.images.setLockAspectRatio(…)images.setLockAspectRatio
editor.doc.images.rotate(…)images.rotate
editor.doc.images.flip(…)images.flip
editor.doc.images.crop(…)images.crop
editor.doc.images.resetCrop(…)images.resetCrop
editor.doc.images.replaceSource(…)images.replaceSource
editor.doc.images.setAltText(…)images.setAltText
editor.doc.images.setDecorative(…)images.setDecorative
editor.doc.images.setName(…)images.setName
editor.doc.images.setHyperlink(…)images.setHyperlink
editor.doc.images.insertCaption(…)images.insertCaption
editor.doc.images.updateCaption(…)images.updateCaption
editor.doc.images.removeCaption(…)images.removeCaption
editor.doc.index.list(…)index.list
editor.doc.index.get(…)index.get
editor.doc.index.insert(…)index.insert
editor.doc.index.configure(…)index.configure
editor.doc.index.rebuild(…)index.rebuild
editor.doc.index.remove(…)index.remove
editor.doc.index.entries.list(…)index.entries.list
editor.doc.index.entries.get(…)index.entries.get
editor.doc.index.entries.insert(…)index.entries.insert
editor.doc.index.entries.update(…)index.entries.update
editor.doc.index.entries.remove(…)index.entries.remove
editor.doc.lists.list(…)lists.list
editor.doc.lists.get(…)lists.get
editor.doc.lists.insert(…)lists.insert
editor.doc.lists.create(…)lists.create
editor.doc.lists.attach(…)lists.attach
editor.doc.lists.detach(…)lists.detach
editor.doc.lists.indent(…)lists.indent
editor.doc.lists.outdent(…)lists.outdent
editor.doc.lists.join(…)lists.join
editor.doc.lists.canJoin(…)lists.canJoin
editor.doc.lists.separate(…)lists.separate
editor.doc.lists.setLevel(…)lists.setLevel
editor.doc.lists.setValue(…)lists.setValue
editor.doc.lists.continuePrevious(…)lists.continuePrevious
editor.doc.lists.canContinuePrevious(…)lists.canContinuePrevious
editor.doc.lists.setLevelRestart(…)lists.setLevelRestart
editor.doc.lists.convertToText(…)lists.convertToText
editor.doc.lists.applyTemplate(…)lists.applyTemplate
editor.doc.lists.applyPreset(…)lists.applyPreset
editor.doc.lists.setType(…)lists.setType
editor.doc.lists.captureTemplate(…)lists.captureTemplate
editor.doc.lists.setLevelNumbering(…)lists.setLevelNumbering
editor.doc.lists.setLevelBullet(…)lists.setLevelBullet
editor.doc.lists.setLevelPictureBullet(…)lists.setLevelPictureBullet
editor.doc.lists.setLevelAlignment(…)lists.setLevelAlignment
editor.doc.lists.setLevelIndents(…)lists.setLevelIndents
editor.doc.lists.setLevelTrailingCharacter(…)lists.setLevelTrailingCharacter
editor.doc.lists.setLevelMarkerFont(…)lists.setLevelMarkerFont
editor.doc.lists.clearLevelOverrides(…)lists.clearLevelOverrides
editor.doc.mutations.preview(…)mutations.preview
editor.doc.mutations.apply(…)mutations.apply
editor.doc.format.paragraph.resetDirectFormatting(…)format.paragraph.resetDirectFormatting
editor.doc.format.paragraph.setAlignment(…)format.paragraph.setAlignment
editor.doc.format.paragraph.clearAlignment(…)format.paragraph.clearAlignment
editor.doc.format.paragraph.setIndentation(…)format.paragraph.setIndentation
editor.doc.format.paragraph.clearIndentation(…)format.paragraph.clearIndentation
editor.doc.format.paragraph.setSpacing(…)format.paragraph.setSpacing
editor.doc.format.paragraph.clearSpacing(…)format.paragraph.clearSpacing
editor.doc.format.paragraph.setKeepOptions(…)format.paragraph.setKeepOptions
editor.doc.format.paragraph.setOutlineLevel(…)format.paragraph.setOutlineLevel
editor.doc.format.paragraph.setFlowOptions(…)format.paragraph.setFlowOptions
editor.doc.format.paragraph.setTabStop(…)format.paragraph.setTabStop
editor.doc.format.paragraph.clearTabStop(…)format.paragraph.clearTabStop
editor.doc.format.paragraph.clearAllTabStops(…)format.paragraph.clearAllTabStops
editor.doc.format.paragraph.setBorder(…)format.paragraph.setBorder
editor.doc.format.paragraph.clearBorder(…)format.paragraph.clearBorder
editor.doc.format.paragraph.setShading(…)format.paragraph.setShading
editor.doc.format.paragraph.clearShading(…)format.paragraph.clearShading
editor.doc.styles.paragraph.setStyle(…)styles.paragraph.setStyle
editor.doc.styles.paragraph.clearStyle(…)styles.paragraph.clearStyle
editor.doc.query.match(…)query.match
editor.doc.sections.list(…)sections.list
editor.doc.sections.get(…)sections.get
editor.doc.sections.setBreakType(…)sections.setBreakType
editor.doc.sections.setPageMargins(…)sections.setPageMargins
editor.doc.sections.setHeaderFooterMargins(…)sections.setHeaderFooterMargins
editor.doc.sections.setPageSetup(…)sections.setPageSetup
editor.doc.sections.setColumns(…)sections.setColumns
editor.doc.sections.setLineNumbering(…)sections.setLineNumbering
editor.doc.sections.setPageNumbering(…)sections.setPageNumbering
editor.doc.sections.setTitlePage(…)sections.setTitlePage
editor.doc.sections.setOddEvenHeadersFooters(…)sections.setOddEvenHeadersFooters
editor.doc.sections.setVerticalAlign(…)sections.setVerticalAlign
editor.doc.sections.setSectionDirection(…)sections.setSectionDirection
editor.doc.sections.setHeaderFooterRef(…)sections.setHeaderFooterRef
editor.doc.sections.clearHeaderFooterRef(…)sections.clearHeaderFooterRef
editor.doc.sections.setLinkToPrevious(…)sections.setLinkToPrevious
editor.doc.sections.setPageBorders(…)sections.setPageBorders
editor.doc.sections.clearPageBorders(…)sections.clearPageBorders
editor.doc.styles.apply(…)styles.apply
editor.doc.authorities.list(…)authorities.list
editor.doc.authorities.get(…)authorities.get
editor.doc.authorities.insert(…)authorities.insert
editor.doc.authorities.configure(…)authorities.configure
editor.doc.authorities.rebuild(…)authorities.rebuild
editor.doc.authorities.remove(…)authorities.remove
editor.doc.authorities.entries.list(…)authorities.entries.list
editor.doc.authorities.entries.get(…)authorities.entries.get
editor.doc.authorities.entries.insert(…)authorities.entries.insert
editor.doc.authorities.entries.update(…)authorities.entries.update
editor.doc.authorities.entries.remove(…)authorities.entries.remove
editor.doc.toc.list(…)toc.list
editor.doc.toc.get(…)toc.get
editor.doc.toc.configure(…)toc.configure
editor.doc.toc.update(…)toc.update
editor.doc.toc.remove(…)toc.remove
editor.doc.toc.markEntry(…)toc.markEntry
editor.doc.toc.unmarkEntry(…)toc.unmarkEntry
editor.doc.toc.listEntries(…)toc.listEntries
editor.doc.toc.getEntry(…)toc.getEntry
editor.doc.toc.editEntry(…)toc.editEntry
editor.doc.tables.convertFromText(…)tables.convertFromText
editor.doc.tables.delete(…)tables.delete
editor.doc.tables.clearContents(…)tables.clearContents
editor.doc.tables.move(…)tables.move
editor.doc.tables.split(…)tables.split
editor.doc.tables.convertToText(…)tables.convertToText
editor.doc.tables.setLayout(…)tables.setLayout
editor.doc.tables.insertRow(…)tables.insertRow
editor.doc.tables.deleteRow(…)tables.deleteRow
editor.doc.tables.setRowHeight(…)tables.setRowHeight
editor.doc.tables.distributeRows(…)tables.distributeRows
editor.doc.tables.setRowOptions(…)tables.setRowOptions
editor.doc.tables.insertColumn(…)tables.insertColumn
editor.doc.tables.deleteColumn(…)tables.deleteColumn
editor.doc.tables.setColumnWidth(…)tables.setColumnWidth
editor.doc.tables.distributeColumns(…)tables.distributeColumns
editor.doc.tables.insertCell(…)tables.insertCell
editor.doc.tables.deleteCell(…)tables.deleteCell
editor.doc.tables.mergeCells(…)tables.mergeCells
editor.doc.tables.unmergeCells(…)tables.unmergeCells
editor.doc.tables.splitCell(…)tables.splitCell
editor.doc.tables.setCellProperties(…)tables.setCellProperties
editor.doc.tables.sort(…)tables.sort
editor.doc.tables.setAltText(…)tables.setAltText
editor.doc.tables.setStyle(…)tables.setStyle
editor.doc.tables.clearStyle(…)tables.clearStyle
editor.doc.tables.setStyleOption(…)tables.setStyleOption
editor.doc.tables.setBorder(…)tables.setBorder
editor.doc.tables.clearBorder(…)tables.clearBorder
editor.doc.tables.applyBorderPreset(…)tables.applyBorderPreset
editor.doc.tables.setShading(…)tables.setShading
editor.doc.tables.clearShading(…)tables.clearShading
editor.doc.tables.setTablePadding(…)tables.setTablePadding
editor.doc.tables.setCellPadding(…)tables.setCellPadding
editor.doc.tables.setCellSpacing(…)tables.setCellSpacing
editor.doc.tables.clearCellSpacing(…)tables.clearCellSpacing
editor.doc.tables.get(…)tables.get
editor.doc.tables.getCells(…)tables.getCells
editor.doc.tables.getProperties(…)tables.getProperties
editor.doc.tables.getStyles(…)tables.getStyles
editor.doc.tables.setDefaultStyle(…)tables.setDefaultStyle
editor.doc.tables.clearDefaultStyle(…)tables.clearDefaultStyle
editor.doc.trackChanges.list(…)trackChanges.list
editor.doc.trackChanges.get(…)trackChanges.get
editor.doc.trackChanges.decide(…)trackChanges.decide