API v1

Notes

Free-text context attached to transactions.

Markdown version · llms.txt

GET/api/v1/notesread

list_notes

Notes attached to a transaction.

Parameters

NameTypeDescription
transactionId*uuidTransaction ID

Response

json
{ "data": [ { "id": "…", "content": "…", "createdAt": "…" } ] }
POST/api/v1/notespropose-write

attach_note

Create a proposal to attach a note. Approval required.

Request body

json
{ "transactionId": "uuid", "content": "Client project: ACME-42" }

Response

json
{ "data": { "id": "…", "status": "pending", "type": "note", … } }
PUT/api/v1/notespropose-write

create_note

Directly create a note without approval. For trusted automation only.

Request body

json
{ "transactionId": "uuid", "content": "Client project: ACME-42" }

Response

json
{ "data": { "id": "…", "content": "…", "createdAt": "…" } }

POST creates a proposal (approval required). PUT creates directly — use only for trusted automation.