API ReferenceNotes

Create Project Note

Create a new note on a project

Note: The /projects/{project_id}/comments path will continue to work until users are notified and migrated to the new naming.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

project_idintegerRequired
Project identifier

Request

This endpoint expects an object.
bodystringRequired

Note text content.

To mention (@) a user, team, or AI agent, embed a mention token directly in the body string using the format [Display Name|~id:USER_ID]. The display-name portion is cosmetic; the trailing token is what drives the mention. A valid mention creates a feed notification (and downstream channels) for the mentioned recipient(s).

Supported tokens:

  • User: [Display Name|~id:USER_ID] — e.g. Please review [Nicolaus Copernicus|~id:99001]
  • Team: [Team Name|~team:TEAM_ID] — notifies all team members
  • AI agent: [Name|~agent:slug]

Note: the author is excluded from their own mention notifications, so mentioning the same user the API key authenticates as will not fire a notification. Mention a different user to test.

replyToIdintegerOptional
ID of the parent note to reply to. When provided, the new note is created as a threaded reply under the specified note.

Response

Note created successfully
idinteger
Note identifier
notestring
Note text content
createdAtstringformat: "date-time"
Creation timestamp
updatedAtstringformat: "date-time"
Last update timestamp

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error