Get a worker
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/agents/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/agents/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Successful request"
},
"data": {
"_id": "6720f3a1b2c3d4e5f6a7b8c9",
"organizationId": "66a0f1e2d3c4b5a697887766",
"name": "Account researcher",
"type": "custom",
"isActive": true,
"icon": "search",
"isExcluded": false,
"description": "Researches a company before a first call and writes a brief on the record.",
"instructions": "When a meeting is booked with a new company, research it and add a note with its products, recent news and likely priorities.",
"toolName": "account_researcher",
"toolNames": [
"web_search"
],
"actionIds": [],
"toolPolicy": {
"readOnly": false
},
"memory": {
"enabled": true
},
"resources": {
"scope": "everything",
"allKbFiles": true,
"linkedKbFileIds": [],
"fileIds": []
},
"triggers": [
{
"type": "event",
"events": [
"meeting.booked"
],
"source": "user"
},
{
"type": "scheduled",
"match": {
"schedule": "0 8 * * 1",
"timezone": "Europe/Berlin"
},
"dependencies": [],
"source": "user"
}
],
"runtime": "sandbox",
"metadata": {
"created": {
"at": "2026-10-12T14:00:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
},
"updated": {
"at": "2026-11-01T09:20:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
}
},
"createdAt": "2026-10-12T14:00:00.000Z",
"updatedAt": "2026-11-01T09:20:00.000Z"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}Workers and runs
Get a worker
Returns one worker with its full instructions, tools, files and triggers.
GET
/
v1
/
platform
/
agents
/
{id}
Get a worker
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/agents/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/agents/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Successful request"
},
"data": {
"_id": "6720f3a1b2c3d4e5f6a7b8c9",
"organizationId": "66a0f1e2d3c4b5a697887766",
"name": "Account researcher",
"type": "custom",
"isActive": true,
"icon": "search",
"isExcluded": false,
"description": "Researches a company before a first call and writes a brief on the record.",
"instructions": "When a meeting is booked with a new company, research it and add a note with its products, recent news and likely priorities.",
"toolName": "account_researcher",
"toolNames": [
"web_search"
],
"actionIds": [],
"toolPolicy": {
"readOnly": false
},
"memory": {
"enabled": true
},
"resources": {
"scope": "everything",
"allKbFiles": true,
"linkedKbFileIds": [],
"fileIds": []
},
"triggers": [
{
"type": "event",
"events": [
"meeting.booked"
],
"source": "user"
},
{
"type": "scheduled",
"match": {
"schedule": "0 8 * * 1",
"timezone": "Europe/Berlin"
},
"dependencies": [],
"source": "user"
}
],
"runtime": "sandbox",
"metadata": {
"created": {
"at": "2026-10-12T14:00:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
},
"updated": {
"at": "2026-11-01T09:20:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
}
},
"createdAt": "2026-10-12T14:00:00.000Z",
"updatedAt": "2026-11-01T09:20:00.000Z"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}In the Heliyos MCP server:
heliyos_workers_create, heliyos_workers_delete, heliyos_workers_get, heliyos_workers_list, heliyos_workers_update.Authorizations
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
The worker's id.
Pattern:
^[0-9a-fA-F]{24}$Was this page helpful?

