fields.insert

Insert a raw field code at a target location.

Summary

Insert a raw field code at a target location.

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

Expected result

Returns a FieldMutationResult indicating success with the field address or a failure.

Input fields

Field	Type	Required	Description
at	TextTarget	yes	TextTarget
at.kind	"text"	yes	Constant: "text"
at.segments	TextSegment[]	yes
at.story	StoryLocator	no	StoryLocator
instruction	string	yes
mode	"raw"	yes	Constant: "raw"

Example request

{
  "at": {
    "kind": "text",
    "segments": [
      {
        "blockId": "block-abc123",
        "range": {
          "end": 10,
          "start": 0
        }
      }
    ],
    "story": {
      "kind": "story",
      "storyType": "body"
    }
  },
  "instruction": "example",
  "mode": "raw"
}

Output fields

Variant 1 (success=true)

Field	Type	Required	Description
field	object(kind=“field”)	yes
field.blockId	string	yes
field.kind	"field"	yes	Constant: "field"
field.nestingDepth	integer	no
field.occurrenceIndex	integer	yes
success	true	yes	Constant: true

Variant 2 (success=false)

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

Example response

{
  "field": {
    "blockId": "block-abc123",
    "kind": "field",
    "nestingDepth": 1,
    "occurrenceIndex": 1
  },
  "success": true
}

Pre-apply throws

• TARGET_NOT_FOUND
• INVALID_TARGET
• INVALID_INPUT
• CAPABILITY_UNAVAILABLE

Non-applied failure codes

• None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "at": {
      "$ref": "#/$defs/TextTarget"
    },
    "instruction": {
      "type": "string"
    },
    "mode": {
      "const": "raw"
    }
  },
  "required": [
    "mode",
    "at",
    "instruction"
  ],
  "type": "object"
}

Raw output schema

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "field": {
          "additionalProperties": false,
          "properties": {
            "blockId": {
              "type": "string"
            },
            "kind": {
              "const": "field"
            },
            "nestingDepth": {
              "type": "integer"
            },
            "occurrenceIndex": {
              "type": "integer"
            }
          },
          "required": [
            "kind",
            "blockId",
            "occurrenceIndex"
          ],
          "type": "object"
        },
        "success": {
          "const": true
        }
      },
      "required": [
        "success",
        "field"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "type": "string"
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

Raw success schema

{
  "additionalProperties": false,
  "properties": {
    "field": {
      "additionalProperties": false,
      "properties": {
        "blockId": {
          "type": "string"
        },
        "kind": {
          "const": "field"
        },
        "nestingDepth": {
          "type": "integer"
        },
        "occurrenceIndex": {
          "type": "integer"
        }
      },
      "required": [
        "kind",
        "blockId",
        "occurrenceIndex"
      ],
      "type": "object"
    },
    "success": {
      "const": true
    }
  },
  "required": [
    "success",
    "field"
  ],
  "type": "object"
}

Raw failure schema

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