Skip to navigation
Runtype APIProducts

Start a product comment thread

Start a comment thread on one element of the product canvas with its first comment. The author is the caller's credential.

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired

Request

This endpoint expects an object.
anchorstringRequiredformat: "^[a-z][a-z-]*:\S+$"1-512 characters

The canvas element to comment on: entity:<id>, step:<flow>/<step>, edge:<from>/<to>, block:<block>[/<key>]

bodystringRequired1-10000 characters

The comment text; backticks mark code and @name a mention

mentionslist of stringsOptional

What the body names with @: assistant, or a teammate as their name was inserted

Response

Thread started
anchorstring

The canvas element the thread is on; the thread outlives it when that element is removed

createdAtstring
createdByUserIdstring or null
idstring
messageslist of objects
Oldest first
productIdstring
resolvedboolean
resolvedAtstring or null
resolvedByUserIdstring or null
updatedAtstring

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error