> ## Documentation Index
> Fetch the complete documentation index at: https://docs.heliyos.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Notes

> 5 tools: heliyos_notes_list, heliyos_notes_get, heliyos_notes_create, heliyos_notes_update, heliyos_notes_delete.

| Tool | What it does | Kind |
| - | - | - |
| [`heliyos_notes_list`](#heliyos-notes-list) | List notes | Read |
| [`heliyos_notes_get`](#heliyos-notes-get) | Get a note | Read |
| [`heliyos_notes_create`](#heliyos-notes-create) | Create a note | Write |
| [`heliyos_notes_update`](#heliyos-notes-update) | Update a note | Write |
| [`heliyos_notes_delete`](#heliyos-notes-delete) | Delete a note | Destructive |

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

**record\_id** `string`

Only notes linked to this record. A 24-character hex id.

**search** `string`

Plain words matched against note titles and bodies. Symbols such as + ( ) \[ ] \* ? can cause an error. Up to 200 characters.

**limit** `integer` (default: 20)

Notes per page, 1 to 100. Default 20. From 1 to 100.

**cursor** `string`

next\_cursor from the previous page, with the same limit. Omit for the first page. Up to 200 characters.

**response\_format** `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, plus `structuredContent` with `notes`, `next_cursor`.

### API endpoints

* [List notes](https://docs.heliyos.ai/api-reference/notes/list-notes.md) · `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

**note\_id** `string` *required*

note\_id: a 24-character hex id. A 24-character hex id.

**response\_format** `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, plus `structuredContent` with `note`.

### API endpoints

* [Get a note](https://docs.heliyos.ai/api-reference/notes/get-a-note.md) · `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

**title** `string` *required*

Note title. Up to 500 characters.

**content** `string`

Note body (plain text or simple HTML). Up to 100000 characters.

**record\_ids** `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, plus `structuredContent` with `note`.

### API endpoints

* [Create a note](https://docs.heliyos.ai/api-reference/notes/create-a-note.md) · `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

**note\_id** `string` *required*

note\_id: a 24-character hex id. A 24-character hex id.

**title** `string`

Note title. Up to 500 characters.

**content** `string`

Note body (plain text or simple HTML). Up to 100000 characters.

**record\_ids** `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, plus `structuredContent` with `note`.

### API endpoints

* [Update a note](https://docs.heliyos.ai/api-reference/notes/update-a-note.md) · `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

**note\_id** `string` *required*

note\_id: a 24-character hex id. A 24-character hex id.

### Returns

A readable text summary, plus `structuredContent` with `note_id`, `deleted`.

### API endpoints

* [Delete a note](https://docs.heliyos.ai/api-reference/notes/delete-a-note.md) · `DELETE /v1/platform/notes/{id}`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.