Create a new comment | Comp AI API
Create a new comment in Comp AI. Create and manage collaboration comments on compliance entities such as tasks, policies, risks, vendors, and findings.
Authorizations
API key for authentication
Body
Content of the comment (plain text or serialized Tiptap JSON). Limited to 2000 characters of visible text; maxLength bounds the serialized payload size, not the visible text.
50000"This task needs to be completed by end of week"
ID of the entity to comment on
"tsk_abc123def456"
Type of entity being commented on
task, vendor, risk, policy, finding "task"
Optional URL of the page where the comment was created, used for deep-linking in notifications
2048"https://app.trycomp.ai/org_abc123/vendors/vnd_abc123?taskItemId=tki_abc123#task-items"
Optional attachments to include with the comment
User ID of the comment author (required for API key auth, ignored for JWT auth)
"usr_abc123def456"
Response
Comment created successfully
Unique identifier for the comment
"cmt_abc123def456"
Comment content
"This task needs to be completed by end of week"
Comment author information
Attachment metadata (URLs generated on-demand)
Comment creation timestamp
"2024-01-15T10:30:00Z"

