comments

Create a Comment.

post/comments

Request

Base URL: https://restivity.ai/api/v1
URL: https://restivity.ai/api/v1/comments
Auth: OAuth 2 (authorization code, authorization URL https://restivity.ai/oauth/authorize, token URL https://restivity.ai/api/oauth/token, scopes: comments:write)

Request body

task_idstring uuid required

content_textstring

Plain-text body; this or content (TipTap doc) is required. The server parses its structure into the doc (blank-line paragraphs, - bullet lists, ### headings, bold and code marks) and auto-extracts mentions.

mentionsstring[]

Optional override of the auto-extracted mention list. When omitted, the server extracts mentions from the doc.

is_internalboolean

Response

The created Comment.

idstring uuid required

task_idstring uuid required

user_idstring uuid required

content_textstring required

mentionsstring[] required

is_editedboolean required

is_internalboolean required

created_atstring required

updated_atstring required

deleted_atstring nullable required

edited_atstring nullable

author_kind'user' | 'agent' | 'assistant' required

Who wrote it — derived by the server from the credential used, never from the payload: user (the person in the app), agent (an OAuth client over MCP/REST, e.g. Claude or Codex), assistant (the in-app Restivity AI). Read-only.

author_client_idstring nullable required

For agent rows: the OAuth client id the token was issued to. Read-only.

author_client_namestring nullable required

For agent rows: the OAuth client name at write time (e.g. "Claude", "Codex"), shown as "via <name>" in the thread. Read-only.

Changes

No recorded changes to this operation across all 1 revision of this API.