> ## 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.

# Knowledge base and files

> 8 tools: heliyos_knowledge_get, heliyos_knowledge_update, heliyos_knowledge_entries_set, heliyos_knowledge_entries_delete, heliyos_files_list, heliyos_files_get, heliyos_files_upload, heliyos_files_delete.

| Tool | What it does | Kind |
| - | - | - |
| [`heliyos_knowledge_get`](#heliyos-knowledge-get) | Read the knowledge base | Read |
| [`heliyos_knowledge_update`](#heliyos-knowledge-update) | Update the knowledge base | Write |
| [`heliyos_knowledge_entries_set`](#heliyos-knowledge-entries-set) | Add or change a knowledge entry | Write |
| [`heliyos_knowledge_entries_delete`](#heliyos-knowledge-entries-delete) | Delete a knowledge entry | Destructive |
| [`heliyos_files_list`](#heliyos-files-list) | List files | Read |
| [`heliyos_files_get`](#heliyos-files-get) | Get a file | Read |
| [`heliyos_files_upload`](#heliyos-files-upload) | Upload a file | Write |
| [`heliyos_files_delete`](#heliyos-files-delete) | Delete a file | Destructive |

Write and destructive tools change your workspace. Clients that support it ask before they run.

## Read the knowledge base

`heliyos_knowledge_get` · **Read** · Idempotent

Returns what the workers know about the business: the business context, products information, pain points, value proposition and qualification criteria, and the team's custom entries (label and content). Texts are cut at 1500 characters in concise. Knowledge-base files are listed with heliyos\_files\_list kind knowledge\_base. Returns structuredContent \{knowledge:\{business\_context, products\_information, ..., entries}}.

### Inputs

**response\_format** `string` (default: concise)

"concise" (default) returns each text shortened; "detailed" returns every text in full. One of `concise`, `detailed`.

### Returns

A readable text summary, plus `structuredContent` with `knowledge`.

### API endpoints

* [Get the knowledge base](https://docs.heliyos.ai/api-reference/knowledge-base/get-the-knowledge-base.md) · `GET /v1/auth/organizations/current`
* [Update the knowledge base](https://docs.heliyos.ai/api-reference/knowledge-base/update-the-knowledge-base.md) · `PATCH /v1/auth/organizations/current`

## Update the knowledge base

`heliyos_knowledge_update` · **Write** · Idempotent

Changes the knowledge base's fixed texts: business\_context, products\_information, pain\_points, value\_proposition and qualification\_criteria. What you leave out is kept, and the custom entries are untouched (use heliyos\_knowledge\_entries\_set for those). Each text replaces the current one whole, so read it with heliyos\_knowledge\_get first when you mean to add to it. The workers read these on their next run. Returns structuredContent \{knowledge}.

### Inputs

**business\_context** `string`

What the business does, plain text or Markdown. An empty string clears it. Up to 100000 characters.

**products\_information** `string`

The products and services, plain text or Markdown. An empty string clears it. Up to 100000 characters.

**pain\_points** `string`

The customer problems the products solve, plain text or Markdown. An empty string clears it. Up to 100000 characters.

**value\_proposition** `string`

Why customers choose these products, plain text or Markdown. An empty string clears it. Up to 100000 characters.

**qualification\_criteria** `string`

What makes a lead worth pursuing, plain text or Markdown. An empty string clears it. Up to 100000 characters.

### Returns

A readable text summary, plus `structuredContent` with `knowledge`.

### API endpoints

* [Get the knowledge base](https://docs.heliyos.ai/api-reference/knowledge-base/get-the-knowledge-base.md) · `GET /v1/auth/organizations/current`
* [Update the knowledge base](https://docs.heliyos.ai/api-reference/knowledge-base/update-the-knowledge-base.md) · `PATCH /v1/auth/organizations/current`

## Add or change a knowledge entry

`heliyos_knowledge_entries_set` · **Write** · Idempotent

Adds a custom knowledge entry (a label and its content) or replaces the content of the entry with that label. Other entries and the fixed texts are kept. Use it for facts the fixed texts do not cover, for example "Pricing" or "Competitors". Remove one with heliyos\_knowledge\_entries\_delete. Returns structuredContent \{entry, created, entries}.

### Inputs

**label** `string` *required*

The entry's label; matched case-insensitively against the existing entries. Up to 200 characters.

**content** `string` *required*

The entry's content, plain text or HTML (the web app shows it as rich text). Replaces the current content. Up to 100000 characters.

### Returns

A readable text summary, plus `structuredContent` with `entry`, `created`, `entries`.

### API endpoints

* [Get the knowledge base](https://docs.heliyos.ai/api-reference/knowledge-base/get-the-knowledge-base.md) · `GET /v1/auth/organizations/current`
* [Update the knowledge base](https://docs.heliyos.ai/api-reference/knowledge-base/update-the-knowledge-base.md) · `PATCH /v1/auth/organizations/current`

## Delete a knowledge entry

`heliyos_knowledge_entries_delete` · **Destructive** · Idempotent

Removes one custom knowledge entry by label. The fixed texts and other entries are kept. This cannot be undone: confirm with the user first. Returns structuredContent \{label, deleted, entries}.

### Inputs

**label** `string` *required*

The entry's label; matched case-insensitively against the existing entries. Up to 200 characters.

### Returns

A readable text summary, plus `structuredContent` with `label`, `deleted`, `entries`.

### API endpoints

* [Get the knowledge base](https://docs.heliyos.ai/api-reference/knowledge-base/get-the-knowledge-base.md) · `GET /v1/auth/organizations/current`
* [Update the knowledge base](https://docs.heliyos.ai/api-reference/knowledge-base/update-the-knowledge-base.md) · `PATCH /v1/auth/organizations/current`

## List files

`heliyos_files_list` · **Read** · Idempotent

Lists files, newest first: knowledge-base files (documents the workers read, kind knowledge\_base) and attachments on records (kind attachment). Filter by kind, by the record a file is attached to (record\_id) or by name. Shows each file's id, name, kind, type and size; use heliyos\_files\_get for a download link. Returns structuredContent \{files:\[\{id, name, kind, content\_type, size\_bytes}], next\_cursor}.

### Inputs

**kind** `string`

knowledge\_base or attachment. Omit for both. One of `knowledge_base`, `attachment`.

**record\_id** `string`

Only files attached to this record. A 24-character hex id.

**search** `string`

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

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

Files 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 one row per file; "detailed" returns descriptions and linked records too. One of `concise`, `detailed`.

### Returns

A readable text summary, plus `structuredContent` with `files`, `next_cursor`.

### API endpoints

* [List files](https://docs.heliyos.ai/api-reference/files/list-files.md) · `GET /v1/platform/attachments`

## Get a file

`heliyos_files_get` · **Read** · Idempotent

Fetches one file's details by id: name, kind, type, size, description and the records it is attached to. "detailed" also returns a signed download link that expires about 60 s after the call, so use it at once. Returns structuredContent \{file}.

### Inputs

**file\_id** `string` *required*

File id from heliyos\_files\_list. A 24-character hex id.

**response\_format** `string` (default: concise)

"concise" (default) returns the file's details; "detailed" returns the details plus a download link valid for about 60 s. One of `concise`, `detailed`.

### Returns

A readable text summary, plus `structuredContent` with `file`.

### API endpoints

* [Get a file](https://docs.heliyos.ai/api-reference/files/get-a-file.md) · `GET /v1/platform/attachments/{id}`
* [Get a file download link](https://docs.heliyos.ai/api-reference/files/get-a-file-download-link.md) · `GET /v1/platform/attachments/{id}/download`

## Upload a file

`heliyos_files_upload` · **Write**

Uploads one file, up to 10 MB, as a knowledge-base file (kind knowledge\_base: documents the workers read, such as playbooks or pricing) or as an attachment (kind attachment), optionally attached to one record (record\_id). Pass the content as text (stored as UTF-8) or as content\_base64 for binary files, exactly one of the two. content\_type is guessed from the name's extension when omitted; HTML, SVG, XML, scripts and executables are refused. Calling it twice stores two files. Returns structuredContent \{file}.

### Inputs

**name** `string` *required*

File name with extension, for example "pricing-2026.pdf". Up to 200 characters.

**text** `string`

The file's content as text (UTF-8). Use content\_base64 for binary files. Up to 10485760 characters.

**content\_base64** `string`

The file's bytes, base64-encoded. Up to 13985112 characters.

**kind** `string` *required*

knowledge\_base (read by the workers) or attachment. One of `knowledge_base`, `attachment`.

**record\_id** `string`

Attach the file to this record (company, person, deal). A 24-character hex id.

**content\_type** `string`

MIME type, for example "application/pdf". Guessed from the name when omitted.

### Returns

A readable text summary, plus `structuredContent` with `file`.

### API endpoints

* [Create an upload URL](https://docs.heliyos.ai/api-reference/files/create-an-upload-url.md) · `POST /v1/platform/attachments/presigned-urls`
* [Create a file](https://docs.heliyos.ai/api-reference/files/create-a-file.md) · `POST /v1/platform/attachments`

## Delete a file

`heliyos_files_delete` · **Destructive** · Idempotent

Permanently deletes one file by id. A knowledge-base file also disappears from what the workers can read. This cannot be undone: confirm with the user first. Returns structuredContent \{file\_id, deleted}.

### Inputs

**file\_id** `string` *required*

File id from heliyos\_files\_list. A 24-character hex id.

### Returns

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

### API endpoints

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


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