Create File Note | Coperniq API

Add a note (comment) to a file, the same way you would comment on a file in the Coperniq UI.

Mention users, teams or AI agents with a token in body, for example Please review [Nicolaus Copernicus|~id:99001]. Mentioned users are notified. Reply to an existing note on the same file with replyToId.

Edit or delete a file note with PATCH / DELETE /notes/{note_id}.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

file_idstringRequired

Request

This endpoint expects an object.

bodystringRequired1-5000 characters

Note text content (1–5000 characters).

Mention (@) tokens are supported in the body string using the format [Display Name|~id:USER_ID] (users), [Team Name|~team:TEAM_ID] (teams, notifies all members), or [Name|~agent:slug] (AI agents). The display-name portion is cosmetic; the trailing token drives the mention. The author is excluded from their own mention notifications, so mention a different user than the one the API key authenticates as to test.

fileIdslist of integersOptional

Optional array of file IDs (previously uploaded) to attach to the note.

replyToIdintegerOptional

ID of a note on this file to reply to. Creates a threaded reply.

isPinnedbooleanOptionalDefaults to false

Pin the note so it stays at the top of the record’s notes in the app. Defaults to false.

Response

Note created successfully

idinteger

Note identifier

notestring

Note text content

createdAtstringformat: "date-time"

ISO 8601 creation timestamp

updatedAtstringformat: "date-time"

ISO 8601 last-updated timestamp

isPinnedboolean

Whether the note is pinned.

pinnedAtstring or nullformat: "date-time"

When the note was pinned. null when the note is not pinned.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error