Skip to main content
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

FieldTypeRequiredDescription
unflattenListsbooleanno

ā€‹
Example request

{
  "unflattenLists": true
}

ā€‹
Output fields

No fields.

ā€‹
Example response

"example"

ā€‹
Pre-apply throws

  • None

ā€‹
Non-applied failure codes

  • None

ā€‹
Raw schemas

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

{
  "type": "string"
}