Skip to main content
POST
Create a worker
In the Heliyos MCP server: heliyos_workers_create.

Authorizations

Authorization
string
header
required

A workspace API key, sent as Authorization: Bearer heliyos_.... Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.

Body

application/json
name
string
required

The worker's name, 1 to 200 characters after trimming. Unique in the workspace.

Required string length: 1 - 200
Example:

"Account researcher"

description
string

One line on what the worker is for, up to 2,000 characters. Heliyos reads it to decide when to call the worker.

Maximum string length: 2000
Example:

"Researches a company before a first call and writes a brief on the record."

icon
string

An icon name for the Heliyos app, up to 100 characters.

Maximum string length: 100
Example:

"search"

instructions
string

What the worker does and how, in Markdown, up to 50,000 characters. Defaults to empty.

Maximum string length: 50000
Example:

"When a meeting is booked with a new company, research it and add a note with its products, recent news and likely priorities."

isActive
boolean

false creates the worker paused. Defaults to true.

toolName
string

The snake_case name Heliyos calls the worker by, 1 to 48 characters of a-z, 0-9 and _. Defaults to one made from name. Cannot be changed later.

Pattern: ^[a-z0-9_]{1,48}$
Example:

"account_researcher"

toolNames
string[]

Built-in tools the worker may use, by name. Up to 500. Defaults to none.

Maximum array length: 500
Maximum string length: 200
actionIds
string[]

Workspace actions the worker may run. Each must be an action of this workspace. Up to 500.

Maximum array length: 500

A 24-character hexadecimal id.

Pattern: ^[0-9a-fA-F]{24}$
toolPolicy
object

{ readOnly }: true lets the worker read but never change data.

memory
object

{ enabled }: whether the worker keeps memory across runs. Defaults to on.

resources
object

The files the worker reads. Merged over the defaults (scope everything, every knowledge base file).

triggers
object[]

What starts the worker, up to 50 entries. Defaults to none.

Maximum array length: 50
schedule
object

Legacy. Up to 20 cron expressions in cron. Use a scheduled trigger instead.

Response

The created worker, with the outcome of its schedule registration.

meta
object
required
data
object
required