> ## Documentation Index
> Fetch the complete documentation index at: https://superdoc-caio-pizzol-docs-ai-core-preset.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# comments.create

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

## 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, including the new comment id; reports NO\_OP if the anchor target is invalid.

## Input fields

| Field             | Type                                                                       | Required | Description                                                                  |
| ----------------- | -------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------- |
| `parentCommentId` | string                                                                     | no       |                                                                              |
| `target`          | TextAddress \| TextTarget \| SelectionTarget \| CommentTrackedChangeTarget | no       | One of: TextAddress, TextTarget, SelectionTarget, CommentTrackedChangeTarget |
| `text`            | string                                                                     | yes      |                                                                              |

### Example request

```json theme={null}
{
  "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      |
| ---------- | ---------------- | -------- | ---------------- |
| `id`       | string           | yes      |                  |
| `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

```json theme={null}
{
  "id": "id-001",
  "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

<Accordion title="Raw input schema">
  ```json theme={null}
  {
    "additionalProperties": false,
    "properties": {
      "parentCommentId": {
        "description": "Parent comment ID for creating a threaded reply.",
        "type": "string"
      },
      "target": {
        "description": "Comment target. Accepts a TextAddress, TextTarget, SelectionTarget, or {trackedChangeId, kind?:'trackedChange'} to anchor directly on tracked content.",
        "oneOf": [
          {
            "$ref": "#/$defs/TextAddress"
          },
          {
            "$ref": "#/$defs/TextTarget"
          },
          {
            "$ref": "#/$defs/SelectionTarget"
          },
          {
            "$ref": "#/$defs/CommentTrackedChangeTarget"
          }
        ]
      },
      "text": {
        "description": "Comment text content.",
        "type": "string"
      }
    },
    "required": [
      "text"
    ],
    "type": "object"
  }
  ```
</Accordion>

<Accordion title="Raw output schema">
  ```json theme={null}
  {
    "oneOf": [
      {
        "$ref": "#/$defs/CommentsCreateSuccess"
      },
      {
        "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"
      }
    ]
  }
  ```
</Accordion>

<Accordion title="Raw success schema">
  ```json theme={null}
  {
    "$ref": "#/$defs/CommentsCreateSuccess"
  }
  ```
</Accordion>

<Accordion title="Raw failure schema">
  ```json theme={null}
  {
    "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"
  }
  ```
</Accordion>