create.heading

Create a new heading at the target position.

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

Summary

Create a new heading at the target position.

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

Expected result

Returns a CreateHeadingResult with the new heading block ID and address.

Input fields

Field	Type	Required	Description
at	object(kind=“documentStart”) \	object(kind=“documentEnd”) \	object(kind=“before”) \	object(kind=“after”)	no	One of: object(kind=“documentStart”), object(kind=“documentEnd”), object(kind=“before”), object(kind=“after”)
level	integer	yes
text	string	no

Example request

{
  "at": {
    "kind": "documentStart"
  },
  "level": 1,
  "text": "Hello, world."
}

Output fields

Variant 1 (heading.kind=“block”)

Field	Type	Required	Description
heading	HeadingAddress	yes	HeadingAddress
heading.kind	"block"	yes	Constant: "block"
heading.nodeId	string	yes
heading.nodeType	"heading"	yes	Constant: "heading"
insertionPoint	TextAddress	yes	TextAddress
insertionPoint.blockId	string	yes
insertionPoint.kind	"text"	yes	Constant: "text"
insertionPoint.range	Range	yes	Range
insertionPoint.range.end	integer	yes
insertionPoint.range.start	integer	yes
success	true	yes	Constant: true
trackedChangeRefs	TrackedChangeAddress[]	no

Variant 2 (success=false)

Field	Type	Required	Description
failure	object	yes
failure.code	enum	yes	"INVALID_TARGET"
failure.details	any	no
failure.message	string	yes
success	false	yes	Constant: false

Example response

{
  "heading": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "heading"
  },
  "insertionPoint": {
    "blockId": "block-abc123",
    "kind": "text",
    "range": {
      "end": 10,
      "start": 0
    }
  },
  "success": true,
  "trackedChangeRefs": [
    {
      "entityId": "entity-789",
      "entityType": "trackedChange",
      "kind": "entity"
    }
  ]
}

Pre-apply throws

• TARGET_NOT_FOUND
• CAPABILITY_UNAVAILABLE
• INVALID_TARGET
• AMBIGUOUS_TARGET

Non-applied failure codes

• INVALID_TARGET

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "at": {
      "oneOf": [
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "documentStart"
            }
          },
          "required": [
            "kind"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "documentEnd"
            }
          },
          "required": [
            "kind"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "before"
            },
            "target": {
              "$ref": "#/$defs/BlockNodeAddress"
            }
          },
          "required": [
            "kind",
            "target"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "after"
            },
            "target": {
              "$ref": "#/$defs/BlockNodeAddress"
            }
          },
          "required": [
            "kind",
            "target"
          ],
          "type": "object"
        }
      ]
    },
    "level": {
      "maximum": 6,
      "minimum": 1,
      "type": "integer"
    },
    "text": {
      "type": "string"
    }
  },
  "required": [
    "level"
  ],
  "type": "object"
}

Raw output schema

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "heading": {
          "$ref": "#/$defs/HeadingAddress"
        },
        "insertionPoint": {
          "$ref": "#/$defs/TextAddress"
        },
        "success": {
          "const": true
        },
        "trackedChangeRefs": {
          "items": {
            "$ref": "#/$defs/TrackedChangeAddress"
          },
          "type": "array"
        }
      },
      "required": [
        "success",
        "heading",
        "insertionPoint"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "enum": [
                "INVALID_TARGET"
              ]
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

Raw success schema

{
  "additionalProperties": false,
  "properties": {
    "heading": {
      "$ref": "#/$defs/HeadingAddress"
    },
    "insertionPoint": {
      "$ref": "#/$defs/TextAddress"
    },
    "success": {
      "const": true
    },
    "trackedChangeRefs": {
      "items": {
        "$ref": "#/$defs/TrackedChangeAddress"
      },
      "type": "array"
    }
  },
  "required": [
    "success",
    "heading",
    "insertionPoint"
  ],
  "type": "object"
}

Raw failure schema

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "enum": [
            "INVALID_TARGET"
          ]
        },
        "details": {},
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}