API · Endpoints

Comments

Inline comments anchored to a doc range, table cell, row, or whole workspace. The universal create endpoint accepts a discriminated target union; the legacy row-only endpoint is kept for older clients.

Generated from src/lib/api-paths/comments.ts. Body schemas come from CreateUniversalCommentSchema and CreateCommentSchema in the runtime.

post/api/workspaces/{slug}/comments

Create a comment (universal)

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

Auth: Bearer token (API key or OAuth access token).

Path parameters

NameTypeRequiredDescription
slugstringyes

Request body

FieldTypeRequiredDescription
targetobject | object | object | object | objectyes
bodystringyes
parentIdstringno
mentionsobject[]no
correlationIdstringno

Responses

StatusBodyDescription
200objectCreated.

post/api/workspaces/{slug}/rows/{id}/comments

Create a comment on a row (legacy)

Legacy row-only comment endpoint. New clients should use the universal endpoint above with `target: { kind: "row", rowId }`.

Auth: Bearer token (API key or OAuth access token).

Path parameters

NameTypeRequiredDescription
slugstringyes
idstringyes

Request body

FieldTypeRequiredDescription
bodystringyes
parentIdstringno
mentionsstring[]no

Responses

StatusBodyDescription
200objectCreated.

get/api/comments/{id}

Get a single comment

Auth: Bearer token (API key or OAuth access token).

Path parameters

NameTypeRequiredDescription
idstringyes

Responses

StatusBodyDescription
200objectComment detail.
404ErrorNot found.

delete/api/comments/{id}

Delete a comment

Author only.

Auth: Bearer token (API key or OAuth access token).

Path parameters

NameTypeRequiredDescription
idstringyes

Responses

StatusBodyDescription
200objectDeleted.
403ErrorNot the author.

post/api/comments/{id}/resolve

Resolve a comment thread

Auth: Bearer token (API key or OAuth access token).

Path parameters

NameTypeRequiredDescription
idstringyes

Responses

StatusBodyDescription
200objectResolved.

post/api/comments/{id}/unresolve

Re-open a resolved comment

Auth: Bearer token (API key or OAuth access token).

Path parameters

NameTypeRequiredDescription
idstringyes

Responses

StatusBodyDescription
200objectRe-opened.

post/api/comments/{id}/reactions

Add an emoji reaction

Auth: Bearer token (API key or OAuth access token).

Path parameters

NameTypeRequiredDescription
idstringyes

Request body

FieldTypeRequiredDescription
emojistringyes example: "👍"

Responses

StatusBodyDescription
200objectReacted.

delete/api/comments/{id}/reactions/{emoji}

Remove your reaction

Auth: Bearer token (API key or OAuth access token).

Path parameters

NameTypeRequiredDescription
idstringyes
emojistringyes

Responses

StatusBodyDescription
200objectReaction removed.