Guides
API reference
MCP server
Changelog
Write and destructive tools change your workspace. Clients that support it ask before they run.
List label groups
heliyos_labels_list · Read · Idempotent
Lists the workspace’s classification label groups (for example Intent with values Pricing and Support) that the workers apply to emails and meetings, with each group’s id, active flag and values (each with its id). Returns structuredContent {labels:[{id, name, is_active, values:[{id, name}]}], next_cursor}.
Inputs
boolean
Only active (true) or only inactive (false) groups.
string
Plain words matched against group names. Symbols such as + ( ) [ ] * ? can cause an error. Up to 200 characters.
integer
default:"20"
Groups 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 names and values; “detailed” returns each group’s description too. One of
concise, detailed.Returns
A readable text summary, plusstructuredContent with labels, next_cursor.
API endpoints
- List label groups ·
GET /v1/platform/classification-labels
Create a label group
heliyos_labels_create · Write
Creates a classification label group with its values, for example name Intent, values [Pricing, Support]. The workers start applying it to new emails and meetings when it is active. Calling it twice creates two groups; check heliyos_labels_list first. Returns structuredContent {label}.
Inputs
string
required
Group name, for example Intent. Up to 200 characters.
string
required
What the group classifies; the workers read it to decide which value applies. Up to 1000 characters.
string[]
Value names, unique within the group. Up to 100 items.
boolean
Default true.
Returns
A readable text summary, plusstructuredContent with label.
API endpoints
- Create a label group ·
POST /v1/platform/classification-labels
Update a label group
heliyos_labels_update · Destructive · Idempotent
Changes a label group’s name, description, active flag or values by label_id. values REPLACES the group’s values: to keep a value, pass it with its existing id (shown as “Name (id …)” by heliyos_labels_list); a value without an id is created as a NEW value, even if its name matches an existing one. Values left out are removed, and emails and meetings already classified with them lose that label. Returns structuredContent {label}.
Inputs
string
required
label_id: a 24-character hex id. A 24-character hex id.
string
Group name, for example Intent. Up to 200 characters.
string
What the group classifies; the workers read it to decide which value applies. Up to 1000 characters.
boolean
true to let the workers apply the group, false to pause it without deleting it.
object[]
The complete list of values the group should have afterwards; it replaces the current values. Up to 100 items.
Returns
A readable text summary, plusstructuredContent with label.
API endpoints
- Update a label group ·
PATCH /v1/platform/classification-labels/{id}
Delete a label group
heliyos_labels_delete · Destructive · Idempotent
Permanently deletes a label group and its values by id. This cannot be undone: confirm with the user first. To stop the workers applying it but keep it, use heliyos_labels_update with is_active false. Returns structuredContent {label_id, deleted}.
Inputs
string
required
label_id: a 24-character hex id. A 24-character hex id.
Returns
A readable text summary, plusstructuredContent with label_id, deleted.
API endpoints
- Delete a label group ·
DELETE /v1/platform/classification-labels/{id}