Shares a workflow with individual users, teams, or the whole organization. This action is owner-only. The call upserts the sharing group with the given access level and recipient lists. access_level sets the group tier (private, organisation, or public); org_access_level sets what an organization-wide share grants (read or write); shared_with and shared_with_teams grant read, write, or execute to a user or a team. The workflow’s referenced agent and sub-workflow IDs are flattened and forwarded so access can be mirrored to them. Credentials typed directly into a node are visible to anyone with read access, including in published versions, so use a credential from the picker in shared workflows.
A team_id is a team’s group ID, which is not yet available from a public API. To share a workflow with a team, use the share panel in the Studio.
Credentials typed directly into a node are visible to anyone with read access, including in published versions. This covers HTTP Request auth, header, and query values, A2A keys, a Guardrails key, a Crypto secret, and the trigger’s webhook secret. Use a credential from the picker in any workflow you share.
Authorizations
x-api-key
string
header
required
Lyzr API key. Studio session keys (agk_, ags_) and durable sk- keys are accepted. Required on every endpoint except GET /node-types and a webhook-triggered execute that carries X-Webhook-Secret.
Path Parameters
id
string
required
Workflow ID
Body
application/json
Share payload
access_level
enum<string>
The group tier.
Available options:
private,
organisation,
public
Example:
"organisation"
org_access_level
enum<string>
What an organization-wide share grants: read (view) or write (edit). Only used when access_level is organisation.
Available options:
read,
write
Example:
"read"
shared_with
object[]
Individual users and the access each one gets.
Show child attributes
shared_with_teams
object[]
Teams and the access each one gets.
Show child attributes
Response
OK
_id
string
group_id
string
root_resource_id
string
root_resource_type
string
access_level
enum<string>
Available options:
private,
organisation,
public,
read,
write,
execute
org_access_level
enum<string>
Available options:
read,
write
shared_with
object[]
Show child attributes
shared_with_teams
object[]
Show child attributes
agent_ids
string[]
superflow_ids
string[]
user_id
string
user_email
string
org_id
string
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Lyzr","colors":{"primary":"#FE4B1E","light":"#FE4B1E","dark":"#FE4B1E"},"logo":{"light":"https://mintcdn.com/lyzrinc/xo6QiCPiFJayrrOL/assets/logo/LyzrLight.svg?fit=max\u0026auto=format\u0026n=xo6QiCPiFJayrrOL\u0026q=85\u0026s=b1a96015130a5dc1f7d8ad4b54977270","dark":"https://mintcdn.com/lyzrinc/xo6QiCPiFJayrrOL/assets/logo/LyzrDark.svg?fit=max\u0026auto=format\u0026n=xo6QiCPiFJayrrOL\u0026q=85\u0026s=6ec155f8cfa5b83cf3941d6b10c3e2d9"},"favicon":"https://mintcdn.com/lyzrinc/bGxeLdNqyZVWUWU3/assets/favicon.svg?fit=max\u0026auto=format\u0026n=bGxeLdNqyZVWUWU3\u0026q=85\u0026s=0bf9187f30914304976b0cb77aa263c7","api":{"playground":{"display":"interactive","proxy":false}},"background":{"color":{"light":"#FAFAF9","dark":"#1F2022"}},"navbar":{"links":[{"href":"https://discord.gg/uaHrgJQxAv","label":"Community"}],"primary":{"type":"button","label":"Lyzr Studio","href":"https://studio.lyzr.ai"}},"footer":{"socials":{"twitter":"https://twitter.com/lyzrai","github":"https://github.com/LyzrCore/lyzr","linkedin":"https://www.linkedin.com/company/lyzr-platform"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lyzrinc","hasAudioNarration":false,"actualSubdomain":"lyzrinc","customDomains":["docs.lyzr.ai"],"gitSource":{"type":"github","owner":"lyzrcore","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae802b165136d2de8e54140","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":136},{"language":"default","tag":"Integrations","count":81},{"language":"default","tag":"Tools","count":60},{"language":"default","tag":"SuperFlow","count":46},{"language":"default","tag":"Architect","count":44},{"language":"default","tag":"Agent Studio","count":43},{"language":"default","tag":"Connectors","count":42},{"language":"default","tag":"Orchestration","count":40},{"language":"default","tag":"ADK","count":29},{"language":"default","tag":"GitAgent","count":23}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"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":"editor-metadata","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},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"assets/custom.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZJhiI2B.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZthiI2B.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZNhiI2B.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZxhiI2B.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZBhiI2B.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZFhiI2B.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZ9hiA.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbv2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8yKwBNntkaToggR7BYRbKPx3cwhsk.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbv2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8yKwBNntkaToggR7BYRbKPxTcwhsk.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbv2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8yKwBNntkaToggR7BYRbKPxPcwhsk.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbv2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8yKwBNntkaToggR7BYRbKPx_cwhsk.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbv2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8yKwBNntkaToggR7BYRbKPx7cwhsk.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbv2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8yKwBNntkaToggR7BYRbKPxDcwg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbv2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8yKwBNntkaToggR7BYRbKPx3cwhsk.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbv2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8yKwBNntkaToggR7BYRbKPxTcwhsk.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbv2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8yKwBNntkaToggR7BYRbKPxPcwhsk.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbv2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8yKwBNntkaToggR7BYRbKPx_cwhsk.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbv2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8yKwBNntkaToggR7BYRbKPx7cwhsk.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbv2o-flEEny0FZhsfKu5WU4zr3E_BX0PnT8RD8yKwBNntkaToggR7BYRbKPxDcwg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n:root{--lyzr-orange: #FE4B1E;--lyzr-navy: #043E77;--lyzr-stone: #A8A298;--lyzr-offwhite: #FAFAF9;--lyzr-black: #1F2022;--grey-200: #E3E1DE;--grey-700: #6B675F;--font-sans: \"Aeonik\", \"Inter\", -apple-system, BlinkMacSystemFont, \"Segoe UI\", Helvetica, Arial, sans-serif;--font-mono: \"JetBrains Mono\", ui-monospace, SFMono-Regular, Menlo, Consolas, monospace}body{font-family:var(--font-sans)!important}code,pre,kbd,samp{font-family:var(--font-mono)!important}h1,h2,h3,h4,h5,h6,#page-title{font-family:var(--font-sans)!important;font-weight:400!important}html:not(.dark) h1,html:not(.dark) h2,html:not(.dark) h3,html:not(.dark) h4,html:not(.dark) #page-title,html:not(.dark) .prose{color:var(--lyzr-black)}h1,#page-title{letter-spacing:-0.035em;line-height:1.05}h2{letter-spacing:-0.025em;line-height:1.15}h3{letter-spacing:-0.01em;line-height:1.4}.sidebar-group-header,.sidebar-group-header .sidebar-title,.eyebrow{font-family:var(--font-mono)!important;font-weight:500!important;font-size:12px!important;text-transform:uppercase;letter-spacing:0.06em;color:var(--grey-700)!important}.prose a:not([class*=\"card\"]):not(.not-prose){color:var(--lyzr-black);font-weight:400;border-bottom-color:var(--lyzr-orange);text-decoration-color:var(--lyzr-orange)}html.dark .prose a:not([class*=\"card\"]):not(.not-prose){color:var(--lyzr-orange)}hr,.prose hr{border-color:var(--grey-200)}html.dark hr,html.dark .prose hr{border-color:var(--grey-700)}[class*=\"VersionSelect\"],[class*=\"version-selector\"],[class*=\"versionSwitcher\"],button[data-version],button[aria-label*=\"version\"i],button[aria-label*=\"enterprise\"i],button[aria-label*=\"open source\"i],[data-testid=\"version-select\"],nav button:has(svg.lucide-chevron-down),.version-switcher button,.version-dropdown-trigger{border:1px solid rgba(128, 128, 128, 0.35)!important;border-radius:6px!important;padding:4px 10px 4px 12px!important;font-weight:400!important;gap:6px!important;background:rgba(0, 0, 0, 0.06)!important;transition:background 0.15s, border-color 0.15s!important}[class*=\"VersionSelect\"]:hover,button[data-version]:hover,[data-testid=\"version-select\"]:hover,nav button:has(svg.lucide-chevron-down):hover,.version-dropdown-trigger:hover{background:rgba(0, 0, 0, 0.10)!important;border-color:rgba(128, 128, 128, 0.55)!important}html.dark [class*=\"VersionSelect\"],html.dark [class*=\"version-selector\"],html.dark button[data-version],html.dark [data-testid=\"version-select\"],html.dark nav button:has(svg.lucide-chevron-down),html.dark .version-dropdown-trigger{border-color:rgba(255, 255, 255, 0.25)!important;background:rgba(255, 255, 255, 0.08)!important}html.dark [class*=\"VersionSelect\"]:hover,html.dark button[data-version]:hover,html.dark nav button:has(svg.lucide-chevron-down):hover,html.dark .version-dropdown-trigger:hover{background:rgba(255, 255, 255, 0.13)!important;border-color:rgba(255, 255, 255, 0.4)!important}nav a[href*=\"github.com/LyzrCore\"],nav a[href*=\"github.com/open-gitagent\"],header a[href*=\"github.com/LyzrCore\"],header a[href*=\"github.com/open-gitagent\"],nav a[href*=\"studio.lyzr.ai\"],header a[href*=\"studio.lyzr.ai\"]{display:inline-flex!important;align-items:center!important;gap:0!important;background-color:var(--lyzr-orange)!important;color:var(--lyzr-offwhite)!important;border-radius:6px!important;padding:8px 20px!important;font-size:0.875rem!important;font-weight:400!important;text-decoration:none!important;white-space:nowrap!important;border:none!important;outline:none!important;box-shadow:none!important;overflow:visible!important;transition:background-color 0.15s!important}nav a[href*=\"github.com/LyzrCore\"] svg,nav a[href*=\"github.com/LyzrCore\"] [class*=\"chevron\"],nav a[href*=\"github.com/LyzrCore\"] [class*=\"arrow\"],nav a[href*=\"github.com/LyzrCore\"] [class*=\"icon\"],nav a[href*=\"github.com/LyzrCore\"]::after,nav a[href*=\"github.com/LyzrCore\"]::before,nav a[href*=\"github.com/open-gitagent\"] svg,nav a[href*=\"github.com/open-gitagent\"]::after,header a[href*=\"github.com/LyzrCore\"] svg,header a[href*=\"github.com/LyzrCore\"]::after,header a[href*=\"github.com/open-gitagent\"] svg,header a[href*=\"github.com/open-gitagent\"]::after,nav a[href*=\"studio.lyzr.ai\"] svg,nav a[href*=\"studio.lyzr.ai\"] [class*=\"chevron\"],nav a[href*=\"studio.lyzr.ai\"] [class*=\"arrow\"],nav a[href*=\"studio.lyzr.ai\"] [class*=\"icon\"],nav a[href*=\"studio.lyzr.ai\"]::after,nav a[href*=\"studio.lyzr.ai\"]::before,header a[href*=\"studio.lyzr.ai\"] svg,header a[href*=\"studio.lyzr.ai\"]::after,header a[href*=\"studio.lyzr.ai\"]::before{display:none!important;content:none!important;width:0!important;height:0!important;font-size:0!important}nav a[href*=\"github.com/LyzrCore\"]:hover,nav a[href*=\"github.com/open-gitagent\"]:hover,header a[href*=\"github.com/LyzrCore\"]:hover,nav a[href*=\"studio.lyzr.ai\"]:hover,header a[href*=\"studio.lyzr.ai\"]:hover{background-color:var(--lyzr-black)!important;color:var(--lyzr-offwhite)!important}footer a[href*=\"github.com\"]{background:none!important;background-color:transparent!important;padding:0!important;border-radius:0!important;color:inherit!important;display:inline-flex!important;align-items:center!important;width:20px!important;height:20px!important}footer a[href*=\"github.com\"] svg{display:inline!important;width:20px!important;height:20px!important}footer a[href*=\"studio.lyzr.ai\"],footer a[href*=\"studio.lyzr.ai\"]+*,footer [class*=\"primary\"] a[href*=\"studio.lyzr.ai\"]{display:none!important}html.dark nav a[href*=\"github.com/LyzrCore\"],html.dark nav a[href*=\"github.com/open-gitagent\"],html.dark header a[href*=\"github.com/LyzrCore\"],html.dark header a[href*=\"github.com/open-gitagent\"],html.dark nav a[href*=\"studio.lyzr.ai\"],html.dark header a[href*=\"studio.lyzr.ai\"]{background-color:var(--lyzr-orange)!important;color:var(--lyzr-offwhite)!important;border:none!important;border-radius:6px!important;outline:none!important;box-shadow:none!important;overflow:visible!important}html.dark nav a[href*=\"github.com/LyzrCore\"]:hover,html.dark nav a[href*=\"github.com/open-gitagent\"]:hover,html.dark header a[href*=\"github.com/LyzrCore\"]:hover,html.dark nav a[href*=\"studio.lyzr.ai\"]:hover,html.dark header a[href*=\"studio.lyzr.ai\"]:hover{background-color:var(--lyzr-offwhite)!important;color:var(--lyzr-black)!important}"}],"page":{"pagePath":"enterprise/api/superflow/workflows/share","slug":"/enterprise/api/superflow/workflows/share","pageMetadata":{"title":"Share Workflow","openapi":"openapi/superflow.yaml POST /workflows/{id}/share","description":"Shares a workflow with individual users, teams, or the whole organization. This action is owner-only. The call upserts the sharing group with the given access level and recipient lists. access_level sets the group tier (private, organisation, or public); org_access_level sets what an organization-wide share grants (read or write); shared_with and shared_with_teams grant read, write, or execute to a user or a team. The workflow's referenced agent and sub-workflow IDs are flattened and forwarded so access can be mirrored to them. Credentials typed directly into a node are visible to anyone with read access, including in published versions, so use a credential from the picker in shared workflows.","href":"/enterprise/api/superflow/workflows/share"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Shares a workflow with individual users, teams, or the whole organization. This action is owner-only. The call upserts the sharing group with the given access level and recipient lists. access_level sets the group tier (private, organisation, or public); org_access_level sets what an organization-wide share grants (read or write); shared_with and shared_with_teams grant read, write, or execute to a user or a team. The workflow’s referenced agent and sub-workflow IDs are flattened and forwarded so access can be mirrored to them. Credentials typed directly into a node are visible to anyone with read access, including in published versions, so use a credential from the picker in shared workflows.\"\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{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The following request shares a workflow with the whole organization for viewing, gives one user edit access, and lets one team run it:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`6`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"access_level\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"organisation\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"org_access_level\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"read\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"shared_with\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [{`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"user_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"u_1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"access_level\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"write\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"shared_with_teams\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [{`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"team_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"t_9\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"access_level\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"execute\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}]`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`A `,_jsx(_components.code,{children:`team_id`}),` is a team’s group ID, which is not yet available from a public API. To share a workflow with a team, use the share panel in the Studio.`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Credentials typed directly into a node are visible to anyone with read access, including in published versions. This covers HTTP Request auth, header, and query values, A2A keys, a Guardrails key, a Crypto secret, and the trigger’s webhook secret. Use a credential from the picker in any workflow you share.`})})]})}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":{"config":{},"pageMetadata":{"title":"Share Workflow","openapi":"openapi/superflow.yaml POST /workflows/{id}/share","description":"Shares a workflow with individual users, teams, or the whole organization. This action is owner-only. The call upserts the sharing group with the given access level and recipient lists. access_level sets the group tier (private, organisation, or public); org_access_level sets what an organization-wide share grants (read or write); shared_with and shared_with_teams grant read, write, or execute to a user or a team. The workflow's referenced agent and sub-workflow IDs are flattened and forwarded so access can be mirrored to them. Credentials typed directly into a node are visible to anyone with read access, including in published versions, so use a credential from the picker in shared workflows.","href":"/enterprise/api/superflow/workflows/share"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/lyzrinc/096864f58d0733b3/assets/custom.js"],"openApiReferenceData":{"operation":{"tags":["workflows"],"summary":"Share a workflow","operationId":"shareWorkflow","description":"Shares a workflow with individual users, teams, or the whole organization. This action is owner-only. The call upserts the sharing group with the given access level and recipient lists. access_level sets the group tier (private, organisation, or public); org_access_level sets what an organization-wide share grants (read or write); shared_with and shared_with_teams grant read, write, or execute to a user or a team. The workflow's referenced agent and sub-workflow IDs are flattened and forwarded so access can be mirrored to them. Credentials typed directly into a node are visible to anyone with read access, including in published versions, so use a credential from the picker in shared workflows.","parameters":["3ffd1297-7063-44d9-84e8-7b169c686eef"],"requestBody":"36a24154-cb98-4b80-9d46-4bb8029b3f53","responses":{"200":"a64f07dc-0967-4080-b71e-04a55337af79","400":"831c042f-0d4e-43d8-9c9f-4dd866dc1e52","403":"5f77004b-b371-461d-b88e-f3bb2f71876b","404":"32471e03-295a-475d-888b-cac67abd58cf","502":"9e8e2dc5-7a8e-44c9-816a-8c95a9bd7144","503":"a5bfaf2a-2e25-430d-80b4-6054bc4ff5e4"},"method":"post","type":"path","servers":["c68453f2-417a-4af2-a9e0-5415efb19a05"],"security":["c03d5853-cf73-4539-9348-16c7d43b6a64"],"path":"/workflows/{id}/share","baseUrlOptions":["https://inference.studio.lyzr.ai/api"],"title":"Share a workflow","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"3ffd1297-7063-44d9-84e8-7b169c686eef":{"name":"id","in":"path","required":true,"description":"Workflow ID","schema":{"type":"string","isRequired":true,"description":"Workflow ID","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"description":"Share payload","content":{"application/json":{"schema":{"type":"object","properties":{"access_level":{"type":"string","enum":["private","organisation","public"],"description":"The group tier.","example":"organisation","uniqueKey":"access_level","typeLabel":"enum\u003cstring>"},"org_access_level":{"type":"string","enum":["read","write"],"description":"What an organization-wide share grants: read (view) or write (edit). Only used when access_level is organisation.","example":"read","uniqueKey":"org_access_level","typeLabel":"enum\u003cstring>"},"shared_with":{"type":"array","description":"Individual users and the access each one gets.","items":{"type":"object","properties":{"email":{"type":"string","uniqueKey":"shared_with.items.[INDEX].email","typeLabel":"string"},"user_id":{"type":"string","uniqueKey":"shared_with.items.[INDEX].user_id","typeLabel":"string"},"access_level":{"type":"string","enum":["read","write","execute"],"uniqueKey":"shared_with.items.[INDEX].access_level","typeLabel":"enum\u003cstring>"}},"uniqueKey":"shared_with.items.[INDEX]","typeLabel":"object"},"uniqueKey":"shared_with","typeLabel":"object[]"},"shared_with_teams":{"type":"array","description":"Teams and the access each one gets.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's group ID. It is not yet available from a public API, so share with teams from the Studio's share panel.","example":"t_9","uniqueKey":"shared_with_teams.items.[INDEX].team_id","typeLabel":"string"},"access_level":{"type":"string","enum":["read","write","execute"],"example":"execute","uniqueKey":"shared_with_teams.items.[INDEX].access_level","typeLabel":"enum\u003cstring>"}},"uniqueKey":"shared_with_teams.items.[INDEX]","typeLabel":"object"},"uniqueKey":"shared_with_teams","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"access_level":"organisation","org_access_level":"read","shared_with":[{"email":"\u003cstring>","user_id":"\u003cstring>"}],"shared_with_teams":[{"team_id":"t_9","access_level":"execute"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a64f07dc-0967-4080-b71e-04a55337af79":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"_id":{"type":"string","uniqueKey":"_id","typeLabel":"string"},"group_id":{"type":"string","uniqueKey":"group_id","typeLabel":"string"},"root_resource_id":{"type":"string","uniqueKey":"root_resource_id","typeLabel":"string"},"root_resource_type":{"type":"string","uniqueKey":"root_resource_type","typeLabel":"string"},"access_level":{"type":"string","enum":["private","organisation","public","read","write","execute"],"uniqueKey":"access_level","typeLabel":"enum\u003cstring>"},"org_access_level":{"type":"string","enum":["read","write"],"uniqueKey":"org_access_level","typeLabel":"enum\u003cstring>"},"shared_with":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","uniqueKey":"shared_with.items.[INDEX].email","typeLabel":"string"},"user_id":{"type":"string","uniqueKey":"shared_with.items.[INDEX].user_id","typeLabel":"string"},"access_level":{"type":"string","enum":["read","write","execute"],"uniqueKey":"shared_with.items.[INDEX].access_level","typeLabel":"enum\u003cstring>"}},"uniqueKey":"shared_with.items.[INDEX]","typeLabel":"object"},"uniqueKey":"shared_with","typeLabel":"object[]"},"shared_with_teams":{"type":"array","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's group ID. It is not yet available from a public API, so share with teams from the Studio's share panel.","example":"t_9","uniqueKey":"shared_with_teams.items.[INDEX].team_id","typeLabel":"string"},"access_level":{"type":"string","enum":["read","write","execute"],"example":"execute","uniqueKey":"shared_with_teams.items.[INDEX].access_level","typeLabel":"enum\u003cstring>"}},"uniqueKey":"shared_with_teams.items.[INDEX]","typeLabel":"object"},"uniqueKey":"shared_with_teams","typeLabel":"object[]"},"agent_ids":{"type":"array","items":{"type":"string","uniqueKey":"agent_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"agent_ids","typeLabel":"string[]"},"superflow_ids":{"type":"array","items":{"type":"string","uniqueKey":"superflow_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"superflow_ids","typeLabel":"string[]"},"user_id":{"type":"string","uniqueKey":"user_id","typeLabel":"string"},"user_email":{"type":"string","uniqueKey":"user_email","typeLabel":"string"},"org_id":{"type":"string","uniqueKey":"org_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_id":"\u003cstring>","group_id":"\u003cstring>","root_resource_id":"\u003cstring>","root_resource_type":"\u003cstring>","access_level":"private","org_access_level":"read","shared_with":[{"email":"\u003cstring>","user_id":"\u003cstring>","access_level":"read"}],"shared_with_teams":[{"team_id":"t_9","access_level":"execute"}],"agent_ids":["\u003cstring>"],"superflow_ids":["\u003cstring>"],"user_id":"\u003cstring>","user_email":"\u003cstring>","org_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"831c042f-0d4e-43d8-9c9f-4dd866dc1e52":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"5f77004b-b371-461d-b88e-f3bb2f71876b":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"32471e03-295a-475d-888b-cac67abd58cf":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9e8e2dc5-7a8e-44c9-816a-8c95a9bd7144":{"description":"Sharing service error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"a5bfaf2a-2e25-430d-80b4-6054bc4ff5e4":{"description":"Sharing not configured","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c03d5853-cf73-4539-9348-16c7d43b6a64":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Lyzr API key. Studio session keys (agk_, ags_) and durable sk- keys are accepted. Required on every endpoint except GET /node-types and a webhook-triggered execute that carries X-Webhook-Secret.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"c68453f2-417a-4af2-a9e0-5415efb19a05":{"url":"https://inference.studio.lyzr.ai/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"Lyzr API key. Studio session keys (agk_, ags_) and durable sk- keys are accepted. Required on every endpoint except GET /node-types and a webhook-triggered execute that carries X-Webhook-Secret.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"Lyzr API key. Studio session keys (agk_, ags_) and durable sk- keys are accepted. Required on every endpoint except GET /node-types and a webhook-triggered execute that carries X-Webhook-Secret.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi/superflow.yaml"},"subdomain":"lyzrinc","siteName":"Lyzr","title":"Share Workflow - Lyzr","navMaps":{"firstHrefInVersion":{"Enterprise":{"href":"/enterprise/api/superflow/workflows/share","matchLevel":0},"Open-Source":{"href":"/open-source/opengap/overview","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T14:00:28.977Z","originalFileLocation":"enterprise/api/superflow/workflows/share.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=\"Shares a workflow with individual users, teams, or the whole organization. This action is owner-only. The call upserts the sharing group with the given access level and recipient lists. access_level sets the group tier (private, organisation, or public); org_access_level sets what an organization-wide share grants (read or write); shared_with and shared_with_teams grant read, write, or execute to a user or a team. The workflow\u0026#x27;s referenced agent and sub-workflow IDs are flattened and forwarded so access can be mirrored to them. Credentials typed directly into a node are visible to anyone with read access, including in published versions, so use a credential from the picker in shared workflows.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Lyzr\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lyzrinc/hXsNM-nAiiGh29-D/_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/lyzrinc/hXsNM-nAiiGh29-D/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lyzrinc/hXsNM-nAiiGh29-D/_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/lyzrinc/hXsNM-nAiiGh29-D/_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/lyzrinc/hXsNM-nAiiGh29-D/_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/lyzrinc/hXsNM-nAiiGh29-D/_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/lyzrinc/hXsNM-nAiiGh29-D/_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/lyzrinc/hXsNM-nAiiGh29-D/_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/lyzrinc/hXsNM-nAiiGh29-D/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Share Workflow - Lyzr\">\u003cmeta data-mint-head property=\"og:description\" content=\"Shares a workflow with individual users, teams, or the whole organization. This action is owner-only. The call upserts the sharing group with the given access level and recipient lists. access_level sets the group tier (private, organisation, or public); org_access_level sets what an organization-wide share grants (read or write); shared_with and shared_with_teams grant read, write, or execute to a user or a team. The workflow\u0026#x27;s referenced agent and sub-workflow IDs are flattened and forwarded so access can be mirrored to them. Credentials typed directly into a node are visible to anyone with read access, including in published versions, so use a credential from the picker in shared workflows.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Lyzr\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.lyzr.ai/enterprise/api/superflow/workflows/share\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lyzrinc.mintlify.site/_mintlify/api/og/v2?division=Workflows\u0026amp;title=Share+Workflow\u0026amp;description=Shares+a+workflow+with+individual+users%2C+teams%2C+or+the+whole+organization.+This+action+is+owner-only.+The+call+upserts+the+sharing+group+with+the+given+access+l\u0026amp;theme=97bf7c32ac91c729058827c5\u0026amp;signature=cb1dfcfff7170e0d4507d31b844e9d901edfac6a2f815e6ef1214b0cc529355e\">\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=\"Share Workflow - Lyzr\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Shares a workflow with individual users, teams, or the whole organization. This action is owner-only. The call upserts the sharing group with the given access level and recipient lists. access_level sets the group tier (private, organisation, or public); org_access_level sets what an organization-wide share grants (read or write); shared_with and shared_with_teams grant read, write, or execute to a user or a team. The workflow\u0026#x27;s referenced agent and sub-workflow IDs are flattened and forwarded so access can be mirrored to them. Credentials typed directly into a node are visible to anyone with read access, including in published versions, so use a credential from the picker in shared workflows.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lyzrinc.mintlify.site/_mintlify/api/og/v2?division=Workflows\u0026amp;title=Share+Workflow\u0026amp;description=Shares+a+workflow+with+individual+users%2C+teams%2C+or+the+whole+organization.+This+action+is+owner-only.+The+call+upserts+the+sharing+group+with+the+given+access+l\u0026amp;theme=97bf7c32ac91c729058827c5\u0026amp;signature=cb1dfcfff7170e0d4507d31b844e9d901edfac6a2f815e6ef1214b0cc529355e\">\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/lyzrinc/hXsNM-nAiiGh29-D/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Lyzr\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FE4B1E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.lyzr.ai/enterprise/api/superflow/workflows/share\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/enterprise/api/superflow/workflows/share.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.lyzr.ai/#organization\",\"name\":\"Lyzr\",\"url\":\"https://docs.lyzr.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lyzrinc/xo6QiCPiFJayrrOL/assets/logo/LyzrLight.svg?fit=max\u0026auto=format\u0026n=xo6QiCPiFJayrrOL\u0026q=85\u0026s=b1a96015130a5dc1f7d8ad4b54977270\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.lyzr.ai#website\",\"name\":\"Lyzr\",\"url\":\"https://docs.lyzr.ai\",\"publisher\":{\"@id\":\"https://docs.lyzr.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.lyzr.ai/enterprise/api/superflow/workflows/share#webpage\",\"url\":\"https://docs.lyzr.ai/enterprise/api/superflow/workflows/share\",\"name\":\"Share Workflow\",\"description\":\"Shares a workflow with individual users, teams, or the whole organization. This action is owner-only. The call upserts the sharing group with the given access level and recipient lists. access_level sets the group tier (private, organisation, or public); org_access_level sets what an organization-wide share grants (read or write); shared_with and shared_with_teams grant read, write, or execute to a user or a team. The workflow's referenced agent and sub-workflow IDs are flattened and forwarded so access can be mirrored to them. Credentials typed directly into a node are visible to anyone with read access, including in published versions, so use a credential from the picker in shared workflows.\",\"dateModified\":\"2026-10-28T14:00:28.977Z\",\"isPartOf\":{\"@id\":\"https://docs.lyzr.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.lyzr.ai/enterprise/api/superflow/workflows/share#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.lyzr.ai/enterprise/api/superflow/workflows/share#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Orchestration\",\"item\":\"https://docs.lyzr.ai/enterprise/api/superflow/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"SuperFlow\",\"item\":\"https://docs.lyzr.ai/enterprise/api/superflow/introduction\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Workflows\",\"item\":\"https://docs.lyzr.ai/enterprise/api/superflow/workflows/list\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Share Workflow\",\"item\":\"https://docs.lyzr.ai/enterprise/api/superflow/workflows/share\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.lyzr.ai/enterprise/api/superflow/workflows/share#apireference\",\"headline\":\"Share Workflow\",\"name\":\"Share Workflow\",\"description\":\"Shares a workflow with individual users, teams, or the whole organization. This action is owner-only. The call upserts the sharing group with the given access level and recipient lists. access_level sets the group tier (private, organisation, or public); org_access_level sets what an organization-wide share grants (read or write); shared_with and shared_with_teams grant read, write, or execute to a user or a team. The workflow's referenced agent and sub-workflow IDs are flattened and forwarded so access can be mirrored to them. Credentials typed directly into a node are visible to anyone with read access, including in published versions, so use a credential from the picker in shared workflows.\",\"url\":\"https://docs.lyzr.ai/enterprise/api/superflow/workflows/share\",\"mainEntityOfPage\":{\"@id\":\"https://docs.lyzr.ai/enterprise/api/superflow/workflows/share#webpage\"},\"dateModified\":\"2026-10-28T14:00:28.977Z\",\"publisher\":{\"@id\":\"https://docs.lyzr.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.lyzr.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Lyzr\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Lyzr\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/enterprise/api/superflow/workflows/share.md","siteName":"Lyzr","nav":{"global":null,"versions":[{"version":"Enterprise","tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/enterprise/get-started/intro"}]},{"tab":"Agent Studio","pages":[{"title":"Agent Studio","href":"/enterprise/agent-studio/introduction"}]},{"tab":"Architect","pages":[{"title":"Architect","href":"/enterprise/architect/introduction/overview/introduction"}]},{"tab":"Lyzr Blocks","pages":[{"title":"Lyzr Blocks","href":"/enterprise/lyzr-blocks/overview"}]},{"tab":"ADK","pages":[{"title":"ADK","href":"/enterprise/adk/overview"}]},{"tab":"API Reference","groups":[{"group":"Agents","pages":[{"title":"Lyzr Agents API","href":"/enterprise/api/agents/introduction"},{"title":"Create Agent","openapi":"post /v3/agents/","href":"/enterprise/api/agents/create"},{"title":"Get Agent by ID Endpoint","openapi":"get /agent/{agent_id}","href":"/enterprise/api/agents/get-by-id"},{"title":"Get Agents By API Key","openapi":"get /agents/","href":"/enterprise/api/agents/get-by-key"},{"title":"Update Agent Endpoint","openapi":"put /v3/agents/{agent_id}","href":"/enterprise/api/agents/update"},{"title":"Delete Agent Endpoint","openapi":"delete /agents/{agent_id}","href":"/enterprise/api/agents/delete"},{"title":"Chat With Agent","openapi":"post /inference/chat/","href":"/enterprise/api/agents/chat"},{"openapi":"post /inference/chat/","title":"Initiate/Continue Agent Chat","href":"/enterprise/api/agents/multimodal-chat"},{"title":"Stream Chat","openapi":"post /inference/stream/","sidebarTitle":"Chat Streaming","href":"/enterprise/api/agents/stream-chat"},{"title":"Agents Events in Lyzr Studio","sidebarTitle":"Agent Events","href":"/enterprise/api/agents/events"},{"title":"Agent versions","openapi":"get /agents/{agent_id}/versions","sidebarTitle":"List Agent Versions","href":"/enterprise/api/agents/versions/list"},{"title":"Get Agent Version","openapi":"get /agents/{agent_id}/versions/{version_id}","sidebarTitle":"Agent Version","href":"/enterprise/api/agents/versions/get"}]},{"group":"Sessions","pages":[{"title":"Lyzr Agent Session Retrieval","openapi":"get /agent/{agent_id}/sessions","sidebarTitle":"Session Retrieval","href":"/enterprise/api/sessions/list"},{"title":"Lyzr Agent Session History","openapi":"get /sessions/{session_id}/history","sidebarTitle":"Session History","href":"/enterprise/api/sessions/history"},{"title":"Lyzr Agent Session Management","openapi":"get /sessions/{session_id}/{agent_id}/history","sidebarTitle":"Session Management","href":"/enterprise/api/sessions/history-by-agent"},{"title":"Lyzr Agent Full Conversation","openapi":"get /sessions/{session_id}/conversation","sidebarTitle":"Full Conversation","href":"/enterprise/api/sessions/full-conversation"},{"title":"Lyzr Agent Session Summary","openapi":"get /sessions/{session_id}/summary","sidebarTitle":"Session Summary","href":"/enterprise/api/sessions/summary"},{"title":"Lyzr Agent Published Session Retrieval","openapi":"get /agent/{agent_id}/published/sessions","sidebarTitle":"Published Session Retrieval","href":"/enterprise/api/sessions/published"}]},{"group":"Orchestration","pages":[{"group":"SuperFlow","pages":[{"title":"SuperFlow API","href":"/enterprise/api/superflow/introduction"},{"group":"Workflow Definition","pages":[{"title":"Workflow Definition (flow_data)","sidebarTitle":"Structure","href":"/enterprise/api/superflow/flow-data"},{"title":"Node Types","href":"/enterprise/api/superflow/node-types"},{"title":"Get Node Catalog","openapi":"openapi/superflow.yaml GET /node-types","href":"/enterprise/api/superflow/node-catalog"}]},{"group":"Workflows","pages":[{"title":"List Workflows","openapi":"openapi/superflow.yaml GET /workflows","href":"/enterprise/api/superflow/workflows/list"},{"title":"Create Workflow","openapi":"openapi/superflow.yaml POST /workflows","href":"/enterprise/api/superflow/workflows/create"},{"title":"Get Workflow","openapi":"openapi/superflow.yaml GET /workflows/{id}","href":"/enterprise/api/superflow/workflows/get"},{"title":"Update Workflow","openapi":"openapi/superflow.yaml PUT /workflows/{id}","href":"/enterprise/api/superflow/workflows/update"},{"title":"Delete Workflow","openapi":"openapi/superflow.yaml DELETE /workflows/{id}","href":"/enterprise/api/superflow/workflows/delete"},{"title":"Bulk Delete Workflows","openapi":"openapi/superflow.yaml POST /workflows/bulk-delete","description":"Deletes multiple workflows in one call. Each ID is verified for ownership individually, so a workflow belonging to another user cannot be smuggled into the batch; denied IDs count toward failed_count.","href":"/enterprise/api/superflow/workflows/bulk-delete"},{"title":"Share Workflow","openapi":"openapi/superflow.yaml POST /workflows/{id}/share","href":"/enterprise/api/superflow/workflows/share"},{"title":"Remove Workflow Shares","openapi":"openapi/superflow.yaml DELETE /workflows/{id}/share","description":"Removes all shares for a workflow, revoking access from every recipient. This action is owner-only and tears down the sharing group.","href":"/enterprise/api/superflow/workflows/unshare"},{"title":"List Workflow Shares","openapi":"openapi/superflow.yaml GET /workflows/{id}/shares","href":"/enterprise/api/superflow/workflows/list-shares"},{"title":"Validate Workflow","openapi":"openapi/superflow.yaml POST /workflows/validate","href":"/enterprise/api/superflow/workflows/validate"},{"title":"Lock Workflow","openapi":"openapi/superflow.yaml PATCH /workflows/{id}/lock","href":"/enterprise/api/superflow/workflows/lock"}]},{"group":"Versions","pages":[{"title":"Save Version","openapi":"openapi/superflow.yaml POST /workflows/{id}/publish","href":"/enterprise/api/superflow/versions/publish"},{"title":"Deploy Version","openapi":"openapi/superflow.yaml PUT /workflows/{id}/live","href":"/enterprise/api/superflow/versions/deploy"},{"title":"List Versions","openapi":"openapi/superflow.yaml GET /workflows/{id}/versions","href":"/enterprise/api/superflow/versions/list"},{"title":"Get Version","openapi":"openapi/superflow.yaml GET /workflows/{id}/versions/{version_id}","href":"/enterprise/api/superflow/versions/get"}]},{"group":"Executions","pages":[{"title":"Execute Workflow","openapi":"openapi/superflow.yaml POST /workflows/execute","href":"/enterprise/api/superflow/executions/execute"},{"title":"List Executions","openapi":"openapi/superflow.yaml GET /executions","href":"/enterprise/api/superflow/executions/list"},{"title":"Get Execution Status","openapi":"openapi/superflow.yaml GET /executions/{id}","href":"/enterprise/api/superflow/executions/get"},{"title":"Stream Execution Events (SSE)","openapi":"openapi/superflow.yaml GET /executions/{id}/events","href":"/enterprise/api/superflow/executions/stream-events"},{"title":"Pause Execution","openapi":"openapi/superflow.yaml POST /executions/{id}/pause","href":"/enterprise/api/superflow/executions/pause"},{"title":"Resume Execution","openapi":"openapi/superflow.yaml POST /executions/{id}/resume","href":"/enterprise/api/superflow/executions/resume"},{"title":"Terminate Execution","openapi":"openapi/superflow.yaml POST /executions/{id}/terminate","href":"/enterprise/api/superflow/executions/terminate"},{"title":"Rerun Execution","openapi":"openapi/superflow.yaml POST /executions/{id}/rerun","href":"/enterprise/api/superflow/executions/rerun"}]},{"group":"Schedules","pages":[{"title":"List Schedules","openapi":"openapi/superflow.yaml GET /workflow-schedules","href":"/enterprise/api/superflow/schedules/list"},{"title":"Create Schedule","openapi":"openapi/superflow.yaml POST /workflow-schedules","href":"/enterprise/api/superflow/schedules/create"},{"title":"List Schedules for a Workflow","openapi":"openapi/superflow.yaml GET /workflow-schedules/by-workflow/{workflowId}","href":"/enterprise/api/superflow/schedules/list-by-workflow"},{"title":"List Recent Schedule Executions","openapi":"openapi/superflow.yaml GET /workflow-schedules/executions/recent","href":"/enterprise/api/superflow/schedules/recent-executions"},{"title":"Delete Schedule","openapi":"openapi/superflow.yaml DELETE /workflow-schedules/{id}","href":"/enterprise/api/superflow/schedules/delete"},{"title":"Pause Schedule","openapi":"openapi/superflow.yaml POST /workflow-schedules/{id}/pause","href":"/enterprise/api/superflow/schedules/pause"},{"title":"Resume Schedule","openapi":"openapi/superflow.yaml POST /workflow-schedules/{id}/resume","href":"/enterprise/api/superflow/schedules/resume"},{"title":"Get Schedule Snapshot","openapi":"openapi/superflow.yaml POST /workflow-schedules/{id}/refresh","href":"/enterprise/api/superflow/schedules/refresh"},{"title":"Trigger Schedule Manually","openapi":"openapi/superflow.yaml POST /workflow-schedules/{id}/trigger","href":"/enterprise/api/superflow/schedules/trigger"}]},{"group":"Approvals","pages":[{"title":"List Approvals","openapi":"openapi/superflow.yaml GET /approvals","href":"/enterprise/api/superflow/approvals/list"},{"title":"Get Approval","openapi":"openapi/superflow.yaml GET /approvals/{id}","href":"/enterprise/api/superflow/approvals/get"},{"title":"Resolve Approval","openapi":"openapi/superflow.yaml POST /approvals/{id}/resolve","href":"/enterprise/api/superflow/approvals/resolve"}]}]},{"group":"Manager Agent","pages":[{"title":"Manager Agent API","sidebarTitle":"Agent API","href":"/enterprise/agent-studio/manageragent/api"}]}]},{"group":"Scheduler","pages":[{"title":"Scheduler API","href":"/enterprise/api/scheduler/introduction"},{"group":"Schedules","pages":[{"title":"Create Schedule","openapi":"openapi/scheduler.yaml POST /schedules/","href":"/enterprise/api/scheduler/schedules/create"},{"title":"List Schedules","openapi":"openapi/scheduler.yaml GET /schedules/","href":"/enterprise/api/scheduler/schedules/list"},{"title":"Get Schedule","openapi":"openapi/scheduler.yaml GET /schedules/{schedule_id}","href":"/enterprise/api/scheduler/schedules/get"},{"title":"Delete Schedule","openapi":"openapi/scheduler.yaml DELETE /schedules/{schedule_id}","href":"/enterprise/api/scheduler/schedules/delete"},{"title":"Pause Schedule","openapi":"openapi/scheduler.yaml POST /schedules/{schedule_id}/pause","href":"/enterprise/api/scheduler/schedules/pause"},{"title":"Bulk Pause Schedules","openapi":"openapi/scheduler.yaml POST /schedules/pause-bulk/","href":"/enterprise/api/scheduler/schedules/bulk-pause"},{"title":"Resume Schedule","openapi":"openapi/scheduler.yaml POST /schedules/{schedule_id}/resume","href":"/enterprise/api/scheduler/schedules/resume"},{"title":"Trigger Schedule Now","openapi":"openapi/scheduler.yaml POST /schedules/{schedule_id}/trigger","href":"/enterprise/api/scheduler/schedules/trigger"},{"title":"Get Execution Logs","openapi":"openapi/scheduler.yaml GET /schedules/{schedule_id}/logs","href":"/enterprise/api/scheduler/schedules/logs"},{"title":"List Recent Executions","openapi":"openapi/scheduler.yaml GET /schedules/executions/recent","href":"/enterprise/api/scheduler/schedules/recent-executions"},{"title":"List Agent Attachments","openapi":"openapi/scheduler.yaml GET /schedules/by-agent/{agent_id}","href":"/enterprise/api/scheduler/schedules/list-by-agent"}]},{"group":"HTTP Schedules","pages":[{"title":"Create HTTP Schedule","openapi":"openapi/scheduler.yaml POST /http-schedules/","href":"/enterprise/api/scheduler/http-schedules/create"},{"title":"List HTTP Schedules","openapi":"openapi/scheduler.yaml GET /http-schedules/","href":"/enterprise/api/scheduler/http-schedules/list"},{"title":"Get HTTP Schedule","openapi":"openapi/scheduler.yaml GET /http-schedules/{schedule_id}","href":"/enterprise/api/scheduler/http-schedules/get"},{"title":"Update HTTP Schedule","openapi":"openapi/scheduler.yaml PATCH /http-schedules/{schedule_id}","href":"/enterprise/api/scheduler/http-schedules/update"},{"title":"Delete HTTP Schedule","openapi":"openapi/scheduler.yaml DELETE /http-schedules/{schedule_id}","href":"/enterprise/api/scheduler/http-schedules/delete"},{"title":"Pause HTTP Schedule","openapi":"openapi/scheduler.yaml POST /http-schedules/{schedule_id}/pause","href":"/enterprise/api/scheduler/http-schedules/pause"},{"title":"Resume HTTP Schedule","openapi":"openapi/scheduler.yaml POST /http-schedules/{schedule_id}/resume","href":"/enterprise/api/scheduler/http-schedules/resume"},{"title":"Trigger HTTP Schedule","openapi":"openapi/scheduler.yaml POST /http-schedules/{schedule_id}/trigger","href":"/enterprise/api/scheduler/http-schedules/trigger"},{"title":"List Recent HTTP Executions","openapi":"openapi/scheduler.yaml GET /http-schedules/executions/recent","href":"/enterprise/api/scheduler/http-schedules/recent-executions"}]}]},{"group":"Webhooks","pages":[{"title":"Webhooks API","href":"/enterprise/api/webhooks/introduction"},{"group":"Agent Webhooks","pages":[{"title":"Create Webhook","openapi":"openapi/scheduler.yaml POST /agent-webhooks/","href":"/enterprise/api/webhooks/agent-webhooks/create"},{"title":"List Webhooks","openapi":"openapi/scheduler.yaml GET /agent-webhooks/","href":"/enterprise/api/webhooks/agent-webhooks/list"},{"title":"Get Webhook","openapi":"openapi/scheduler.yaml GET /agent-webhooks/{webhook_id}","href":"/enterprise/api/webhooks/agent-webhooks/get"},{"title":"Delete Webhook","openapi":"openapi/scheduler.yaml DELETE /agent-webhooks/{webhook_id}","href":"/enterprise/api/webhooks/agent-webhooks/delete"},{"title":"Pause Webhook","openapi":"openapi/scheduler.yaml POST /agent-webhooks/{webhook_id}/pause","href":"/enterprise/api/webhooks/agent-webhooks/pause"},{"title":"Bulk Pause Webhooks","openapi":"openapi/scheduler.yaml POST /agent-webhooks/pause-bulk/","href":"/enterprise/api/webhooks/agent-webhooks/bulk-pause"},{"title":"Resume Webhook","openapi":"openapi/scheduler.yaml POST /agent-webhooks/{webhook_id}/resume","href":"/enterprise/api/webhooks/agent-webhooks/resume"},{"title":"Regenerate Webhook Secret","openapi":"openapi/scheduler.yaml POST /agent-webhooks/{webhook_id}/regenerate-secret","href":"/enterprise/api/webhooks/agent-webhooks/regenerate-secret"},{"title":"Get Webhook Execution Logs","openapi":"openapi/scheduler.yaml GET /agent-webhooks/{webhook_id}/logs","href":"/enterprise/api/webhooks/agent-webhooks/logs"},{"title":"List Recent Webhook Executions","openapi":"openapi/scheduler.yaml GET /agent-webhooks/executions/recent","href":"/enterprise/api/webhooks/agent-webhooks/recent-executions"}]},{"group":"Webhook Trigger","pages":[{"title":"Trigger Webhook","openapi":"openapi/scheduler.yaml POST /webhook-trigger/{webhook_id}","href":"/enterprise/api/webhooks/webhook-trigger/trigger"}]}]},{"group":"Tools","pages":[{"title":"Get User Tools","openapi":"get /tools/","href":"/enterprise/api/tools/list"},{"title":"Get Tool Endpoint","openapi":"get /tools/{tool_id}","href":"/enterprise/api/tools/get"},{"title":"Update Tool Endpoint","openapi":"put /tools/{tool_id}","href":"/enterprise/api/tools/update"},{"title":"Delete Tool Endpoint","openapi":"delete /tools/{tool_id}","href":"/enterprise/api/tools/delete"},{"title":"Toggle Tool","openapi":"patch /tools/{tool_id}","href":"/enterprise/api/tools/toggle"},{"title":"Create OpenAPI Tool Endpoint","openapi":"post /tools/","href":"/enterprise/api/tools/create-openapi"},{"title":"Execute OpenAPI Tool","openapi":"post /tools/openapi/{tool_id}/execute","href":"/enterprise/api/tools/execute-openapi"},{"title":"Get OpenAPI Tool Info","openapi":"get /tools/openapi/{tool_id}","href":"/enterprise/api/tools/get-openapi-info"},{"title":"Create Tool Credential Endpoint","openapi":"post /tools/credentials","href":"/enterprise/api/tools/credentials/create"},{"title":"Update Tool Credential Endpoint","openapi":"put /tools/credentials/{credential_id}","href":"/enterprise/api/tools/credentials/update"},{"title":"Delete Tool Credential Endpoint","openapi":"delete /tools/credentials/{credential_id}","href":"/enterprise/api/tools/credentials/delete"}]},{"group":"Voice Agents","pages":[{"title":"Create Agent","openapi":"post /agents","href":"/enterprise/api/voice/create"},{"title":"Get Agent Details","openapi":"get /agents/{agentId}","href":"/enterprise/api/voice/get"},{"title":"Delete Agent","openapi":"delete /agents/{agentId}","href":"/enterprise/api/voice/delete"},{"title":"Activate Agent Version","openapi":"post /agents/{agentId}/versions/{versionId}/activate","href":"/enterprise/api/voice/activate-version"},{"title":"Get Agent Stats","openapi":"get /transcripts/agent/{agentId}/stats","href":"/enterprise/api/voice/stats"},{"title":"Get Trace Details","openapi":"get /traces/session/{sessionId}/{traceId}","href":"/enterprise/api/voice/trace"},{"title":"Get Transcript","openapi":"get /transcripts/{sessionId}","href":"/enterprise/api/voice/transcript"}]},{"group":"Knowledge Base","pages":[{"group":"Parse","pages":[{"openapi":"post /parse/pdf/","title":"Parse Pdf","href":"/enterprise/lyzr-blocks/knowledge-base/api/parse-pdf"},{"openapi":"post /parse/csv/","title":"Parse Csv","href":"/enterprise/lyzr-blocks/knowledge-base/api/parse-csv"},{"openapi":"post /parse/text/","title":"Parse Text","href":"/enterprise/lyzr-blocks/knowledge-base/api/parse-text"},{"openapi":"post /parse/website/","title":"Parse Website","href":"/enterprise/lyzr-blocks/knowledge-base/api/parse-website"}]},{"group":"Train","pages":[{"openapi":"post /train/pdf/","title":"Train PDF for RAG","href":"/enterprise/lyzr-blocks/knowledge-base/api/train-pdf"},{"openapi":"post /train/docx/","title":"Train DOCX for RAG","href":"/enterprise/lyzr-blocks/knowledge-base/api/train-docx"},{"openapi":"post /train/txt/","title":"Train TXT for RAG","href":"/enterprise/lyzr-blocks/knowledge-base/api/train-txt"},{"openapi":"post /train/text/","title":"Train Text","href":"/enterprise/lyzr-blocks/knowledge-base/api/train-text"},{"openapi":"post /train/website/","title":"Train Website","href":"/enterprise/lyzr-blocks/knowledge-base/api/train-website"}]},{"group":"RAG","pages":[{"title":"Create RAG Configuration","openapi":"post /rag/","href":"/enterprise/lyzr-blocks/knowledge-base/api/create-rag"},{"title":"Get RAG configuration","openapi":"get /rag/{config_id}/","href":"/enterprise/lyzr-blocks/knowledge-base/api/get-config"},{"title":"Update RAG Configuration","openapi":"put /rag/{config_id}/","href":"/enterprise/lyzr-blocks/knowledge-base/api/update-config"},{"title":"Delete RAG Configuration","openapi":"delete /v3/rag/{config_id}/","href":"/enterprise/lyzr-blocks/knowledge-base/api/delete-config"},{"openapi":"get /rag/{rag_id}/retrieve/","title":"Retrieve","href":"/enterprise/lyzr-blocks/knowledge-base/api/retrieve"},{"openapi":"delete /rag/{rag_id}/reset/","title":"Reset Rag","href":"/enterprise/lyzr-blocks/knowledge-base/api/reset"},{"openapi":"post /v4/knowledge_graph/neo4j/{rag_id}/deduplicate/","title":"Deduplicate Entities","href":"/enterprise/lyzr-blocks/knowledge-base/api/deduplicate"},{"openapi":"get /rag/documents/{rag_id}/","title":"Get Rag Docs","href":"/enterprise/lyzr-blocks/knowledge-base/api/get-docs"},{"title":"Connect Database to RAG Endpoint","openapi":"post /v3/semantic_model/connect_database/{rag_config_id}/{database_id}","sidebarTitle":"Connect Database to RAG","href":"/enterprise/lyzr-blocks/knowledge-base/api/connect-database"}]}]},{"group":"Knowledge Graph","pages":[{"openapi":"get /v4/knowledge_graph/neo4j/graph/","title":"Get Knowledge Graph","href":"/enterprise/lyzr-blocks/knowledge-base/api/knowledge-graph"},{"openapi":"post /knowledge_graph/neo4j/","title":"Train Neo4J Knowledge Graph","href":"/enterprise/lyzr-blocks/knowledge-base/api/neo4j-pdf"},{"openapi":"post /v4/knowledge_graph/neo4j/text/","title":"Train Neo4J Text","href":"/enterprise/lyzr-blocks/knowledge-base/api/neo4j-text"},{"openapi":"post /knowledge_graph/neo4j/website/","title":"Train Neo4J Website","href":"/enterprise/lyzr-blocks/knowledge-base/api/neo4j-web"},{"openapi":"post /v4/knowledge_graph/neo4j/task/","title":"Train Neo4J Task","href":"/enterprise/lyzr-blocks/knowledge-base/api/neo4j-task"}]},{"group":"Responsible \u0026 Safe AI","pages":[{"title":"Create RAI Policy","openapi":"post /v1/rai/policies","href":"/enterprise/lyzr-blocks/responsible-ai/api/create-policy"},{"title":"Get RAI Policies","openapi":"get /v1/rai/policies","href":"/enterprise/lyzr-blocks/responsible-ai/api/get-policies"},{"title":"Prompt Injection","openapi":"post /prompt-injection-dectector/","href":"/enterprise/lyzr-blocks/responsible-ai/api/prompt-injection"},{"title":"Toxicity Checker","openapi":"post /toxicity-meter/","href":"/enterprise/lyzr-blocks/responsible-ai/api/toxicity"}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/enterprise/integrations/overview"}]},{"tab":"Learn","pages":[{"title":"Learn","href":"/enterprise/learn/overview"}]}]},{"version":"Open-Source","pages":[{"title":"Open-Source","href":"/open-source/opengap/overview"}]}]},"basePath":"","title":"Share Workflow - Lyzr","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}