Creates a new note against the given entity.

post

https://example.com/v2/notes

Send a JSON body with entity_type, entity_id, note_text, and optional is_pinned /
user_id. If user_id is omitted the first agent in the entity's team is used as the author.
All notes created via Open API are of type General.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Note payload

entityType

string

enum

required

Entity types exposed via the Open API. This is a deliberate subset of Domain.Enums.EntityType;
only types that have a corresponding Open API endpoint are allowed for document operations.
Numeric values match Domain.Enums.EntityType so direct casts are safe.

entityId

int64

required

noteText

string

required

length ≥ 1

isPinned

boolean

userId

uuid | null

Optional agent id to record as the author. If omitted, the first agent in the entity's team is used.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

201The created note

400Invalid request body

401Missing or invalid API key

404The entity could not be resolved within the API key's scope