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

# Labels

> 4 tools: heliyos_labels_list, heliyos_labels_create, heliyos_labels_update, heliyos_labels_delete.

| Tool | What it does | Kind |
| - | - | - |
| [`heliyos_labels_list`](#heliyos-labels-list) | List label groups | Read |
| [`heliyos_labels_create`](#heliyos-labels-create) | Create a label group | Write |
| [`heliyos_labels_update`](#heliyos-labels-update) | Update a label group | Destructive |
| [`heliyos_labels_delete`](#heliyos-labels-delete) | Delete a label group | Destructive |

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

**is\_active** `boolean`

Only active (true) or only inactive (false) groups.

**search** `string`

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

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

Groups 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 names and values; "detailed" returns each group's description too. One of `concise`, `detailed`.

### Returns

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

### API endpoints

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

**name** `string` *required*

Group name, for example Intent. Up to 200 characters.

**description** `string` *required*

What the group classifies; the workers read it to decide which value applies. Up to 1000 characters.

**values** `string[]`

Value names, unique within the group. Up to 100 items.

**is\_active** `boolean`

Default true.

### Returns

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

### API endpoints

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

**label\_id** `string` *required*

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

**name** `string`

Group name, for example Intent. Up to 200 characters.

**description** `string`

What the group classifies; the workers read it to decide which value applies. Up to 1000 characters.

**is\_active** `boolean`

true to let the workers apply the group, false to pause it without deleting it.

**values** `object[]`

The complete list of values the group should have afterwards; it replaces the current values. Up to 100 items.

**item properties**

**id** `string`

The existing value's id, to keep it. Omitting it creates a new value with a new id. Up to 100 characters.

**name** `string` *required*

The value's name, unique within the group. Up to 100 characters.

### Returns

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

### API endpoints

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

**label\_id** `string` *required*

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

### Returns

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

### API endpoints

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


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