getHtml

Extract the document content as an HTML string.

Alpha: Document API is currently alpha and subject to breaking changes.

Summary

Extract the document content as an HTML string.

• Operation ID: getHtml
• API member path: editor.doc.getHtml(...)
• Mutates document: no
• Idempotency: idempotent
• Supports tracked mode: no
• Supports dry run: no
• Deterministic target resolution: yes

Expected result

Returns the full document content as an HTML-formatted string.

Input fields

Field	Type	Required	Description
unflattenLists	boolean	no

Example request

{
  "unflattenLists": true
}

Output fields

No fields.

Example response

"example"

Pre-apply throws

• None

Non-applied failure codes

• None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "unflattenLists": {
      "type": "boolean"
    }
  },
  "type": "object"
}

Raw output schema

{
  "type": "string"
}