Changes a worker. Send at least one field; what you leave out is kept.
On a custom worker you can change name, description, icon, instructions, isActive,
toolNames, actionIds, toolPolicy, memory, resources, triggers and schedule.
On a default worker only description, icon, instructions, isActive, memory and
triggers apply. Other fields are accepted and ignored.
toolName is accepted and ignored on every worker: it never changes after create.
triggers, when sent, replaces the worker’s own triggers. On a default worker its built-in
(sourcedefault) triggers always stay: your list replaces only the ones added by people, and
events or trigger types the built-in ones already cover are dropped. Send [] to remove every
trigger you added.
resources, toolPolicy and memory are replaced as a whole when sent. Set isActive: false to
pause a worker instead of deleting it. Needs a workspace owner or admin.
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.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Heliyos","description":"Developer docs for Heliyos, the AI operating system for revenue. Build on its unified customer memory and AI workers with the REST API and the MCP server.","colors":{"primary":"#27251E","light":"#FFD037","dark":"#27251E"},"logo":{"light":"https://mintcdn.com/heliyos/j131RqihzUCqTT55/logo/light.png?fit=max\u0026auto=format\u0026n=j131RqihzUCqTT55\u0026q=85\u0026s=b4ac5cbb6af42223e13e9abe4295155d","dark":"https://mintcdn.com/heliyos/j131RqihzUCqTT55/logo/dark.png?fit=max\u0026auto=format\u0026n=j131RqihzUCqTT55\u0026q=85\u0026s=e6755b09abefd37df8199b6a504a8a54","href":"https://www.heliyos.ai"},"favicon":"https://mintcdn.com/heliyos/j131RqihzUCqTT55/favicon.png?fit=max\u0026auto=format\u0026n=j131RqihzUCqTT55\u0026q=85\u0026s=13f98b158bbf66355eb23e7f3b0468a1","api":{"params":{"expanded":"closed"},"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","javascript","python"]}},"appearance":{"default":"system","strict":false},"background":{"color":{"light":"#FAF7F3","dark":"#1E1C17"}},"navbar":{"links":[{"icon":"brand-github","href":"https://github.com/heliyos-ai","label":"GitHub"},{"icon":"brand-linkedin","href":"https://www.linkedin.com/company/heliyos","label":"LinkedIn"}],"primary":{"type":"button","label":"Join waitlist","href":"https://www.heliyos.ai"}},"seo":{"metatags":{"og:site_name":"Heliyos","og:locale":"en_US","og:type":"website","og:image":"https://www.heliyos.ai/assets/social-preview-2026-10-28.jpeg","og:image:width":"1200","og:image:height":"630","og:image:alt":"Heliyos: The AI operating system for revenue","twitter:card":"summary_large_image","twitter:image":"https://www.heliyos.ai/assets/social-preview-2026-10-28.jpeg","twitter:image:alt":"Heliyos: The AI operating system for revenue","keywords":"Heliyos API, Heliyos MCP server, AI operating system for revenue, AI workers, customer memory, CRM API, MCP server for sales","canonical":"https://docs.heliyos.ai"},"organization":{"id":"https://www.heliyos.ai/#organization","name":"Heliyos","url":"https://www.heliyos.ai","logo":"https://www.heliyos.ai/assets/brand/logo-color.png","sameAs":["https://www.heliyos.ai","https://www.linkedin.com/company/heliyos","https://github.com/heliyos-ai","https://www.npmjs.com/package/@heliyos/mcp"]},"indexing":"navigable"},"fonts":{"family":"Geist","source":"fonts/Geist-Variable.woff2","format":"woff2"},"icons":{"library":"tabler"},"styling":{"eyebrows":"section","codeblocks":"dark","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"thumbnails":{"preset":"headline","appearance":"light","surface":"neutral"},"metadata":{"timestamp":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"heliyos","hasAudioNarration":false,"actualSubdomain":"heliyos","customDomains":["docs.heliyos.ai"],"gitSource":{"type":"github","owner":"heliyos-ai","repo":"heliyos-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":"","_id":"6aec32751dd5aac17d4d14c7"},"chroma":{"latestBuiltDeploymentHistoryId":"6aecaf0264441d6863c94524","collectionId":"5c85d994-5da1-4fb6-b1f0-7110b5fe061b","liveDeploymentHistoryId":"6aecaf0264441d6863c94524","schemaVersion":"v3"},"feedback":{"thumbs":true,"edits":false,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aecb2311f2bb168c88a68bb","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API reference","count":78},{"language":"default","tag":"MCP server","count":22},{"language":"default","tag":"Tools","count":15},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Workers and runs","count":10},{"language":"default","tag":"Scouts","count":9},{"language":"default","tag":"Get started","count":7},{"language":"default","tag":"Files","count":6},{"language":"default","tag":"Records","count":6},{"language":"default","tag":"Tasks","count":6}],"searchSettings":{"showContentSnippets":true,"fullPageSearch":true,"isFiltersEnabled":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:\"Gambetta\";src:url(\"/fonts/Gambetta-Regular.woff2\") format(\"woff2\");font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:\"Gambetta\";src:url(\"/fonts/Gambetta-Italic.woff2\") format(\"woff2\");font-weight:400;font-style:italic;font-display:swap}@font-face{font-family:\"Geist\";src:url(\"/fonts/Geist-Variable.woff2\") format(\"woff2\");font-weight:100 900;font-style:normal;font-display:swap}@font-face{font-family:\"Geist Mono\";src:url(\"/fonts/GeistMono-Variable.woff2\") format(\"woff2\");font-weight:100 900;font-style:normal;font-display:swap}:root{--hy-canvas: #FAF7F3;--hy-surface: #FEFDFB;--hy-zone: #F3EEE6;--hy-line: #E1DCD3;--hy-line-strong: #D1CBC2;--hy-text: #27251E;--hy-text-body: #4A4742;--hy-text-muted: #6D6A64;--hy-code-bg: #27251E;--hy-code-line: #3A372F;--hy-sun: #FFD037;--hy-sun-soft: #FFE58F;--hy-sun-wash: #FBF1C7;--hy-sun-deep: #EBB427;--hy-sun-ink: #815C0A;--hy-ink: #14120F;--hy-icon-filter: none;--hy-get-bg: #E5F5E7;--hy-get-fg: #287C42;--hy-get-edge: #B6DDBD;--hy-post-bg: #E5F2FF;--hy-post-fg: #2D5277;--hy-post-edge: #BBD6F3;--hy-put-bg: #F4ECFE;--hy-put-fg: #594571;--hy-put-edge: #DACBEE;--hy-patch-bg: #FFECDC;--hy-patch-fg: #9C5313;--hy-patch-edge: #F6C6A0;--hy-del-bg: #FFEAE7;--hy-del-fg: #B8433A;--hy-del-edge: #F6C3BB;--hy-warn-bg: #FFECDC;--hy-warn-fg: #9C5313;--hy-warn-edge: #F6C6A0;--hy-ok-bg: #E5F5E7;--hy-ok-fg: #287C42;--hy-ok-edge: #B6DDBD;--hy-bad-bg: #FFEAE7;--hy-bad-fg: #B8433A;--hy-bad-edge: #F6C3BB}html.dark{--hy-canvas: #1E1C17;--hy-surface: #27251E;--hy-zone: #3A372F;--hy-line: #3A372F;--hy-line-strong: #4A4742;--hy-text: #F3EEE6;--hy-text-body: #EBE5DB;--hy-text-muted: #A9A49B;--hy-code-bg: #14120F;--hy-code-line: #3A372F;--hy-sun-ink: #FFE58F;--hy-icon-filter: invert(0.93) sepia(0.08);--hy-get-bg: rgba(60, 154, 88, 0.18);--hy-get-fg: #B6DDBD;--hy-get-edge: rgba(60, 154, 88, 0.45);--hy-post-bg: rgba(85, 138, 192, 0.2);--hy-post-fg: #BBD6F3;--hy-post-edge: rgba(85, 138, 192, 0.5);--hy-put-bg: rgba(148, 118, 183, 0.2);--hy-put-fg: #DACBEE;--hy-put-edge: rgba(148, 118, 183, 0.5);--hy-patch-bg: rgba(219, 125, 36, 0.18);--hy-patch-fg: #F6C6A0;--hy-patch-edge: rgba(219, 125, 36, 0.45);--hy-del-bg: rgba(208, 90, 79, 0.2);--hy-del-fg: #F6C3BB;--hy-del-edge: rgba(208, 90, 79, 0.5);--hy-warn-bg: rgba(219, 125, 36, 0.14);--hy-warn-fg: #F6C6A0;--hy-warn-edge: rgba(219, 125, 36, 0.4);--hy-ok-bg: rgba(60, 154, 88, 0.14);--hy-ok-fg: #B6DDBD;--hy-ok-edge: rgba(60, 154, 88, 0.4);--hy-bad-bg: rgba(208, 90, 79, 0.16);--hy-bad-fg: #F6C3BB;--hy-bad-edge: rgba(208, 90, 79, 0.45)}body,button,input,select,textarea{font-family:\"Geist\", system-ui, sans-serif}code,pre,kbd,.font-mono{font-family:\"Geist Mono\", ui-monospace, monospace!important}body{background:var(--hy-canvas)!important;color:var(--hy-text)}.prose{color:var(--hy-text-body)}.prose h1,.prose h2,.prose h3,.prose h4,.prose strong,#page-title{color:var(--hy-text)!important}.prose h2{letter-spacing:-0.01em}.prose a:not([class]){color:var(--hy-text);font-weight:500;text-decoration:underline;text-decoration-color:var(--hy-sun-deep);text-decoration-thickness:2px;text-underline-offset:3px;border-bottom:none}.prose a:not([class]):hover{text-decoration-color:var(--hy-text)}img[src^=\"/icons/\"]{filter:var(--hy-icon-filter)}.nav-tabs-item{color:var(--hy-text-muted)!important}.nav-tabs-item:hover{color:var(--hy-text)!important}.nav-tabs-item[data-active=\"true\"]{color:var(--hy-text)!important;font-weight:600}.nav-tabs-item [class*=\"bottom-0\"][class*=\"bg-primary\"]{background:var(--hy-sun-deep)!important;height:2px!important;border-radius:2px}#sidebar-content a{border-radius:8px;transition:background-color .12s ease}#sidebar-content a:not([aria-current=\"page\"]):hover{background:var(--hy-zone);color:var(--hy-text)!important}#sidebar-content a[aria-current=\"page\"]{background:var(--hy-sun-deep)!important;color:var(--hy-ink)!important;border-color:var(--hy-sun-deep)!important;font-weight:600;text-shadow:none!important}#sidebar-content a[aria-current=\"page\"] img[src^=\"/icons/\"]{filter:none}#sidebar-content a[aria-current=\"page\"] [class*=\"bg-[#\"]{background:var(--hy-ink)!important;color:var(--hy-sun)!important;box-shadow:none}[class*=\"bg-green-400/20\"]{background:var(--hy-get-bg)!important;color:var(--hy-get-fg)!important;box-shadow:inset 0 0 0 1px var(--hy-get-edge)}[class*=\"bg-blue-400/20\"]{background:var(--hy-post-bg)!important;color:var(--hy-post-fg)!important;box-shadow:inset 0 0 0 1px var(--hy-post-edge)}[class*=\"bg-purple-400/20\"],[class*=\"bg-yellow-400/20\"]{background:var(--hy-put-bg)!important;color:var(--hy-put-fg)!important;box-shadow:inset 0 0 0 1px var(--hy-put-edge)}[class*=\"bg-orange-400/20\"]{background:var(--hy-patch-bg)!important;color:var(--hy-patch-fg)!important;box-shadow:inset 0 0 0 1px var(--hy-patch-edge)}[class*=\"bg-red-400/20\"]{background:var(--hy-del-bg)!important;color:var(--hy-del-fg)!important;box-shadow:inset 0 0 0 1px var(--hy-del-edge)}.method-pill{letter-spacing:0.02em}.card{background:var(--hy-surface)!important;border-color:var(--hy-line)!important;border-radius:16px!important;box-shadow:none!important;transition:border-color .15s ease, box-shadow .15s ease}.card:hover{border-color:var(--hy-sun-deep)!important;box-shadow:0 8px 24px -8px rgba(39,37,30,.18), 0 2px 4px rgba(39,37,30,.05)!important}.card [class*=\"size-6\"]:has(>img){width:40px!important;height:40px!important;display:grid;place-items:center;background:var(--hy-sun-wash);border:1px solid var(--hy-sun-soft);border-radius:10px}html.dark .card [class*=\"size-6\"]:has(>img){background:rgba(255, 208, 55, 0.12);border-color:rgba(255, 208, 55, 0.3)}.card [class*=\"size-6\"]:has(>img) img{width:22px!important;height:22px!important}.card h2{color:var(--hy-text)!important}.prose :not(pre)>code{background:var(--hy-zone);border:1px solid var(--hy-line);border-radius:7px;padding:1px 6px;color:var(--hy-text);font-size:0.875em}.code-block,[class*=\"code-block\"]{background:var(--hy-code-bg)!important;border-color:var(--hy-code-line)!important;border-radius:12px!important}.prose table{border-color:var(--hy-line)}.prose thead th{background:var(--hy-zone);color:var(--hy-text-muted);font-family:\"Geist Mono\", ui-monospace, monospace;font-size:11px;font-weight:500;letter-spacing:0.04em;text-transform:uppercase}.prose td,.prose th{border-color:var(--hy-line)}.callout{border-radius:12px!important}.callout[data-callout-type=\"note\"],.callout[data-callout-type=\"info\"]{background:var(--hy-sun-wash)!important;border-color:var(--hy-sun-soft)!important;color:var(--hy-text)!important;box-shadow:inset 3px 0 0 var(--hy-sun-deep)}html.dark .callout[data-callout-type=\"note\"],html.dark .callout[data-callout-type=\"info\"]{background:rgba(255,208,55,0.10)!important;border-color:rgba(255,208,55,0.3)!important}.callout[data-callout-type=\"warning\"]{background:var(--hy-warn-bg)!important;border-color:var(--hy-warn-edge)!important;color:var(--hy-warn-fg)!important}.callout[data-callout-type=\"tip\"],.callout[data-callout-type=\"check\"]{background:var(--hy-ok-bg)!important;border-color:var(--hy-ok-edge)!important;color:var(--hy-ok-fg)!important}.callout[data-callout-type=\"danger\"]{background:var(--hy-bad-bg)!important;border-color:var(--hy-bad-edge)!important;color:var(--hy-bad-fg)!important}.callout *{color:inherit}.callout code{background:rgba(255,255,255,.55)!important}html.dark .callout code{background:rgba(0,0,0,.25)!important}.tryit-button{background:var(--hy-sun)!important;color:var(--hy-ink)!important;font-weight:600;border:1px solid var(--hy-sun-deep);border-radius:8px!important;box-shadow:inset 0 1px 0 rgba(255,255,255,.35), 0 1px 2px rgba(20,18,15,.28)}.tryit-button:hover{opacity:1!important;background:var(--hy-sun-deep)!important}.tryit-button svg,.tryit-button path{fill:var(--hy-ink)!important;color:var(--hy-ink)!important}#navbar ul>li:not(.navbar-link)>a{background:linear-gradient(180deg, #3A372F, #27251E);color:#F3EEE6!important;border:1px solid #14120F;border-radius:8px;padding:6px 12px;box-shadow:inset 0 1px 0 rgba(255,255,255,.16), 0 1px 2px rgba(20,18,15,.28)}#navbar ul>li:not(.navbar-link)>a *{color:inherit!important}html.dark #navbar ul>li:not(.navbar-link)>a{background:var(--hy-sun);color:var(--hy-ink)!important;border-color:var(--hy-sun-deep)}#navbar ul>li:not(.navbar-link)>a>span[class*=\"absolute\"]{background:transparent!important}a:focus-visible,button:focus-visible,[role=\"tab\"]:focus-visible{outline:none;box-shadow:0 0 0 2px var(--hy-canvas), 0 0 0 4px var(--hy-text)!important;border-radius:8px}body:has(.hy-hero) #header{display:none}.hy-hero{padding:8px 0 24px}.hy-eyebrow{display:inline-flex;align-items:center;gap:8px;font-family:\"Geist Mono\", ui-monospace, monospace;font-size:11px;font-weight:500;letter-spacing:0.05em;color:var(--hy-sun-ink);margin:0 0 16px;background:var(--hy-sun-wash);border:1px solid var(--hy-sun-soft);border-radius:999px;padding:4px 10px}html.dark .hy-eyebrow{background:rgba(255,208,55,0.12);border-color:rgba(255,208,55,0.3)}.hy-display{font-family:\"Gambetta\", Georgia, serif!important;font-weight:400!important;font-size:56px!important;line-height:1.05;letter-spacing:-0.02em;color:var(--hy-text)!important;margin:0 0 16px}.hy-display em{font-style:italic}.hy-lede{font-size:17px;line-height:1.6;color:var(--hy-text-body);max-width:720px;margin:0}@media (max-width: 640px){.hy-display{font-size:40px!important;line-height:1.1;letter-spacing:-0.015em}}@media (prefers-reduced-motion: reduce){*,*::before,*::after{animation:none!important;transition:none!important}}[class*=\"group/step-indicator\"]{background:var(--hy-sun)!important;color:var(--hy-ink)!important;box-shadow:inset 0 0 0 1px var(--hy-sun-deep)}.steps [class*=\"border-l\"],.steps [class*=\"w-px\"]{border-color:var(--hy-sun-soft)!important;background-color:var(--hy-sun-soft)}html.dark .steps [class*=\"border-l\"],html.dark .steps [class*=\"w-px\"]{border-color:rgba(255,208,55,0.3)!important;background-color:rgba(255,208,55,0.3)}#sidebar-content ul.sidebar-group>li>a{margin-left:22px}#sidebar-content .sidebar-group-header{color:var(--hy-text)!important;font-weight:600}.hy-picker{margin:24px 0;border:1px solid var(--hy-line);border-radius:16px;background:var(--hy-surface);overflow:hidden}.hy-picker-tabs{display:grid;grid-template-columns:repeat(auto-fit, minmax(150px, 1fr));border-bottom:1px solid var(--hy-line)}.hy-picker-tab{display:flex;align-items:center;gap:10px;padding:14px 16px;text-align:left;cursor:pointer;background:transparent;border:0;border-right:1px solid var(--hy-line);border-bottom:1px solid var(--hy-line);margin-bottom:-1px;box-shadow:inset 0 2px 0 transparent;transition:background-color .12s ease}.hy-picker-tab:hover{background:var(--hy-zone)}.hy-picker-tab.is-active{background:var(--hy-sun-wash);box-shadow:inset 0 2px 0 var(--hy-sun-deep)}html.dark .hy-picker-tab.is-active{background:rgba(255,208,55,0.12)}.hy-picker-logo{width:32px;height:32px;flex-shrink:0;display:grid;place-items:center;background:#FEFDFB;border:1px solid #E1DCD3;border-radius:8px}.hy-picker-logo img{width:18px;height:18px;filter:none!important}.hy-picker-label{display:flex;flex-direction:column;min-width:0}.hy-picker-name{font-size:14px;font-weight:600;color:var(--hy-text)}.hy-picker-hint{font-size:12px;color:var(--hy-text-muted)}.hy-picker-panel{padding:8px 20px 12px}.hy-picker-step{display:flex;gap:14px;padding:14px 0;border-top:1px solid var(--hy-line)}.hy-picker-step:first-child{border-top:0}.hy-picker-num{width:24px;height:24px;flex-shrink:0;border-radius:999px;display:grid;place-items:center;background:var(--hy-sun);color:var(--hy-ink);font-size:12px;font-weight:600;box-shadow:inset 0 0 0 1px var(--hy-sun-deep)}.hy-picker-body{flex:1;min-width:0}.hy-picker-title{margin:2px 0 4px;font-size:14px;font-weight:600;color:var(--hy-text)}.hy-picker-text{margin:0 0 8px;font-size:14px;line-height:1.5;color:var(--hy-text-body)}.hy-picker-code{position:relative}.hy-picker-code pre{margin:0;padding:14px 16px;overflow-x:auto;border-radius:10px;background:var(--hy-code-bg);color:#F3EEE6;font-size:12.5px;line-height:1.6}.hy-picker-code code{background:none!important;border:0!important;padding:0!important;color:inherit!important;white-space:pre}.hy-picker-copy{position:absolute;top:8px;right:8px;padding:3px 10px;border-radius:7px;cursor:pointer;font-size:12px;font-weight:500;color:#F3EEE6;background:#3A372F;border:1px solid #4A4742}.hy-picker-copy:hover{background:#45423A}.hy-picker-link{display:inline-flex;align-items:center;margin-top:2px;padding:6px 12px;border-radius:8px;background:var(--hy-sun);color:var(--hy-ink)!important;font-size:13px;font-weight:600;text-decoration:none!important;border:1px solid var(--hy-sun-deep)}.hy-picker-tabs{grid-template-columns:repeat(4, minmax(0, 1fr))}.hy-picker-tab:last-child:nth-child(4n+3){grid-column:span 2}.hy-picker-name{white-space:nowrap;overflow:hidden;text-overflow:ellipsis}@media (max-width: 640px){.hy-picker-tabs{grid-template-columns:repeat(2, minmax(0, 1fr))}.hy-picker-tab:last-child:nth-child(4n+3){grid-column:auto}}.hy-picker-name{white-space:normal;font-size:13.5px;line-height:1.25}.hy-picker-head{display:flex;justify-content:space-between;align-items:baseline;gap:16px;margin:24px 0 10px;font-size:14px;color:var(--hy-text-muted)}.hy-picker-head a{color:var(--hy-text)!important;font-weight:500;text-decoration:underline;text-decoration-color:var(--hy-sun-deep);text-decoration-thickness:2px;text-underline-offset:3px}.hy-picker-head+.hy-picker{margin-top:0}.hy-picker-tabs{grid-template-columns:repeat(4, minmax(0, 1fr))}.hy-picker-tab:last-child{border-right:0}.hy-client{margin:12px 0 20px}.hy-client-head{display:flex;align-items:center;gap:10px;padding:14px 20px;border-bottom:1px solid var(--hy-line);background:var(--hy-sun-wash);box-shadow:inset 0 2px 0 var(--hy-sun-deep)}html.dark .hy-client-head{background:rgba(255,208,55,0.10)}.hy-picker-code pre{padding-right:76px}#navbar a[href=\"https://github.com/heliyos-ai\"] .truncate,#navbar a[href*=\"linkedin.com/company/heliyos\"] .truncate{position:absolute;width:1px;height:1px;overflow:hidden;clip:rect(0 0 0 0);white-space:nowrap}#navbar a[href=\"https://github.com/heliyos-ai\"],#navbar a[href*=\"linkedin.com/company/heliyos\"]{padding:6px;border-radius:8px}#navbar a[href=\"https://github.com/heliyos-ai\"]:hover,#navbar a[href*=\"linkedin.com/company/heliyos\"]:hover{background:var(--hy-zone)}#navbar a[href=\"https://github.com/heliyos-ai\"] svg,#navbar a[href*=\"linkedin.com/company/heliyos\"] svg{width:18px;height:18px}#navbar ul:has(>li.navbar-link){gap:2px;align-items:center}#navbar ul:has(>li.navbar-link)>li{margin:0!important}#navbar ul:has(>li.navbar-link)>li:not(.navbar-link){order:-1;margin-right:12px!important}#navbar li.navbar-link>a{padding:6px!important}#navbar li.navbar-link>a svg{width:22px!important;height:22px!important}"}],"page":{"pagePath":"api-reference/workers-and-runs/update-a-worker","slug":"/api-reference/workers-and-runs/update-a-worker","pageMetadata":{"title":"Update a worker","description":"Changes a worker. Send at least one field; what you leave out is kept.\n\n- On a custom worker you can change `name`, `description`, `icon`, `instructions`, `isActive`,\n `toolNames`, `actionIds`, `toolPolicy`, `memory`, `resources`, `triggers` and `schedule`.\n- On a default worker only `description`, `icon`, `instructions`, `isActive`, `memory` and\n `triggers` apply. Other fields are accepted and ignored.\n- `toolName` is accepted and ignored on every worker: it never changes after create.\n\n`triggers`, when sent, replaces the worker's own triggers. On a default worker its built-in\n(`source` `default`) triggers always stay: your list replaces only the ones added by people, and\nevents or trigger types the built-in ones already cover are dropped. Send `[]` to remove every\ntrigger you added.\n\n`resources`, `toolPolicy` and `memory` are replaced as a whole when sent. Set `isActive: false` to\npause a worker instead of deleting it. Needs a workspace owner or admin.","deprecated":null,"version":null,"sidebarTitle":"Update a worker","openapi":"/api-reference/openapi.json patch /v1/platform/agents/{id}","href":"/api-reference/workers-and-runs/update-a-worker","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Changes a worker. Send at least one field; what you leave out is kept.\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"On a custom worker you can change \", _jsx(_components.code, {\n children: \"name\"\n }), \", \", _jsx(_components.code, {\n children: \"description\"\n }), \", \", _jsx(_components.code, {\n children: \"icon\"\n }), \", \", _jsx(_components.code, {\n children: \"instructions\"\n }), \", \", _jsx(_components.code, {\n children: \"isActive\"\n }), \",\\n\", _jsx(_components.code, {\n children: \"toolNames\"\n }), \", \", _jsx(_components.code, {\n children: \"actionIds\"\n }), \", \", _jsx(_components.code, {\n children: \"toolPolicy\"\n }), \", \", _jsx(_components.code, {\n children: \"memory\"\n }), \", \", _jsx(_components.code, {\n children: \"resources\"\n }), \", \", _jsx(_components.code, {\n children: \"triggers\"\n }), \" and \", _jsx(_components.code, {\n children: \"schedule\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"On a default worker only \", _jsx(_components.code, {\n children: \"description\"\n }), \", \", _jsx(_components.code, {\n children: \"icon\"\n }), \", \", _jsx(_components.code, {\n children: \"instructions\"\n }), \", \", _jsx(_components.code, {\n children: \"isActive\"\n }), \", \", _jsx(_components.code, {\n children: \"memory\"\n }), \" and\\n\", _jsx(_components.code, {\n children: \"triggers\"\n }), \" apply. Other fields are accepted and ignored.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"toolName\"\n }), \" is accepted and ignored on every worker: it never changes after create.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"triggers\"\n }), \", when sent, replaces the worker’s own triggers. On a default worker its built-in\\n(\", _jsx(_components.code, {\n children: \"source\"\n }), \" \", _jsx(_components.code, {\n children: \"default\"\n }), \") triggers always stay: your list replaces only the ones added by people, and\\nevents or trigger types the built-in ones already cover are dropped. Send \", _jsx(_components.code, {\n children: \"[]\"\n }), \" to remove every\\ntrigger you added.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"resources\"\n }), \", \", _jsx(_components.code, {\n children: \"toolPolicy\"\n }), \" and \", _jsx(_components.code, {\n children: \"memory\"\n }), \" are replaced as a whole when sent. Set \", _jsx(_components.code, {\n children: \"isActive: false\"\n }), \" to\\npause a worker instead of deleting it. Needs a workspace owner or admin.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,..._provideComponents(),...props.components},{Info}=_components;if(!Info)_missingMdxReference(`Info`,true);return _jsxs(Info,{children:[`In the Heliyos MCP server: `,_jsx(_components.a,{href:`/mcp/tools/workers-triggers-and-tools#heliyos-workers-update`,children:_jsx(_components.code,{children:`heliyos_workers_update`})}),`.`]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Update a worker","description":"Changes a worker. Send at least one field; what you leave out is kept.\n\n- On a custom worker you can change `name`, `description`, `icon`, `instructions`, `isActive`,\n `toolNames`, `actionIds`, `toolPolicy`, `memory`, `resources`, `triggers` and `schedule`.\n- On a default worker only `description`, `icon`, `instructions`, `isActive`, `memory` and\n `triggers` apply. Other fields are accepted and ignored.\n- `toolName` is accepted and ignored on every worker: it never changes after create.\n\n`triggers`, when sent, replaces the worker's own triggers. On a default worker its built-in\n(`source` `default`) triggers always stay: your list replaces only the ones added by people, and\nevents or trigger types the built-in ones already cover are dropped. Send `[]` to remove every\ntrigger you added.\n\n`resources`, `toolPolicy` and `memory` are replaced as a whole when sent. Set `isActive: false` to\npause a worker instead of deleting it. Needs a workspace owner or admin.","deprecated":null,"version":null,"sidebarTitle":"Update a worker","openapi":"/api-reference/openapi.json patch /v1/platform/agents/{id}","href":"/api-reference/workers-and-runs/update-a-worker","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"updateAgent","tags":["Workers and runs"],"parameters":["aa0657ca-e6d9-4ac8-84e0-e9764a1e54eb"],"responses":{"200":"da4d9451-43fc-4804-ab20-3271e2cc5a07","400":"c596aada-70d2-4b67-9668-33d9a58a8ec8","401":"7c9f77e7-07a8-401e-ac42-8592e9164035","403":"258c5ef9-854f-45fe-9846-9070b9458900","404":"413361d7-2393-4515-9218-fe73f6e59465","409":"460979a1-da82-412f-946a-88a46ed47304","429":"a237643e-9940-4988-ab8b-2814722b482e"},"requestBody":"fe349b93-38dc-4a46-840f-55116e66a243","summary":"Update a worker","description":"Changes a worker. Send at least one field; what you leave out is kept.\n\n- On a custom worker you can change `name`, `description`, `icon`, `instructions`, `isActive`,\n `toolNames`, `actionIds`, `toolPolicy`, `memory`, `resources`, `triggers` and `schedule`.\n- On a default worker only `description`, `icon`, `instructions`, `isActive`, `memory` and\n `triggers` apply. Other fields are accepted and ignored.\n- `toolName` is accepted and ignored on every worker: it never changes after create.\n\n`triggers`, when sent, replaces the worker's own triggers. On a default worker its built-in\n(`source` `default`) triggers always stay: your list replaces only the ones added by people, and\nevents or trigger types the built-in ones already cover are dropped. Send `[]` to remove every\ntrigger you added.\n\n`resources`, `toolPolicy` and `memory` are replaced as a whole when sent. Set `isActive: false` to\npause a worker instead of deleting it. Needs a workspace owner or admin.","x-mint":{"href":"/api-reference/workers-and-runs/update-a-worker","metadata":{},"content":"\u003cInfo>In the Heliyos MCP server: [`heliyos_workers_update`](/mcp/tools/workers-triggers-and-tools#heliyos-workers-update).\u003c/Info>"},"method":"patch","type":"path","servers":["cfb9dc49-4d79-4f5e-8469-9c9103787f1d"],"security":["24a65c4b-c280-4a52-a557-91d07005a21b"],"path":"/v1/platform/agents/{id}","baseUrlOptions":["https://api-prod.heliyos.ai"],"title":"Update a worker","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"aa0657ca-e6d9-4ac8-84e0-e9764a1e54eb":{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","isRequired":true,"description":"The worker's id.","uniqueKey":"","typeLabel":"string"},"description":"The worker's id.","example":"6720f3a1b2c3d4e5f6a7b8c9"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"A new name, 1 to 200 characters after trimming, unique in the workspace. Custom workers only.","uniqueKey":"name","typeLabel":"string"},"description":{"type":"string","maxLength":2000,"description":"A new one-line description, up to 2,000 characters.","uniqueKey":"description","typeLabel":"string"},"icon":{"type":"string","maxLength":100,"description":"A new icon name, up to 100 characters.","uniqueKey":"icon","typeLabel":"string"},"instructions":{"type":"string","maxLength":50000,"description":"New instructions in Markdown, up to 50,000 characters. Replaces the current ones.","uniqueKey":"instructions","typeLabel":"string"},"isActive":{"type":"boolean","description":"`false` pauses the worker, `true` resumes it.","uniqueKey":"isActive","typeLabel":"boolean"},"toolName":{"type":"string","pattern":"^[a-z0-9_]{1,48}$","description":"Accepted and ignored. A worker's `toolName` is fixed at create.","uniqueKey":"toolName","typeLabel":"string"},"toolNames":{"type":"array","items":{"type":"string","maxLength":200,"uniqueKey":"toolNames.items.[INDEX]","typeLabel":"string"},"maxItems":500,"description":"The complete list of built-in tools, up to 500. Replaces the current list. Custom workers only.","uniqueKey":"toolNames","typeLabel":"string[]"},"actionIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"A 24-character hexadecimal id.","example":"66f1a8c3e4b0a1b2c3d4e5f6","uniqueKey":"actionIds.items.[INDEX]","typeLabel":"string"},"maxItems":500,"description":"The complete list of workspace actions, up to 500. Replaces the current list. Custom workers only.","uniqueKey":"actionIds","typeLabel":"string[]"},"toolPolicy":{"type":"object","properties":{"readOnly":{"type":"boolean","description":"`true`: read only.","uniqueKey":"toolPolicy.readOnly","typeLabel":"boolean"}},"additionalProperties":false,"description":"`{ readOnly }`. Replaces the current policy. Custom workers only.","uniqueKey":"toolPolicy","typeLabel":"object"},"memory":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Memory on or off.","uniqueKey":"memory.enabled","typeLabel":"boolean"}},"additionalProperties":false,"description":"`{ enabled }`. Replaces the current memory setting.","uniqueKey":"memory","typeLabel":"object"},"resources":{"type":"object","description":"The worker's files. Replaces the current setting as a whole. Custom workers only.","properties":{"scope":{"type":"string","description":"The file scope picked in the Heliyos app: `everything` (the default), `org_knowledge`\n(knowledge base files), `account_files` (files on records) or `selected_files` (files you\npick). Which knowledge base files the worker reads is set by `allKbFiles` and\n`linkedKbFileIds`.\n","enum":["everything","org_knowledge","account_files","selected_files"],"uniqueKey":"resources.scope","typeLabel":"enum\u003cstring>"},"allKbFiles":{"type":"boolean","description":"`true` links every knowledge base file of the workspace. When absent, every file is linked unless `linkedKbFileIds` names some.","uniqueKey":"resources.allKbFiles","typeLabel":"boolean"},"linkedKbFileIds":{"type":"array","items":{"type":"string","description":"A 24-character hexadecimal id.","pattern":"^[0-9a-fA-F]{24}$","example":"66f1a8c3e4b0a1b2c3d4e5f6","uniqueKey":"resources.linkedKbFileIds.items.[INDEX]","typeLabel":"string"},"description":"Knowledge base files linked to the worker. Each must be a file of this workspace. Up to 1,000.","maxItems":1000,"uniqueKey":"resources.linkedKbFileIds","typeLabel":"string[]"},"fileIds":{"type":"array","items":{"type":"string","description":"A 24-character hexadecimal id.","pattern":"^[0-9a-fA-F]{24}$","example":"66f1a8c3e4b0a1b2c3d4e5f6","uniqueKey":"resources.fileIds.items.[INDEX]","typeLabel":"string"},"description":"Other files picked for the worker. Each must be a file of this workspace. Up to 1,000.","maxItems":1000,"uniqueKey":"resources.fileIds","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"resources","typeLabel":"object"},"triggers":{"type":"array","items":{"type":"object","description":"One thing that starts the worker.","required":["type"],"properties":{"type":{"type":"string","enum":["task_created","mention","event","scheduled","webhook","schedule","playground"],"description":"- `task_created`: the worker runs when a task is created. `match.taskType` limits it to some task types.\n- `mention`: the worker runs when someone mentions it in chat. Every active worker answers mentions, with or without this entry; `match.mentionPattern` is kept with it.\n- `event`: the worker runs on the named events in `events`, for example `task.created`,\n `deal.updated`, `email.received`, `meeting.completed` or `company.attribute_updated`.\n `*` means every event. An event name that Heliyos never emits never matches.\n- `scheduled`: the worker runs on a schedule. Put a 5-field cron in `match.schedule` (UTC unless\n `match.timezone` is set), or a one-time local time in `match.at` with `match.timezone`.\n- `webhook`: older spelling of `event`, with the event name in `match.webhookEvent`. Saved as `event`.\n- `schedule`: older spelling of `scheduled`. Saved as `scheduled`.\n- `playground`: used by test runs in the Heliyos app. Has no effect when set through the API.\n","isRequired":true,"uniqueKey":"triggers.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"source":{"type":"string","enum":["default","user"],"description":"Accepted and ignored. Triggers you send are always saved with `source` `user`.","uniqueKey":"triggers.items.[INDEX].source","typeLabel":"enum\u003cstring>"},"events":{"type":"array","maxItems":200,"description":"`event` triggers only: the event names to run on. Up to 200 names of up to 200 characters.","items":{"type":"string","maxLength":200,"uniqueKey":"triggers.items.[INDEX].events.items.[INDEX]","typeLabel":"string"},"example":["deal.updated","meeting.completed"],"uniqueKey":"triggers.items.[INDEX].events","typeLabel":"string[]"},"match":{"type":"object","description":"Conditions and timing. These keys are stored; any other key is dropped:\n- `taskType` (array of strings): `task_created` only, the task types to run on.\n- `taskStatus` (string): a task status condition.\n- `mentionPattern` (string): `mention` only, text the mention must contain.\n- `webhookEvent` (string or array): `webhook` only, the event names.\n- `schedule` (string): `scheduled` only, a 5-field cron such as `0 8 * * 1-5`.\n- `at` (string): `scheduled` only, a one-time local wall time `YYYY-MM-DDTHH:MM:SS`.\n- `timezone` (string): an IANA zone such as `Europe/Berlin` for `schedule` or `at`. Default UTC.\n- `recurrence` (object): the Heliyos app's own description of the schedule, so its editor can reopen it.\n","additionalProperties":true,"example":{"schedule":"0 8 * * 1-5","timezone":"Europe/Berlin"},"uniqueKey":"triggers.items.[INDEX].match","typeLabel":"object"},"dependencies":{"type":"array","maxItems":50,"description":"Ids of other workers in this workspace that must finish before this one starts. Up to 50.","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"A 24-character hexadecimal id.","example":"66f1a8c3e4b0a1b2c3d4e5f6","uniqueKey":"triggers.items.[INDEX].dependencies.items.[INDEX]","typeLabel":"string"},"uniqueKey":"triggers.items.[INDEX].dependencies","typeLabel":"string[]"}},"uniqueKey":"triggers.items.[INDEX]","typeLabel":"object"},"maxItems":50,"description":"The complete list of triggers you want, up to 50. Replaces the current ones (a default worker keeps its built-in ones).","uniqueKey":"triggers","typeLabel":"object[]"},"schedule":{"type":"object","properties":{"cron":{"type":"array","maxItems":20,"items":{"type":"string","maxLength":100,"uniqueKey":"schedule.cron.items.[INDEX]","typeLabel":"string"},"description":"5-field cron expressions.","uniqueKey":"schedule.cron","typeLabel":"string[]"}},"additionalProperties":false,"description":"Legacy cron list. Replaces the current one. Custom workers only. Use a `scheduled` trigger instead.","uniqueKey":"schedule","typeLabel":"object"}},"additionalProperties":false,"minProperties":1,"uniqueKey":"","typeLabel":"object"},"example":{"isActive":false},"examples":{"Example":{"title":"Example","value":{"isActive":false}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"da4d9451-43fc-4804-ab20-3271e2cc5a07":{"description":"The updated worker, with the outcome of its schedule registration.","content":{"application/json":{"schema":{"type":"object","required":["meta","data"],"properties":{"meta":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable summary of the result.","isRequired":true,"uniqueKey":"meta.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"},"data":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"A 24-character hexadecimal id.","example":"66f1a8c3e4b0a1b2c3d4e5f6","uniqueKey":"data._id","typeLabel":"string"},"organizationId":{"type":"string","description":"The workspace the worker belongs to.","pattern":"^[0-9a-fA-F]{24}$","example":"66f1a8c3e4b0a1b2c3d4e5f6","uniqueKey":"data.organizationId","typeLabel":"string"},"name":{"type":"string","description":"The worker's name, unique in the workspace.","uniqueKey":"data.name","typeLabel":"string"},"type":{"type":"string","enum":["default","custom"],"description":"`default`: built into every workspace. Only its instructions, description, icon, active flag, memory and its own triggers can change, and it cannot be deleted. `custom`: created by you, fully editable and deletable.","uniqueKey":"data.type","typeLabel":"enum\u003cstring>"},"isActive":{"type":"boolean","description":"`false` pauses the worker: nothing starts it and Heliyos does not call it.","uniqueKey":"data.isActive","typeLabel":"boolean"},"icon":{"type":"string","description":"The icon the Heliyos app shows for the worker.","uniqueKey":"data.icon","typeLabel":"string"},"isExcluded":{"type":"boolean","description":"`true` for older built-in workers that run on a separate pipeline. They are listed for reference, and Heliyos never calls them.","uniqueKey":"data.isExcluded","typeLabel":"boolean"},"description":{"type":"string","description":"One line that tells Heliyos (and people) what the worker is for. Heliyos reads it to decide when to call the worker.","uniqueKey":"data.description","typeLabel":"string"},"instructions":{"type":"string","description":"What the worker does and how, in Markdown.","uniqueKey":"data.instructions","typeLabel":"string"},"toolName":{"type":"string","description":"The stable snake_case name Heliyos calls the worker by. Set on create and never changed.","uniqueKey":"data.toolName","typeLabel":"string"},"toolNames":{"type":"array","description":"The built-in tools the worker may use, by name.","items":{"type":"string","uniqueKey":"data.toolNames.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.toolNames","typeLabel":"string[]"},"actionIds":{"type":"array","description":"The workspace actions the worker may run.","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"A 24-character hexadecimal id.","example":"66f1a8c3e4b0a1b2c3d4e5f6","uniqueKey":"data.actionIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.actionIds","typeLabel":"string[]"},"toolPolicy":{"type":"object","description":"Limits on what the worker may do.","properties":{"readOnly":{"type":"boolean","description":"`true`: the worker may read but never change data.","uniqueKey":"data.toolPolicy.readOnly","typeLabel":"boolean"}},"uniqueKey":"data.toolPolicy","typeLabel":"object"},"memory":{"type":"object","properties":{"enabled":{"type":"boolean","description":"`true`: the worker keeps memory across runs.","uniqueKey":"data.memory.enabled","typeLabel":"boolean"}},"uniqueKey":"data.memory","typeLabel":"object"},"resources":{"type":"object","description":"The knowledge files the worker reads.","properties":{"scope":{"type":"string","enum":["everything","org_knowledge","account_files","selected_files"],"description":"The file scope picked in the Heliyos app: `everything` (the default), `org_knowledge`\n(knowledge base files), `account_files` (files on records) or `selected_files` (files you\npick). Which knowledge base files the worker reads is set by `allKbFiles` and\n`linkedKbFileIds`.\n","uniqueKey":"data.resources.scope","typeLabel":"enum\u003cstring>"},"allKbFiles":{"type":"boolean","description":"`true` links every knowledge base file of the workspace. When absent, every file is linked unless `linkedKbFileIds` names some.","uniqueKey":"data.resources.allKbFiles","typeLabel":"boolean"},"linkedKbFileIds":{"type":"array","maxItems":1000,"description":"Knowledge base files linked to the worker. Each must be a file of this workspace. Up to 1,000.","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"A 24-character hexadecimal id.","example":"66f1a8c3e4b0a1b2c3d4e5f6","uniqueKey":"data.resources.linkedKbFileIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.resources.linkedKbFileIds","typeLabel":"string[]"},"fileIds":{"type":"array","maxItems":1000,"description":"Other files picked for the worker. Each must be a file of this workspace. Up to 1,000.","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"A 24-character hexadecimal id.","example":"66f1a8c3e4b0a1b2c3d4e5f6","uniqueKey":"data.resources.fileIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.resources.fileIds","typeLabel":"string[]"}},"uniqueKey":"data.resources","typeLabel":"object"},"triggers":{"type":"array","description":"What starts the worker. An empty list means it only runs when Heliyos or a person calls it.","items":{"type":"object","description":"A stored trigger. Event subscriptions are stored as `event`, schedules as `scheduled`.","properties":{"type":{"type":"string","description":"`task_created`, `mention`, `event`, `scheduled` or `playground`. Workers saved long ago can still show `webhook` or `schedule`.","uniqueKey":"data.triggers.items.[INDEX].type","typeLabel":"string"},"source":{"type":"string","enum":["default","user"],"description":"`default`: built into a default worker. It stays when you change the worker's triggers. `user`: added by a person or the API, removable.","uniqueKey":"data.triggers.items.[INDEX].source","typeLabel":"enum\u003cstring>"},"events":{"type":"array","description":"`event` triggers: the subscribed event names.","items":{"type":"string","uniqueKey":"data.triggers.items.[INDEX].events.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.triggers.items.[INDEX].events","typeLabel":"string[]"},"match":{"type":"object","additionalProperties":true,"description":"Conditions and timing, as in the trigger input.","uniqueKey":"data.triggers.items.[INDEX].match","typeLabel":"object"},"dependencies":{"type":"array","description":"Workers that must finish first.","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"A 24-character hexadecimal id.","example":"66f1a8c3e4b0a1b2c3d4e5f6","uniqueKey":"data.triggers.items.[INDEX].dependencies.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.triggers.items.[INDEX].dependencies","typeLabel":"string[]"}},"uniqueKey":"data.triggers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.triggers","typeLabel":"object[]"},"schedule":{"type":"object","description":"Legacy cron list. Schedules live on `scheduled` triggers now.","properties":{"cron":{"type":"array","items":{"type":"string","uniqueKey":"data.schedule.cron.items.[INDEX]","typeLabel":"string"},"description":"5-field cron expressions.","uniqueKey":"data.schedule.cron","typeLabel":"string[]"}},"uniqueKey":"data.schedule","typeLabel":"object"},"runtime":{"type":"string","enum":["sandbox","light"],"description":"How Heliyos runs the worker. Set by Heliyos, read-only.","uniqueKey":"data.runtime","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","description":"Who created and last changed the resource, and when.","properties":{"created":{"type":"object","properties":{"at":{"type":"string","format":"date-time","description":"An ISO 8601 date-time in UTC.","example":"2026-11-04T09:30:00.000Z","uniqueKey":"data.metadata.created.at","typeLabel":"string\u003cdate-time>"},"by":{"type":"string","description":"Id of the user (or the API key's owner) who created it.","pattern":"^[0-9a-fA-F]{24}$","example":"66f1a8c3e4b0a1b2c3d4e5f6","uniqueKey":"data.metadata.created.by","typeLabel":"string"}},"uniqueKey":"data.metadata.created","typeLabel":"object"},"updated":{"type":"object","properties":{"at":{"type":"string","format":"date-time","description":"An ISO 8601 date-time in UTC.","example":"2026-11-04T09:30:00.000Z","uniqueKey":"data.metadata.updated.at","typeLabel":"string\u003cdate-time>"},"by":{"type":"string","description":"Id of the user who last changed it.","pattern":"^[0-9a-fA-F]{24}$","example":"66f1a8c3e4b0a1b2c3d4e5f6","uniqueKey":"data.metadata.updated.by","typeLabel":"string"}},"uniqueKey":"data.metadata.updated","typeLabel":"object"}},"uniqueKey":"data.metadata","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"An ISO 8601 date-time in UTC.","example":"2026-11-04T09:30:00.000Z","uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"An ISO 8601 date-time in UTC.","example":"2026-11-04T09:30:00.000Z","uniqueKey":"data.updatedAt","typeLabel":"string\u003cdate-time>"},"scheduleSync":{"type":"object","description":"What happened to the worker's schedules after the save. The worker is saved even when a schedule fails, but a failed schedule never fires: check `failed`.","properties":{"created":{"type":"array","description":"Ids of the worker's schedules that are registered after this save, including ones that already existed. A one-time `at` in the past is skipped and not listed.","items":{"type":"string","uniqueKey":"data.scheduleSync.created.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.scheduleSync.created","typeLabel":"string[]"},"deleted":{"type":"array","description":"Ids of schedules removed by this save because no trigger asks for them any more.","items":{"type":"string","uniqueKey":"data.scheduleSync.deleted.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.scheduleSync.deleted","typeLabel":"string[]"},"failed":{"type":"array","description":"One line per schedule that could not be registered. Empty when every schedule is in place.","items":{"type":"string","uniqueKey":"data.scheduleSync.failed.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.scheduleSync.failed","typeLabel":"string[]"}},"uniqueKey":"data.scheduleSync","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"meta":{"message":"Agent updated."},"data":{"_id":"6720f3a1b2c3d4e5f6a7b8c9","name":"Account researcher","type":"custom","isActive":false,"toolName":"account_researcher","triggers":[{"type":"event","events":["meeting.booked"],"source":"user"}],"scheduleSync":{"created":[],"deleted":[],"failed":[]}}},"examples":{"Example":{"title":"Example","value":{"meta":{"message":"Agent updated."},"data":{"_id":"6720f3a1b2c3d4e5f6a7b8c9","name":"Account researcher","type":"custom","isActive":false,"toolName":"account_researcher","triggers":[{"type":"event","events":["meeting.booked"],"source":"user"}],"scheduleSync":{"created":[],"deleted":[],"failed":[]}}}}},"exampleType":"examples"}},"exampleType":"examples"},"c596aada-70d2-4b67-9668-33d9a58a8ec8":{"description":"Validation failed","content":{"application/json":{"schema":{"type":"object","required":["message","error"],"properties":{"message":{"type":"string","description":"Same as error.message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","UNAUTHENTICATED","FORBIDDEN_ACTION","NOT_FOUND","RATE_LIMITED","CONFLICT","INTERNAL"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error":{"code":"VALIDATION_FAILED","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7c9f77e7-07a8-401e-ac42-8592e9164035":{"description":"Unauthenticated","content":{"application/json":{"schema":{"type":"object","required":["message","error"],"properties":{"message":{"type":"string","description":"Same as error.message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","UNAUTHENTICATED","FORBIDDEN_ACTION","NOT_FOUND","RATE_LIMITED","CONFLICT","INTERNAL"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error":{"code":"VALIDATION_FAILED","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"258c5ef9-854f-45fe-9846-9070b9458900":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["message","error"],"properties":{"message":{"type":"string","description":"Same as error.message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","UNAUTHENTICATED","FORBIDDEN_ACTION","NOT_FOUND","RATE_LIMITED","CONFLICT","INTERNAL"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error":{"code":"VALIDATION_FAILED","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"413361d7-2393-4515-9218-fe73f6e59465":{"description":"NOT_FOUND: no worker with this id, or a new action, file or dependency worker id is not this workspace's. Nothing is written.","content":{"application/json":{"schema":{"type":"object","required":["message","error"],"properties":{"message":{"type":"string","description":"Same as error.message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","UNAUTHENTICATED","FORBIDDEN_ACTION","NOT_FOUND","RATE_LIMITED","CONFLICT","INTERNAL"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error":{"code":"VALIDATION_FAILED","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"460979a1-da82-412f-946a-88a46ed47304":{"description":"CONFLICT: another worker already has this name. Nothing is written.","content":{"application/json":{"schema":{"type":"object","required":["message","error"],"properties":{"message":{"type":"string","description":"Same as error.message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","UNAUTHENTICATED","FORBIDDEN_ACTION","NOT_FOUND","RATE_LIMITED","CONFLICT","INTERNAL"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error":{"code":"VALIDATION_FAILED","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"a237643e-9940-4988-ab8b-2814722b482e":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["message","error"],"properties":{"message":{"type":"string","description":"Same as error.message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","UNAUTHENTICATED","FORBIDDEN_ACTION","NOT_FOUND","RATE_LIMITED","CONFLICT","INTERNAL"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error":{"code":"VALIDATION_FAILED","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"24a65c4b-c280-4a52-a557-91d07005a21b":{"bearerAuth":{"type":"http","scheme":"bearer","description":"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.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"cfb9dc49-4d79-4f5e-8469-9c9103787f1d":{"url":"https://api-prod.heliyos.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"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.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"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.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"heliyos","siteName":"Heliyos","title":"Update a worker - Heliyos","relatedPagesConfig":{"enabled":false,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/workers-and-runs/update-a-worker.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Changes a worker. Send at least one field; what you leave out is kept. - On a custom worker you can change name, description, icon, instructions, isActive, toolNames, actionIds, toolPolicy, memory, resources, triggers and schedule. - On a default worker only description, icon, instructions, isActive, memory and triggers apply. Other fields are accepted and ignored. - toolName is accepted and ignored on every worker: it never changes after create. triggers, when sent, replaces the worker\u0026#x27;s own triggers. On a default worker its built-in (source default) triggers always stay: your list replaces only the ones added by people, and events or trigger types the built-in ones already cover are dropped. Send [] to remove every trigger you added. resources, toolPolicy and memory are replaced as a whole when sent. Set isActive: false to pause a worker instead of deleting it. Needs a workspace owner or admin.\">\u003cmeta data-mint-head name=\"keywords\" content=\"Heliyos API, Heliyos MCP server, AI operating system for revenue, AI workers, customer memory, CRM API, MCP server for sales\">\u003cmeta data-mint-head name=\"application-name\" content=\"Heliyos\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/heliyos/VGWcHMG0dpBG1nWt/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/heliyos/VGWcHMG0dpBG1nWt/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/heliyos/VGWcHMG0dpBG1nWt/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/heliyos/VGWcHMG0dpBG1nWt/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/heliyos/VGWcHMG0dpBG1nWt/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/heliyos/VGWcHMG0dpBG1nWt/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/heliyos/VGWcHMG0dpBG1nWt/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/heliyos/VGWcHMG0dpBG1nWt/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/heliyos/VGWcHMG0dpBG1nWt/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a worker - Heliyos\">\u003cmeta data-mint-head property=\"og:description\" content=\"Changes a worker. Send at least one field; what you leave out is kept. - On a custom worker you can change name, description, icon, instructions, isActive, toolNames, actionIds, toolPolicy, memory, resources, triggers and schedule. - On a default worker only description, icon, instructions, isActive, memory and triggers apply. Other fields are accepted and ignored. - toolName is accepted and ignored on every worker: it never changes after create. triggers, when sent, replaces the worker\u0026#x27;s own triggers. On a default worker its built-in (source default) triggers always stay: your list replaces only the ones added by people, and events or trigger types the built-in ones already cover are dropped. Send [] to remove every trigger you added. resources, toolPolicy and memory are replaced as a whole when sent. Set isActive: false to pause a worker instead of deleting it. Needs a workspace owner or admin.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Heliyos\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.heliyos.ai/api-reference/workers-and-runs/update-a-worker\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://www.heliyos.ai/assets/social-preview-2026-10-28.jpeg\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update a worker - Heliyos\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Changes a worker. Send at least one field; what you leave out is kept. - On a custom worker you can change name, description, icon, instructions, isActive, toolNames, actionIds, toolPolicy, memory, resources, triggers and schedule. - On a default worker only description, icon, instructions, isActive, memory and triggers apply. Other fields are accepted and ignored. - toolName is accepted and ignored on every worker: it never changes after create. triggers, when sent, replaces the worker\u0026#x27;s own triggers. On a default worker its built-in (source default) triggers always stay: your list replaces only the ones added by people, and events or trigger types the built-in ones already cover are dropped. Send [] to remove every trigger you added. resources, toolPolicy and memory are replaced as a whole when sent. Set isActive: false to pause a worker instead of deleting it. Needs a workspace owner or admin.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://www.heliyos.ai/assets/social-preview-2026-10-28.jpeg\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/heliyos/VGWcHMG0dpBG1nWt/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Heliyos\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#27251E\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"og:image:alt\" content=\"Heliyos: The AI operating system for revenue\">\u003cmeta data-mint-head name=\"twitter:image:alt\" content=\"Heliyos: The AI operating system for revenue\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.heliyos.ai/api-reference/workers-and-runs/update-a-worker\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/workers-and-runs/update-a-worker.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.heliyos.ai/#organization\",\"name\":\"Heliyos\",\"url\":\"https://www.heliyos.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://www.heliyos.ai/assets/brand/logo-color.png\"},\"sameAs\":[\"https://www.heliyos.ai\",\"https://www.linkedin.com/company/heliyos\",\"https://github.com/heliyos-ai\",\"https://www.npmjs.com/package/@heliyos/mcp\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.heliyos.ai#website\",\"name\":\"Heliyos\",\"url\":\"https://docs.heliyos.ai\",\"publisher\":{\"@id\":\"https://www.heliyos.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.heliyos.ai/api-reference/workers-and-runs/update-a-worker#webpage\",\"url\":\"https://docs.heliyos.ai/api-reference/workers-and-runs/update-a-worker\",\"name\":\"Update a worker\",\"description\":\"Changes a worker. Send at least one field; what you leave out is kept. - On a custom worker you can change name, description, icon, instructions, isActive, toolNames, actionIds, toolPolicy, memory, resources, triggers and schedule. - On a default worker only description, icon, instructions, isActive, memory and triggers apply. Other fields are accepted and ignored. - toolName is accepted and ignored on every worker: it never changes after create. triggers, when sent, replaces the worker's own triggers. On a default worker its built-in (source default) triggers always stay: your list replaces only the ones added by people, and events or trigger types the built-in ones already cover are dropped. Send [] to remove every trigger you added. resources, toolPolicy and memory are replaced as a whole when sent. Set isActive: false to pause a worker instead of deleting it. Needs a workspace owner or admin.\",\"isPartOf\":{\"@id\":\"https://docs.heliyos.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.heliyos.ai/api-reference/workers-and-runs/update-a-worker#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.heliyos.ai/api-reference/workers-and-runs/update-a-worker#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Workers and runs\",\"item\":\"https://docs.heliyos.ai/api-reference/workers-and-runs/list-workers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a worker\",\"item\":\"https://docs.heliyos.ai/api-reference/workers-and-runs/update-a-worker\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.heliyos.ai/api-reference/workers-and-runs/update-a-worker#apireference\",\"headline\":\"Update a worker\",\"name\":\"Update a worker\",\"description\":\"Changes a worker. Send at least one field; what you leave out is kept. - On a custom worker you can change name, description, icon, instructions, isActive, toolNames, actionIds, toolPolicy, memory, resources, triggers and schedule. - On a default worker only description, icon, instructions, isActive, memory and triggers apply. Other fields are accepted and ignored. - toolName is accepted and ignored on every worker: it never changes after create. triggers, when sent, replaces the worker's own triggers. On a default worker its built-in (source default) triggers always stay: your list replaces only the ones added by people, and events or trigger types the built-in ones already cover are dropped. Send [] to remove every trigger you added. resources, toolPolicy and memory are replaced as a whole when sent. Set isActive: false to pause a worker instead of deleting it. Needs a workspace owner or admin.\",\"url\":\"https://docs.heliyos.ai/api-reference/workers-and-runs/update-a-worker\",\"mainEntityOfPage\":{\"@id\":\"https://docs.heliyos.ai/api-reference/workers-and-runs/update-a-worker#webpage\"},\"image\":\"https://www.heliyos.ai/assets/social-preview-2026-10-28.jpeg\",\"publisher\":{\"@id\":\"https://www.heliyos.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.heliyos.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Heliyos\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Heliyos","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/tab-guides.svg","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/tab-api.svg","groups":[{"group":"Overview","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-pages.svg","pages":[{"title":"API reference","href":"/api-reference/introduction"}]},{"group":"Workspace","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-general.svg","pages":[{"title":"Get the workspace","deprecated":null,"version":null,"sidebarTitle":"Get the workspace","openapi":"/api-reference/openapi.json get /v1/platform/organization","href":"/api-reference/workspace/get-the-workspace"},{"title":"List credit usage","deprecated":null,"version":null,"sidebarTitle":"List credit usage","openapi":"/api-reference/openapi.json get /v1/platform/usage","href":"/api-reference/workspace/list-credit-usage"}]},{"group":"Schemas","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-objects.svg","pages":[{"title":"List objects","deprecated":null,"version":null,"sidebarTitle":"List objects","openapi":"/api-reference/openapi.json get /v1/platform/base-schemas","href":"/api-reference/schemas/list-objects"},{"title":"Get an object","deprecated":null,"version":null,"sidebarTitle":"Get an object","openapi":"/api-reference/openapi.json get /v1/platform/base-schemas/{id}","href":"/api-reference/schemas/get-an-object"},{"title":"Create a field","deprecated":null,"version":null,"sidebarTitle":"Create a field","openapi":"/api-reference/openapi.json post /v1/platform/base-schemas/{id}/fields","href":"/api-reference/schemas/create-a-field"},{"title":"Update a field","deprecated":null,"version":null,"sidebarTitle":"Update a field","openapi":"/api-reference/openapi.json patch /v1/platform/base-schemas/{id}/fields/{fieldId}","href":"/api-reference/schemas/update-a-field"},{"title":"Delete a field","deprecated":null,"version":null,"sidebarTitle":"Delete a field","openapi":"/api-reference/openapi.json delete /v1/platform/base-schemas/{id}/fields/{fieldId}","href":"/api-reference/schemas/delete-a-field"}]},{"group":"Records","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-company.svg","pages":[{"title":"List records","deprecated":null,"version":null,"sidebarTitle":"List records","openapi":"/api-reference/openapi.json get /v1/platform/base-schemas/{id}/records","href":"/api-reference/records/list-records"},{"title":"Get a record","deprecated":null,"version":null,"sidebarTitle":"Get a record","openapi":"/api-reference/openapi.json get /v1/platform/records/{id}","href":"/api-reference/records/get-a-record"},{"title":"Create a record","deprecated":null,"version":null,"sidebarTitle":"Create a record","openapi":"/api-reference/openapi.json post /v1/platform/base-schemas/{id}/records","href":"/api-reference/records/create-a-record"},{"title":"Update a record","deprecated":null,"version":null,"sidebarTitle":"Update a record","openapi":"/api-reference/openapi.json patch /v1/platform/records/{id}","href":"/api-reference/records/update-a-record"},{"title":"Delete records","deprecated":null,"version":null,"sidebarTitle":"Delete records","openapi":"/api-reference/openapi.json post /v1/platform/base-schemas/{id}/records/bulk-delete","href":"/api-reference/records/delete-records"},{"title":"List record names","deprecated":null,"version":null,"sidebarTitle":"List record names","openapi":"/api-reference/openapi.json get /v1/platform/base-schemas/{id}/records/lookup","href":"/api-reference/records/list-record-names"}]},{"group":"Timeline","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-history.svg","pages":[{"title":"List timeline entries","deprecated":null,"version":null,"sidebarTitle":"List timeline entries","openapi":"/api-reference/openapi.json get /v1/platform/records/{id}/timeline","href":"/api-reference/timeline/list-timeline-entries"}]},{"group":"Activities","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-runs.svg","pages":[{"title":"List record events","deprecated":null,"version":null,"sidebarTitle":"List record events","openapi":"/api-reference/openapi.json get /v1/platform/records/{id}/events","href":"/api-reference/activities/list-record-events"},{"title":"List task events","deprecated":null,"version":null,"sidebarTitle":"List task events","openapi":"/api-reference/openapi.json get /v1/platform/tasks/{id}/events","href":"/api-reference/activities/list-task-events"}]},{"group":"Interactions","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-inbox.svg","pages":[{"title":"List interactions","deprecated":null,"version":null,"sidebarTitle":"List interactions","openapi":"/api-reference/openapi.json get /v1/platform/interactions","href":"/api-reference/interactions/list-interactions"},{"title":"Get an interaction","deprecated":null,"version":null,"sidebarTitle":"Get an interaction","openapi":"/api-reference/openapi.json get /v1/platform/interactions/{id}","href":"/api-reference/interactions/get-an-interaction"}]},{"group":"Notes","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-notes.svg","pages":[{"title":"List notes","deprecated":null,"version":null,"sidebarTitle":"List notes","openapi":"/api-reference/openapi.json get /v1/platform/notes","href":"/api-reference/notes/list-notes"},{"title":"Get a note","deprecated":null,"version":null,"sidebarTitle":"Get a note","openapi":"/api-reference/openapi.json get /v1/platform/notes/{id}","href":"/api-reference/notes/get-a-note"},{"title":"Create a note","deprecated":null,"version":null,"sidebarTitle":"Create a note","openapi":"/api-reference/openapi.json post /v1/platform/notes","href":"/api-reference/notes/create-a-note"},{"title":"Update a note","deprecated":null,"version":null,"sidebarTitle":"Update a note","openapi":"/api-reference/openapi.json patch /v1/platform/notes/{id}","href":"/api-reference/notes/update-a-note"},{"title":"Delete a note","deprecated":null,"version":null,"sidebarTitle":"Delete a note","openapi":"/api-reference/openapi.json delete /v1/platform/notes/{id}","href":"/api-reference/notes/delete-a-note"}]},{"group":"Tasks","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-tasks.svg","pages":[{"title":"List tasks","deprecated":null,"version":null,"sidebarTitle":"List tasks","openapi":"/api-reference/openapi.json get /v1/platform/tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Get a task","deprecated":null,"version":null,"sidebarTitle":"Get a task","openapi":"/api-reference/openapi.json get /v1/platform/tasks/{id}","href":"/api-reference/tasks/get-a-task"},{"title":"Create a task","deprecated":null,"version":null,"sidebarTitle":"Create a task","openapi":"/api-reference/openapi.json post /v1/platform/tasks","href":"/api-reference/tasks/create-a-task"},{"title":"Update a task","deprecated":null,"version":null,"sidebarTitle":"Update a task","openapi":"/api-reference/openapi.json patch /v1/platform/tasks/{id}","href":"/api-reference/tasks/update-a-task"},{"title":"Delete a task","deprecated":null,"version":null,"sidebarTitle":"Delete a task","openapi":"/api-reference/openapi.json delete /v1/platform/tasks/{id}","href":"/api-reference/tasks/delete-a-task"},{"title":"Run workers on a task","deprecated":null,"version":null,"sidebarTitle":"Run workers on a task","openapi":"/api-reference/openapi.json post /v1/platform/tasks/{id}/runs","href":"/api-reference/tasks/run-workers-on-a-task"}]},{"group":"Workers and runs","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-workers.svg","pages":[{"title":"List workers","deprecated":null,"version":null,"sidebarTitle":"List workers","openapi":"/api-reference/openapi.json get /v1/platform/agents","href":"/api-reference/workers-and-runs/list-workers"},{"title":"Get a worker","deprecated":null,"version":null,"sidebarTitle":"Get a worker","openapi":"/api-reference/openapi.json get /v1/platform/agents/{id}","href":"/api-reference/workers-and-runs/get-a-worker"},{"title":"Create a worker","description":"Creates a custom worker. It starts active unless you send `isActive: false`, and its triggers\ntake effect at once.\n\nWhat you leave out gets a default: empty instructions, no tools or actions, memory on, and every\nknowledge base file linked. `toolName` is made from the name (lowercase, other characters as `_`,\nat most 48 characters) unless you send one. Scheduled triggers are registered after the save;\n`scheduleSync` in the response says whether each one is in place.\n\nCreating a worker is free. Its runs are not: each call to a custom worker during a run spends\ncredits (feature `worker_run` in **List credit usage**).\n\nNeeds a workspace owner or admin. An API key counts as an admin.","deprecated":null,"version":null,"sidebarTitle":"Create a worker","openapi":"/api-reference/openapi.json post /v1/platform/agents","href":"/api-reference/workers-and-runs/create-a-worker"},{"title":"Update a worker","deprecated":null,"version":null,"sidebarTitle":"Update a worker","openapi":"/api-reference/openapi.json patch /v1/platform/agents/{id}","href":"/api-reference/workers-and-runs/update-a-worker"},{"title":"Delete a worker","description":"Deletes a custom worker permanently and removes its schedules. Its past runs and their history\nare kept. Default workers cannot be deleted: pause them with `isActive: false` instead.\n\nOther workers that list this one in a trigger's `dependencies` keep the id. Needs a workspace\nowner or admin.","deprecated":null,"version":null,"sidebarTitle":"Delete a worker","openapi":"/api-reference/openapi.json delete /v1/platform/agents/{id}","href":"/api-reference/workers-and-runs/delete-a-worker"},{"title":"Ask Heliyos","deprecated":null,"version":null,"sidebarTitle":"Ask Heliyos","openapi":"/api-reference/openapi.json post /v1/platform/orchestrator/chats","href":"/api-reference/workers-and-runs/ask-heliyos"},{"title":"List runs","deprecated":null,"version":null,"sidebarTitle":"List runs","openapi":"/api-reference/openapi.json get /v1/platform/workers/runs","href":"/api-reference/workers-and-runs/list-runs"},{"title":"Get a run","deprecated":null,"version":null,"sidebarTitle":"Get a run","openapi":"/api-reference/openapi.json get /v1/platform/workers/runs/{id}","href":"/api-reference/workers-and-runs/get-a-run"},{"title":"List triggers","deprecated":null,"version":null,"sidebarTitle":"List triggers","openapi":"/api-reference/openapi.json get /v1/platform/workers/triggers","href":"/api-reference/workers-and-runs/list-triggers"},{"title":"List actions","deprecated":null,"version":null,"sidebarTitle":"List actions","openapi":"/api-reference/openapi.json get /v1/platform/workers/tools","href":"/api-reference/workers-and-runs/list-actions"}]},{"group":"Reviews","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/tasks.svg","pages":[{"title":"List reviews","deprecated":null,"version":null,"sidebarTitle":"List reviews","openapi":"/api-reference/openapi.json get /v1/platform/reviews","href":"/api-reference/reviews/list-reviews"},{"title":"Get a review","deprecated":null,"version":null,"sidebarTitle":"Get a review","openapi":"/api-reference/openapi.json get /v1/platform/reviews/{id}","href":"/api-reference/reviews/get-a-review"},{"title":"Approve or reject a review","deprecated":null,"version":null,"sidebarTitle":"Approve or reject a review","openapi":"/api-reference/openapi.json post /v1/platform/reviews/{id}/decisions","href":"/api-reference/reviews/approve-or-reject-a-review"}]},{"group":"Scouts","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-scouts.svg","pages":[{"title":"List workspace Scouts","deprecated":null,"version":null,"sidebarTitle":"List workspace scouts","openapi":"/api-reference/openapi.json get /v1/platform/global-scouts","href":"/api-reference/scouts/list-workspace-scouts"},{"title":"Get a workspace Scout","deprecated":null,"version":null,"sidebarTitle":"Get a workspace scout","openapi":"/api-reference/openapi.json get /v1/platform/global-scouts/{id}","href":"/api-reference/scouts/get-a-workspace-scout"},{"title":"Create a custom Scout","deprecated":null,"version":null,"sidebarTitle":"Create a custom scout","openapi":"/api-reference/openapi.json post /v1/platform/global-scouts","href":"/api-reference/scouts/create-a-custom-scout"},{"title":"Update a custom Scout","deprecated":null,"version":null,"sidebarTitle":"Update a custom scout","openapi":"/api-reference/openapi.json patch /v1/platform/global-scouts/{id}","href":"/api-reference/scouts/update-a-custom-scout"},{"title":"Set a workspace Scout state","deprecated":null,"version":null,"sidebarTitle":"Set a workspace scout state","openapi":"/api-reference/openapi.json post /v1/platform/global-scouts/{id}/state","href":"/api-reference/scouts/set-a-workspace-scout-state"},{"title":"Delete a custom Scout","deprecated":null,"version":null,"sidebarTitle":"Delete a custom scout","openapi":"/api-reference/openapi.json delete /v1/platform/global-scouts/{id}","href":"/api-reference/scouts/delete-a-custom-scout"},{"title":"List company Scouts","deprecated":null,"version":null,"sidebarTitle":"List company scouts","openapi":"/api-reference/openapi.json get /v1/platform/companies/{id}/scouts","href":"/api-reference/scouts/list-company-scouts"},{"title":"Add Scouts to a company","deprecated":null,"version":null,"sidebarTitle":"Add scouts to a company","openapi":"/api-reference/openapi.json post /v1/platform/companies/{id}/scouts","href":"/api-reference/scouts/add-scouts-to-a-company"},{"title":"Remove company Scouts","deprecated":null,"version":null,"sidebarTitle":"Remove company scouts","openapi":"/api-reference/openapi.json delete /v1/platform/companies/{id}/scouts","href":"/api-reference/scouts/remove-company-scouts"}]},{"group":"Signals","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-signals.svg","pages":[{"title":"List signals","deprecated":null,"version":null,"sidebarTitle":"List signals","openapi":"/api-reference/openapi.json get /v1/platform/signals","href":"/api-reference/signals/list-signals"},{"title":"List workspace Scout signals","deprecated":null,"version":null,"sidebarTitle":"List workspace scout signals","openapi":"/api-reference/openapi.json get /v1/platform/global-scouts/{id}/signals","href":"/api-reference/signals/list-workspace-scout-signals"},{"title":"Mark a signal read","deprecated":null,"version":null,"sidebarTitle":"Mark a signal read","openapi":"/api-reference/openapi.json post /v1/platform/signals/{id}/read","href":"/api-reference/signals/mark-a-signal-read"},{"title":"Mark signals read in bulk","deprecated":null,"version":null,"sidebarTitle":"Mark signals read in bulk","openapi":"/api-reference/openapi.json post /v1/platform/signals/bulk-read","href":"/api-reference/signals/mark-signals-read-in-bulk"}]},{"group":"Watchlist","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-watchlist.svg","pages":[{"title":"Get watchlist statistics","deprecated":null,"version":null,"sidebarTitle":"Get watchlist statistics","openapi":"/api-reference/openapi.json get /v1/platform/watchlist/statistics","href":"/api-reference/watchlist/get-watchlist-statistics"},{"title":"Watch a company","deprecated":null,"version":null,"sidebarTitle":"Watch a company","openapi":"/api-reference/openapi.json post /v1/platform/companies/{id}/watch","href":"/api-reference/watchlist/watch-a-company"},{"title":"Unwatch a company","deprecated":null,"version":null,"sidebarTitle":"Unwatch a company","openapi":"/api-reference/openapi.json delete /v1/platform/companies/{id}/watch","href":"/api-reference/watchlist/unwatch-a-company"}]},{"group":"Knowledge base","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-knowledge.svg","pages":[{"title":"Get the knowledge base","deprecated":null,"version":null,"sidebarTitle":"Get the knowledge base","openapi":"/api-reference/openapi.json get /v1/auth/organizations/current","href":"/api-reference/knowledge-base/get-the-knowledge-base"},{"title":"Update the knowledge base","deprecated":null,"version":null,"sidebarTitle":"Update the knowledge base","openapi":"/api-reference/openapi.json patch /v1/auth/organizations/current","href":"/api-reference/knowledge-base/update-the-knowledge-base"}]},{"group":"Files","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-file.svg","pages":[{"title":"Create an upload URL","deprecated":null,"version":null,"sidebarTitle":"Create an upload url","openapi":"/api-reference/openapi.json post /v1/platform/attachments/presigned-urls","href":"/api-reference/files/create-an-upload-url"},{"title":"Create a file","deprecated":null,"version":null,"sidebarTitle":"Create a file","openapi":"/api-reference/openapi.json post /v1/platform/attachments","href":"/api-reference/files/create-a-file"},{"title":"List files","deprecated":null,"version":null,"sidebarTitle":"List files","openapi":"/api-reference/openapi.json get /v1/platform/attachments","href":"/api-reference/files/list-files"},{"title":"Get a file","deprecated":null,"version":null,"sidebarTitle":"Get a file","openapi":"/api-reference/openapi.json get /v1/platform/attachments/{id}","href":"/api-reference/files/get-a-file"},{"title":"Get a file download link","deprecated":null,"version":null,"sidebarTitle":"Get a file download link","openapi":"/api-reference/openapi.json get /v1/platform/attachments/{id}/download","href":"/api-reference/files/get-a-file-download-link"},{"title":"Delete a file","deprecated":null,"version":null,"sidebarTitle":"Delete a file","openapi":"/api-reference/openapi.json delete /v1/platform/attachments/{id}","href":"/api-reference/files/delete-a-file"}]},{"group":"Labels","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-labels.svg","pages":[{"title":"List label groups","deprecated":null,"version":null,"sidebarTitle":"List label groups","openapi":"/api-reference/openapi.json get /v1/platform/classification-labels","href":"/api-reference/labels/list-label-groups"},{"title":"Create a label group","deprecated":null,"version":null,"sidebarTitle":"Create a label group","openapi":"/api-reference/openapi.json post /v1/platform/classification-labels","href":"/api-reference/labels/create-a-label-group"},{"title":"Update a label group","deprecated":null,"version":null,"sidebarTitle":"Update a label group","openapi":"/api-reference/openapi.json patch /v1/platform/classification-labels/{id}","href":"/api-reference/labels/update-a-label-group"},{"title":"Delete a label group","deprecated":null,"version":null,"sidebarTitle":"Delete a label group","openapi":"/api-reference/openapi.json delete /v1/platform/classification-labels/{id}","href":"/api-reference/labels/delete-a-label-group"}]},{"group":"Team","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-teams.svg","pages":[{"title":"List team members","deprecated":null,"version":null,"sidebarTitle":"List team members","openapi":"/api-reference/openapi.json get /v1/auth/team-memberships","href":"/api-reference/team/list-team-members"},{"title":"Invite a team member","deprecated":null,"version":null,"sidebarTitle":"Invite a team member","openapi":"/api-reference/openapi.json post /v1/auth/team-memberships","href":"/api-reference/team/invite-a-team-member"},{"title":"Remove a team member","deprecated":null,"version":null,"sidebarTitle":"Remove a team member","openapi":"/api-reference/openapi.json delete /v1/auth/team-memberships/{id}","href":"/api-reference/team/remove-a-team-member"},{"title":"Change a team member role","deprecated":null,"version":null,"sidebarTitle":"Change a team member role","openapi":"/api-reference/openapi.json patch /v1/auth/team-memberships/{id}/role","href":"/api-reference/team/change-a-team-member-role"},{"title":"List roles","deprecated":null,"version":null,"sidebarTitle":"List roles","openapi":"/api-reference/openapi.json get /v1/auth/roles","href":"/api-reference/team/list-roles"}]},{"group":"Notification settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-preferences.svg","pages":[{"title":"Get notification settings","deprecated":null,"version":null,"sidebarTitle":"Get notification settings","openapi":"/api-reference/openapi.json get /v1/platform/notification-settings","href":"/api-reference/notification-settings/get-notification-settings"},{"title":"Update notification settings","deprecated":null,"version":null,"sidebarTitle":"Update notification settings","openapi":"/api-reference/openapi.json patch /v1/platform/notification-settings","href":"/api-reference/notification-settings/update-notification-settings"}]}]},{"tab":"MCP server","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/tab-mcp.svg","pages":[{"title":"MCP server","href":"/mcp/overview"}]},{"tab":"Changelog","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-history.svg","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Update a worker - Heliyos","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}