Skip to main content
PATCH
Update a worker
In the Heliyos MCP server: heliyos_workers_update.

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.

Path Parameters

id
string
required

The worker's id.

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

Body

application/json
name
string

A new name, 1 to 200 characters after trimming, unique in the workspace. Custom workers only.

Required string length: 1 - 200
description
string

A new one-line description, up to 2,000 characters.

Maximum string length: 2000
icon
string

A new icon name, up to 100 characters.

Maximum string length: 100
instructions
string

New instructions in Markdown, up to 50,000 characters. Replaces the current ones.

Maximum string length: 50000
isActive
boolean

false pauses the worker, true resumes it.

toolName
string

Accepted and ignored. A worker's toolName is fixed at create.

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

The complete list of built-in tools, up to 500. Replaces the current list. Custom workers only.

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

The complete list of workspace actions, up to 500. Replaces the current list. Custom workers only.

Maximum array length: 500

A 24-character hexadecimal id.

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

{ readOnly }. Replaces the current policy. Custom workers only.

memory
object

{ enabled }. Replaces the current memory setting.

resources
object

The worker's files. Replaces the current setting as a whole. Custom workers only.

triggers
object[]

The complete list of triggers you want, up to 50. Replaces the current ones (a default worker keeps its built-in ones).

Maximum array length: 50
schedule
object

Legacy cron list. Replaces the current one. Custom workers only. Use a scheduled trigger instead.

Response

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

meta
object
required
data
object
required