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
Capabilities101Reference
Comments505Reference
Core808Reference
Create202Reference
Format549Reference
Lists808Reference
Mutations202Reference
Query101Reference
Track Changes303Reference
Editor methodOperation
editor.doc.capabilities()capabilities.get
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.find(…)find
editor.doc.getNode(…)getNode
editor.doc.getNodeById(…)getNodeById
editor.doc.getText(…)getText
editor.doc.info(…)info
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.format.apply(…)format.apply
editor.doc.format.fontSize(…)format.fontSize
editor.doc.format.fontFamily(…)format.fontFamily
editor.doc.format.color(…)format.color
editor.doc.format.align(…)format.align
editor.doc.format.bold(…)format.apply
editor.doc.format.italic(…)format.apply
editor.doc.format.underline(…)format.apply
editor.doc.format.strikethrough(…)format.apply
editor.doc.lists.list(…)lists.list
editor.doc.lists.get(…)lists.get
editor.doc.lists.insert(…)lists.insert
editor.doc.lists.setType(…)lists.setType
editor.doc.lists.indent(…)lists.indent
editor.doc.lists.outdent(…)lists.outdent
editor.doc.lists.restart(…)lists.restart
editor.doc.lists.exit(…)lists.exit
editor.doc.mutations.preview(…)mutations.preview
editor.doc.mutations.apply(…)mutations.apply
editor.doc.query.match(…)query.match
editor.doc.trackChanges.list(…)trackChanges.list
editor.doc.trackChanges.get(…)trackChanges.get
editor.doc.trackChanges.decide(…)trackChanges.decide