Guides
API reference
MCP server
Changelog
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
string
default:"concise"
“concise” (default) returns each text shortened; “detailed” returns every text in full. One of
concise, detailed.Returns
A readable text summary, plusstructuredContent with knowledge.
API endpoints
- Get the knowledge base ·
GET /v1/auth/organizations/current - Update the knowledge base ·
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
string
What the business does, plain text or Markdown. An empty string clears it. Up to 100000 characters.
string
The products and services, plain text or Markdown. An empty string clears it. Up to 100000 characters.
string
The customer problems the products solve, plain text or Markdown. An empty string clears it. Up to 100000 characters.
string
Why customers choose these products, plain text or Markdown. An empty string clears it. Up to 100000 characters.
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, plusstructuredContent with knowledge.
API endpoints
- Get the knowledge base ·
GET /v1/auth/organizations/current - Update the knowledge base ·
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
string
required
The entry’s label; matched case-insensitively against the existing entries. Up to 200 characters.
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, plusstructuredContent with entry, created, entries.
API endpoints
- Get the knowledge base ·
GET /v1/auth/organizations/current - Update the knowledge base ·
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
string
required
The entry’s label; matched case-insensitively against the existing entries. Up to 200 characters.
Returns
A readable text summary, plusstructuredContent with label, deleted, entries.
API endpoints
- Get the knowledge base ·
GET /v1/auth/organizations/current - Update the knowledge base ·
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
string
knowledge_base or attachment. Omit for both. One of
knowledge_base, attachment.string
Only files attached to this record. A 24-character hex id.
string
Plain words matched against file names and types. Symbols such as + ( ) [ ] * ? can cause an error. Up to 200 characters.
integer
default:"20"
Files 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 one row per file; “detailed” returns descriptions and linked records too. One of
concise, detailed.Returns
A readable text summary, plusstructuredContent with files, next_cursor.
API endpoints
- List files ·
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
string
required
File id from heliyos_files_list. A 24-character hex id.
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, plusstructuredContent with file.
API endpoints
- Get a file ·
GET /v1/platform/attachments/{id} - Get a file download link ·
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
string
required
File name with extension, for example “pricing-2026.pdf”. Up to 200 characters.
string
The file’s content as text (UTF-8). Use content_base64 for binary files. Up to 10485760 characters.
string
The file’s bytes, base64-encoded. Up to 13985112 characters.
string
required
knowledge_base (read by the workers) or attachment. One of
knowledge_base, attachment.string
Attach the file to this record (company, person, deal). A 24-character hex id.
string
MIME type, for example “application/pdf”. Guessed from the name when omitted.
Returns
A readable text summary, plusstructuredContent with file.
API endpoints
- Create an upload URL ·
POST /v1/platform/attachments/presigned-urls - Create a file ·
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
string
required
File id from heliyos_files_list. A 24-character hex id.
Returns
A readable text summary, plusstructuredContent with file_id, deleted.
API endpoints
- Delete a file ·
DELETE /v1/platform/attachments/{id}