---
title: "Create a comment (universal)"
method: POST
path: "/api/workspaces/{slug}/comments"
tags: ["Comments"]
---

# Create a comment (universal)

`POST /api/workspaces/{slug}/comments`

## Request

- Base URL: `https://trydock.ai`
- URL: `https://trydock.ai/api/workspaces/{slug}/comments`
- Auth: HTTP bearer

Create a comment anchored to a doc range, table cell, row, or whole workspace. The `target` discriminated union picks the anchor type.

## Path parameters

- `slug` string, required

## Request body

- object
  - `target` union, required
    - object
      - `type` 'row', required
      - `rowId` string, required
    - object
      - `type` 'cell', required
      - `rowId` string, required
      - `columnKey` string, required
    - object
      - `type` 'doc_range', required
      - `surfaceSlug` string, required
      - `anchor` object, required
        - `from` integer, required
        - `to` integer, required
        - `text` string, required
    - object
      - `type` 'html_element', required
      - `surfaceSlug` string, required
      - `anchor` object, required
        - `selector` string, required
        - `text` string
    - object
      - `type` 'video_frame', required
      - `surfaceSlug` string, required
      - `anchor` object, required
        - `videoId` string, required
        - `t` number, required
        - `box` object, nullable
          - `x` number, required
          - `y` number, required
          - `w` number, required
          - `h` number, required
    - object
      - `type` 'surface', required
      - `surfaceSlug` string, required
    - object
      - `type` 'workspace', required
    - object
      - `type` 'file', required
      - `fileId` string, required
  - `body` string, required
  - `parentId` string
  - `mentions` object[]
    - `kind` 'user' | 'agent', required
    - `id` string, required
    - `label` string, required
  - `correlationId` string

## Response `200`

Created.

- object
  - `comment` object, required
    - `id` string, required
    - `body` string, required
    - `authorId` string, required
    - `authorPrincipalType` 'user' | 'agent', required
    - `parentId` string, nullable, required
    - `resolvedAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `reactions` object[]
      - `emoji` string, required
      - `count` integer, required
      - `by` string[], required: Principal ids who reacted.

---

[API](https://skmtc.dev/trydock/apis/dock-rest-api.md) - [All operations](https://skmtc.dev/trydock/apis/dock-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trydock/apis/dock-rest-api/revisions/dd96ae96a412?raw)