curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/workers/tools \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/workers/tools', 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/workers/tools"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Successful request"
},
"data": {
"tools": [
{
"name": "create_task",
"label": "Created task",
"display_name": null,
"description": "Create a follow-up task for the organization, linked to the company, people and deal.",
"source": "builtin",
"is_internal": true,
"action_id": null,
"provider": null,
"risk": "write_crm",
"review_type": "task",
"common": false,
"is_hidden": false,
"input": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Short imperative title, e.g. 'Send revised quote to Contoso'",
"minLength": 2,
"maxLength": 200
},
"priority": {
"type": "string",
"enum": [
"low",
"medium",
"high",
"urgent",
"none"
],
"default": "medium"
}
},
"required": [
"title"
]
},
"output": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"default": true,
"description": "Whether the change was applied"
},
"id": {
"type": "string",
"nullable": true,
"description": "Id of the record created or changed"
}
}
}
},
{
"name": "web_search",
"label": "Searched the web",
"display_name": null,
"description": "Search the web and read pages to answer a question with sources.",
"source": "builtin",
"is_internal": true,
"action_id": null,
"provider": null,
"risk": "read",
"review_type": "web_search",
"common": false,
"is_hidden": false,
"input": {
"type": "object"
},
"output": {
"type": "object"
}
},
{
"name": "schedule_meeting",
"label": "Scheduled meeting",
"display_name": "Schedule Meeting",
"description": "Put a meeting on the calendar and invite the guests: a one-time or a repeating event, timed or all day, with a video call link created with it unless it is in person.",
"source": "action",
"is_internal": false,
"action_id": "6721b2c3d4e5f6a7b8c9d0e1",
"risk": "schedule_meeting",
"review_type": "meeting_scheduled",
"common": false,
"is_hidden": false,
"integration": {
"title": "Gmail",
"iconSrc": "https://cdn.example.com/icons/gmail.svg",
"connected": true
},
"input": {
"type": "object"
},
"output": {
"type": "object"
}
}
]
}
}{
"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>"
}
}List actions
Returns every action a worker in this workspace can take. The API calls them tools. Use it to
fill toolNames and actionIds on Create a worker and Update a worker. The whole list
comes back in one response; it is not paged.
Two sources.
builtin: Heliyos’s own actions, the same in every workspace. Put thenamein the worker’stoolNames.action: your workspace’s actions, performed by a connected app, such as sending email or booking meetings through the connected mailbox, or working with files in connected storage. Put theaction_idin the worker’sactionIds.
What a worker gets. A worker can use every action with common: true, plus the builtin
actions named in toolNames and the actions in actionIds. A name in toolNames that is not
in this list is saved but ignored when the worker runs. Each id in actionIds must be an action
of this workspace (404 otherwise). Leave out actions with is_hidden: true.
Connected apps. An action with an integration needs that app connected to work.
integration.connected says whether it is connected now; the action is listed either way.
Reviews. risk decides whether a call waits for a person: reads and writes to companies,
people, tasks and notes apply directly; deal changes, sending email, meetings and changes in
connected apps wait for review unless the workspace’s autopilot settings allow them, and even
then a call below the confidence threshold waits. send_email is only available to workers
while the workspace sends email automatically; otherwise workers draft with
create_email_draft and the draft waits for review, where approving it sends it.
input holds each action’s full JSON Schema, so the response can be large.
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/workers/tools \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/workers/tools', 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/workers/tools"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Successful request"
},
"data": {
"tools": [
{
"name": "create_task",
"label": "Created task",
"display_name": null,
"description": "Create a follow-up task for the organization, linked to the company, people and deal.",
"source": "builtin",
"is_internal": true,
"action_id": null,
"provider": null,
"risk": "write_crm",
"review_type": "task",
"common": false,
"is_hidden": false,
"input": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Short imperative title, e.g. 'Send revised quote to Contoso'",
"minLength": 2,
"maxLength": 200
},
"priority": {
"type": "string",
"enum": [
"low",
"medium",
"high",
"urgent",
"none"
],
"default": "medium"
}
},
"required": [
"title"
]
},
"output": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"default": true,
"description": "Whether the change was applied"
},
"id": {
"type": "string",
"nullable": true,
"description": "Id of the record created or changed"
}
}
}
},
{
"name": "web_search",
"label": "Searched the web",
"display_name": null,
"description": "Search the web and read pages to answer a question with sources.",
"source": "builtin",
"is_internal": true,
"action_id": null,
"provider": null,
"risk": "read",
"review_type": "web_search",
"common": false,
"is_hidden": false,
"input": {
"type": "object"
},
"output": {
"type": "object"
}
},
{
"name": "schedule_meeting",
"label": "Scheduled meeting",
"display_name": "Schedule Meeting",
"description": "Put a meeting on the calendar and invite the guests: a one-time or a repeating event, timed or all day, with a video call link created with it unless it is in person.",
"source": "action",
"is_internal": false,
"action_id": "6721b2c3d4e5f6a7b8c9d0e1",
"risk": "schedule_meeting",
"review_type": "meeting_scheduled",
"common": false,
"is_hidden": false,
"integration": {
"title": "Gmail",
"iconSrc": "https://cdn.example.com/icons/gmail.svg",
"connected": true
},
"input": {
"type": "object"
},
"output": {
"type": "object"
}
}
]
}
}{
"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>"
}
}heliyos_triggers_list, heliyos_workers_tools_list.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.
Was this page helpful?

