comments.create

Create a new comment thread (or reply when parentCommentId is given).

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

Summary

Create a new comment thread (or reply when parentCommentId is given).

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

Expected result

Returns a Receipt confirming the comment was created; reports NO_OP if the anchor target is invalid.

Input fields

Field	Type	Required	Description
parentCommentId	string	no
target	TextAddress	no	TextAddress
target.blockId	string	no
target.kind	"text"	no	Constant: "text"
target.range	Range	no	Range
target.range.end	integer	no
target.range.start	integer	no
text	string	yes

Example request

{
  "parentCommentId": "comment-000",
  "target": {
    "blockId": "block-abc123",
    "kind": "text",
    "range": {
      "end": 10,
      "start": 0
    }
  },
  "text": "Hello, world."
}

Output fields

Variant 1 (success=true)

Field	Type	Required	Description
inserted	EntityAddress[]	no
removed	EntityAddress[]	no
success	true	yes	Constant: true
updated	EntityAddress[]	no

Variant 2 (success=false)

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

Example response

{
  "inserted": [
    {
      "entityId": "entity-789",
      "entityType": "comment",
      "kind": "entity"
    }
  ],
  "success": true,
  "updated": [
    {
      "entityId": "entity-789",
      "entityType": "comment",
      "kind": "entity"
    }
  ]
}

Pre-apply throws

• TARGET_NOT_FOUND
• CAPABILITY_UNAVAILABLE
• INVALID_TARGET

Non-applied failure codes

• INVALID_TARGET
• NO_OP

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "parentCommentId": {
      "type": "string"
    },
    "target": {
      "$ref": "#/$defs/TextAddress"
    },
    "text": {
      "type": "string"
    }
  },
  "required": [
    "text"
  ],
  "type": "object"
}

Raw output schema

{
  "oneOf": [
    {
      "$ref": "#/$defs/ReceiptSuccess"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "enum": [
                "INVALID_TARGET",
                "NO_OP"
              ]
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

Raw success schema

{
  "$ref": "#/$defs/ReceiptSuccess"
}

Raw failure schema

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