Guides
API reference
MCP server
Changelog
Write and destructive tools change your workspace. Clients that support it ask before they run.
List notes
heliyos_notes_list · Read · Idempotent
Lists notes, newest first, optionally only those linked to one record (record_id) or matching text in the title or body. Each note shows its id, title, a short preview and the records it is linked to. Use heliyos_notes_get for the full text. Returns structuredContent {notes:[{id, title, content, links}], next_cursor}.
Inputs
string
Only notes linked to this record. A 24-character hex id.
string
Plain words matched against note titles and bodies. Symbols such as + ( ) [ ] * ? can cause an error. Up to 200 characters.
integer
default:"20"
Notes per page, 1 to 100. Default 20. From 1 to 100.
string
next_cursor from the previous page, with the same limit. Omit for the first page. Up to 200 characters.
string
default:"concise"
“concise” (default) returns a 200-character preview; “detailed” returns each note’s full text and times. One of
concise, detailed.Returns
A readable text summary, plusstructuredContent with notes, next_cursor.
API endpoints
- List notes ·
GET /v1/platform/notes
Get a note
heliyos_notes_get · Read · Idempotent
Fetches one note by id with its title, text and linked records. “concise” cuts the text at 1500 characters; “detailed” returns all of it plus created and updated times. Returns structuredContent {note}.
Inputs
string
required
note_id: a 24-character hex id. A 24-character hex id.
string
default:"concise"
“concise” (default) returns the text cut at 1500 characters; “detailed” returns the full text and times. One of
concise, detailed.Returns
A readable text summary, plusstructuredContent with note.
API endpoints
- Get a note ·
GET /v1/platform/notes/{id}
Create a note
heliyos_notes_create · Write
Creates a note, optionally linked to records (a company, person or deal) so it shows on them and can trigger workers. Calling it twice creates two notes. Returns the new note’s id as structuredContent {note}.
Inputs
string
required
Note title. Up to 500 characters.
string
Note body (plain text or simple HTML). Up to 100000 characters.
string[]
Ids of records (companies, people, deals) to link the note to, 1 to 10. Each id is checked first; an unknown id fails the call and nothing is written. Up to 10 items.
Returns
A readable text summary, plusstructuredContent with note.
API endpoints
- Create a note ·
POST /v1/platform/notes
Update a note
heliyos_notes_update · Write · Idempotent
Changes a note’s title, text or linked records by id; what you leave out is kept. record_ids REPLACES the note’s links (pass every record it should stay linked to). Returns structuredContent {note}.
Inputs
string
required
note_id: a 24-character hex id. A 24-character hex id.
string
Note title. Up to 500 characters.
string
Note body (plain text or simple HTML). Up to 100000 characters.
string[]
Ids of records (companies, people, deals) to link the note to, 1 to 10. Each id is checked first; an unknown id fails the call and nothing is written. Up to 10 items.
Returns
A readable text summary, plusstructuredContent with note.
API endpoints
- Update a note ·
PATCH /v1/platform/notes/{id}
Delete a note
heliyos_notes_delete · Destructive · Idempotent
Permanently deletes one note by id. This cannot be undone: confirm with the user first. Returns structuredContent {note_id, deleted}.
Inputs
string
required
note_id: a 24-character hex id. A 24-character hex id.
Returns
A readable text summary, plusstructuredContent with note_id, deleted.
API endpoints
- Delete a note ·
DELETE /v1/platform/notes/{id}