Skip to main content
POST
/
v1
/
comments
Create a new comment
curl --request POST \
  --url http://localhost:3333/v1/comments \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "content": "This task needs to be completed by end of week",
  "entityId": "tsk_abc123def456",
  "entityType": "task",
  "contextUrl": "https://app.trycomp.ai/org_abc123/vendors/vnd_abc123?taskItemId=tki_abc123#task-items",
  "attachments": [
    {
      "fileName": "document.pdf",
      "fileType": "application/pdf",
      "fileData": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg==",
      "description": "Meeting notes from Q4 planning session",
      "userId": "usr_abc123def456"
    }
  ],
  "userId": "usr_abc123def456"
}
'
{
  "id": "cmt_abc123def456",
  "content": "This task needs to be completed by end of week",
  "author": {
    "id": "usr_abc123def456",
    "name": "John Doe",
    "email": "john.doe@company.com",
    "image": "https://example.com/avatar.jpg",
    "deactivated": false
  },
  "attachments": [
    {
      "id": "att_abc123def456",
      "name": "document.pdf",
      "type": "application/pdf",
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Headers

​
X-Organization-Id
string

Organization ID (required for session auth, optional for API key auth)

Body

application/json
​
content
string
required

Content of the comment

Maximum string length: 2000
Example:

"This task needs to be completed by end of week"

​
entityId
string
required

ID of the entity to comment on

Example:

"tsk_abc123def456"

​
entityType
enum<string>
required

Type of entity being commented on

Available options:
task,
vendor,
risk,
policy
Example:

"task"

​
contextUrl
string

Optional URL of the page where the comment was created, used for deep-linking in notifications

Maximum string length: 2048
Example:

"https://app.trycomp.ai/org_abc123/vendors/vnd_abc123?taskItemId=tki_abc123#task-items"

​
attachments
object[]

Optional attachments to include with the comment

​
userId
string

User ID of the comment author (required for API key auth, ignored for JWT auth)

Example:

"usr_abc123def456"

Response

201 - application/json

Comment created successfully

​
id
string
required

Unique identifier for the comment

Example:

"cmt_abc123def456"

​
content
string
required

Comment content

Example:

"This task needs to be completed by end of week"

​
author
object
required

Comment author information

​
attachments
object[]
required

Attachment metadata (URLs generated on-demand)

​
createdAt
string<date-time>
required

Comment creation timestamp

Example:

"2024-01-15T10:30:00Z"