完整文档索引见 llms.txt。在页面 URL 后附加 .md 即可获取 Markdown 版本；本页的 Markdown 版本可在此获取。

工作流

工作流相关操作

获取所有工作流

获取实例中的所有工作流。

GET/workflows

请求参数

参数	位置	类型	必填	说明
offset	query	number	否	开始收集结果集之前跳过的数据项数量。 默认值：0
limit	query	number	否	最多返回的数据项数量。 默认值：100
cursor	query	string	否	将 cursor 参数设为上次请求响应中的 nextCursor 属性，以进行分页。使用默认值时，获取集合的第一页。更多信息，请参阅分页说明。
active	query	string	否	可选值：true, false
tags	query	string	否
name	query	string	否
projectId	query	string	否
excludePinnedData	query	string	否	默认值："false" 可选值：true, false
includeParentFolder	query	string	否	设为 true 时，为每个工作流添加 parentFolder。parentFolder 包含文件夹的 id；工作流位于项目根目录时，其值为 null。 默认值："false" 可选值：true, false

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]id string 是 data.[]name string 是 data.[]active boolean 是 已弃用。请改为检查 activeVersionId 是否非 null。 data.[]activeVersionId string 是 data.[]createdAt string 是 data.[]updatedAt string 是 data.[]isArchived boolean 是 data.[]versionId string 是 data.[]triggerCount number 是 data.[]nodes array 是 组成工作流的节点 data.[]connections object 是 节点之间的连接，以源节点名称为键 data.[]nodeGroups array 是 在画布上以框架显示的节点视觉分组 data.[]settings object 是 工作流的执行和行为设置 展开字段 字段 类型 必填 说明 data.[]settings.saveExecutionProgress 联合类型 否 data.[]settings.saveManualExecutions 联合类型 否 data.[]settings.saveDataErrorExecution string 否 可选值：DEFAULT, all, none data.[]settings.saveDataSuccessExecution string 否 可选值：DEFAULT, all, none data.[]settings.executionTimeout number 否 data.[]settings.errorWorkflow string 否 包含错误触发器节点的工作流 ID。 data.[]settings.timezone string 否 data.[]settings.executionOrder string 否 data.[]settings.binaryMode string 否 控制如何从节点输入中解析二进制数据。这是内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 可选值：separate, combined data.[]settings.engineType string 否 运行此工作流的执行引擎。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 data.[]settings.callerPolicy string 否 控制哪些工作流可以通过 Execute Workflow 节点调用此工作流，默认为 workflowsFromSameOwner。 可选项： any：任何工作流均可调用此工作流，不作限制。 none：其他工作流均不能调用此工作流，即完全阻止。 workflowsFromSameOwner（默认）：仅属于同一项目的工作流可以调用此工作流。 workflowsFromAList：仅 callerIds 中列出的工作流可以调用此工作流。 可选值：any, none, workflowsFromAList, workflowsFromSameOwner data.[]settings.callerIds string 否 允许调用此工作流的工作流 ID 列表，以逗号分隔，仅在 workflowsFromAList 策略下使用 data.[]settings.timeSavedMode string 否 控制每次执行节省时间的计算方式。 可选项： fixed：使用 timeSavedPerExecution 的值，适用于每次执行节省时间相同的情况。 dynamic：根据实际执行指标计算节省时间，忽略 timeSavedPerExecution。 可选值：fixed, dynamic data.[]settings.timeSavedPerExecution number 否 每次执行预计节省的时间，单位为分钟 data.[]settings.redactionPolicy string 否 控制是否遮蔽此工作流的执行数据。 可选项： none（默认）：不遮蔽，存储所有执行数据。 non-manual：仅遮蔽生产执行，即非手动触发的执行。 manual-only：仅遮蔽手动触发的执行。 all：遮蔽手动和生产模式的全部执行。 可选值：none, non-manual, manual-only, all data.[]settings.redactCallerExecutions boolean 否 控制将此工作流作为子工作流调用的工作流，是否也在相同通道上遮蔽其执行数据。调用方的执行记录会保留此工作流输出的副本。默认为 true，仅当此工作流的输出不敏感时才应关闭。此工作流从自身子工作流收到的遮蔽要求，始终会传递给调用方。 data.[]settings.availableInMCP boolean 否 控制能否通过模型上下文协议（MCP）访问此工作流。默认为 false。工作流必须处于激活状态，且至少包含一个激活的 Webhook 节点。 data.[]settings.customTelemetryTags array 否 data.[]settings.credentialResolverId string 否 为此工作流解析凭据的凭据解析器 ID。这是通过凭据解析器配置管理的内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 data.[]staticData object 是 工作流在执行之间保留的数据 data.[]pinData object 否 节点的固定示例数据，以节点名称为键 data.[]meta object 是 工作流元数据，例如模板信息 展开字段 字段 类型 必填 说明 data.[]meta.onboardingId string 否 data.[]meta.templateId string 否 data.[]meta.instanceId string 否 data.[]meta.templateCredsSetupCompleted boolean 否 data.[]tags array 否 data.[]shared array 是 data.[]activeVersion object 是 展开字段 字段 类型 必填 说明 data.[]activeVersion.versionId string 是 data.[]activeVersion.workflowId string 是 data.[]activeVersion.nodes array 是 组成工作流的节点 data.[]activeVersion.connections object 是 节点之间的连接，以源节点名称为键 data.[]activeVersion.nodeGroups array 是 在画布上以框架显示的节点视觉分组 data.[]activeVersion.authors string 是 data.[]activeVersion.name string 是 data.[]activeVersion.description string 是 data.[]activeVersion.autosaved boolean 是 data.[]activeVersion.createdAt string 是 data.[]activeVersion.updatedAt string 是 data.[]parentFolder object 否 工作流所属文件夹；位于项目根目录时为 null。仅当 includeParentFolder 为 true 时返回此字段。 展开字段 字段 类型 必填 说明 data.[]parentFolder.id string 是
nextCursor	string	是

下载完整 OpenAPI 定义（JSON）

创建工作流

在实例中创建工作流。

POST/workflows

请求参数

参数	位置	类型	必填	说明
Idempotency-Key	header	string	否	此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求，会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试，会返回 409。

请求体

application/json

字段	类型	必填	说明
id	string	否	只读。
name	string	是
active	boolean	否	已弃用。请改为检查 activeVersionId 是否非 null。 只读。
activeVersionId	string	否	只读。
createdAt	string	否	只读。
updatedAt	string	否	只读。
isArchived	boolean	否	只读。
versionId	string	否	用于乐观锁的当前版本标识符 只读。
triggerCount	integer	否	工作流中激活的触发器节点数量 只读。
nodes	array	是	组成工作流的节点 展开字段 字段 类型 必填 说明 nodes.[]id string 否 nodes.[]name string 否 nodes.[]webhookId string 否 nodes.[]disabled boolean 否 nodes.[]notesInFlow boolean 否 nodes.[]notes string 否 nodes.[]type string 否 nodes.[]typeVersion number 否 nodes.[]executeOnce boolean 否 nodes.[]alwaysOutputData boolean 否 nodes.[]retryOnFail boolean 否 nodes.[]maxTries number 否 nodes.[]waitBetweenTries number 否 nodes.[]continueOnFail boolean 否 请改用 onError nodes.[]onError string 否 nodes.[]position array 否 nodes.[]parameters object 否 nodes.[]credentials object 否 nodes.[]customTelemetryTags object 否 展开字段 字段 类型 必填 说明 nodes.[]customTelemetryTags.tag array 否 nodes.[]extendsCredential string 否 nodes.[]createdAt string 否 只读。 nodes.[]updatedAt string 否 只读。
connections	object	是	节点之间的连接，以源节点名称为键
settings	object	是	展开字段 字段 类型 必填 说明 settings.saveExecutionProgress boolean 否 settings.saveManualExecutions boolean 否 settings.saveDataErrorExecution string 否 可选值：all, none settings.saveDataSuccessExecution string 否 可选值：all, none settings.executionTimeout number 否 settings.errorWorkflow string 否 包含错误触发器节点的工作流 ID。 settings.timezone string 否 settings.executionOrder string 否 settings.binaryMode string 否 控制如何从节点输入中解析二进制数据。这是内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 可选值：separate, combined settings.engineType string 否 运行此工作流的执行引擎。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 settings.callerPolicy string 否 控制哪些工作流可以通过 Execute Workflow 节点调用此工作流，默认为 workflowsFromSameOwner。 可选项： any：任何工作流均可调用此工作流，不作限制。 none：其他工作流均不能调用此工作流，即完全阻止。 workflowsFromSameOwner（默认）：仅属于同一项目的工作流可以调用此工作流。 workflowsFromAList：仅 callerIds 中列出的工作流可以调用此工作流。 可选值：any, none, workflowsFromAList, workflowsFromSameOwner settings.callerIds string 否 允许调用此工作流的工作流 ID 列表，以逗号分隔，仅在 workflowsFromAList 策略下使用 settings.timeSavedMode string 否 控制每次执行节省时间的计算方式。 可选项： fixed：使用 timeSavedPerExecution 的值，适用于每次执行节省时间相同的情况。 dynamic：根据实际执行指标计算节省时间，忽略 timeSavedPerExecution。 可选值：fixed, dynamic settings.timeSavedPerExecution number 否 每次执行预计节省的时间，单位为分钟 settings.redactionPolicy string 否 控制是否遮蔽此工作流的执行数据。 可选项： none（默认）：不遮蔽，存储所有执行数据。 non-manual：仅遮蔽生产执行，即非手动触发的执行。 manual-only：仅遮蔽手动触发的执行。 all：遮蔽手动和生产模式的全部执行。 可选值：none, non-manual, manual-only, all settings.redactCallerExecutions boolean 否 控制将此工作流作为子工作流调用的工作流，是否也在相同通道上遮蔽其执行数据。调用方的执行记录会保留此工作流输出的副本。默认为 true，仅当此工作流的输出不敏感时才应关闭。此工作流从自身子工作流收到的遮蔽要求，始终会传递给调用方。 settings.availableInMCP boolean 否 控制能否通过模型上下文协议（MCP）访问此工作流。默认为 false。工作流必须处于激活状态，且至少包含一个激活的 Webhook 节点。 settings.customTelemetryTags array 否 展开字段 字段 类型 必填 说明 settings.customTelemetryTags.[]key string 是 settings.customTelemetryTags.[]value string 是 settings.credentialResolverId string 否 为此工作流解析凭据的凭据解析器 ID。这是通过凭据解析器配置管理的内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。
nodeGroups	array	否	在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 nodeGroups.[]id string 是 节点分组的唯一标识符 nodeGroups.[]name string 是 节点分组的显示名称 nodeGroups.[]description string 否 节点分组的可选纯文本说明 nodeGroups.[]nodeIds array 是 属于此分组的节点 ID
staticData	联合类型	否	工作流在执行之间保留的数据 展开字段 结构 1 结构 2 结构 3
pinData	object	否	节点的固定示例数据，以节点名称为键
projectId	string	否	创建工作流的目标项目，默认为用户的个人项目。
parentFolderId	string	否	放置工作流的文件夹 ID；省略或设为 null 时，放在项目根目录。
meta	object	否	工作流元数据，例如模板信息 只读。 展开字段 字段 类型 必填 说明 meta.onboardingId string 否 meta.templateId string 否 meta.instanceId string 否 meta.templateCredsSetupCompleted boolean 否
tags	array	否	只读。 展开字段 字段 类型 必填 说明 tags.[]id string 否 只读。 tags.[]name string 是 tags.[]createdAt string 否 只读。 tags.[]updatedAt string 否 只读。
shared	array	否	出于兼容性原因接受此值，但会忽略。所有者共享关系由目标项目确定。 展开字段 字段 类型 必填 说明 shared.[]role string 否 shared.[]workflowId string 否 shared.[]projectId string 否 shared.[]project object 否 展开字段 字段 类型 必填 说明 shared.[]project.id string 否 只读。 shared.[]project.name string 否 shared.[]project.type string 否 只读。 shared.[]createdAt string 否 只读。 shared.[]updatedAt string 否 只读。
activeVersion	object	否	只读。 展开字段 字段 类型 必填 说明 activeVersion.versionId string 否 此工作流版本的唯一标识符 只读。 activeVersion.workflowId string 否 此版本所属的工作流 只读。 activeVersion.nodes array 否 组成工作流的节点 只读。 展开字段 字段 类型 必填 说明 activeVersion.nodes.[]id string 否 activeVersion.nodes.[]name string 否 activeVersion.nodes.[]webhookId string 否 activeVersion.nodes.[]disabled boolean 否 activeVersion.nodes.[]notesInFlow boolean 否 activeVersion.nodes.[]notes string 否 activeVersion.nodes.[]type string 否 activeVersion.nodes.[]typeVersion number 否 activeVersion.nodes.[]executeOnce boolean 否 activeVersion.nodes.[]alwaysOutputData boolean 否 activeVersion.nodes.[]retryOnFail boolean 否 activeVersion.nodes.[]maxTries number 否 activeVersion.nodes.[]waitBetweenTries number 否 activeVersion.nodes.[]continueOnFail boolean 否 请改用 onError activeVersion.nodes.[]onError string 否 activeVersion.nodes.[]position array 否 activeVersion.nodes.[]parameters object 否 activeVersion.nodes.[]credentials object 否 activeVersion.nodes.[]customTelemetryTags object 否 activeVersion.nodes.[]createdAt string 否 只读。 activeVersion.nodes.[]updatedAt string 否 只读。 activeVersion.connections object 否 节点之间的连接，以源节点名称为键 只读。 activeVersion.nodeGroups array 否 在画布上以框架显示的节点视觉分组 只读。 展开字段 字段 类型 必填 说明 activeVersion.nodeGroups.[]id string 是 节点分组的唯一标识符 activeVersion.nodeGroups.[]name string 是 节点分组的显示名称 activeVersion.nodeGroups.[]description string 否 节点分组的可选纯文本说明 activeVersion.nodeGroups.[]nodeIds array 是 属于此分组的节点 ID activeVersion.authors string 否 对此版本作出贡献的作者 ID 列表，以逗号分隔 只读。 activeVersion.name string 否 此工作流版本的可选名称 只读。 activeVersion.description string 否 此工作流版本的可选说明 只读。 activeVersion.autosaved boolean 否 此版本是否由自动保存创建 只读。 activeVersion.createdAt string 否 只读。 activeVersion.updatedAt string 否 只读。
description	string	否	工作流说明

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
409	冲突
415	不支持的媒体类型。
422	无法处理的实体

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
name	string	是
description	string	是
active	boolean	是	已弃用。请改为检查 activeVersionId 是否非 null。
activeVersionId	string	是
createdAt	string	是
updatedAt	string	是
isArchived	boolean	是
versionId	string	是
versionCounter	number	是
sourceWorkflowId	string	是
triggerCount	number	是
nodes	array	是	组成工作流的节点 展开字段 字段 类型 必填 说明 nodes.[]id string 否 nodes.[]name string 否 nodes.[]webhookId string 否 nodes.[]disabled boolean 否 nodes.[]notesInFlow boolean 否 nodes.[]notes string 否 nodes.[]type string 否 nodes.[]typeVersion number 否 nodes.[]executeOnce boolean 否 nodes.[]alwaysOutputData boolean 否 nodes.[]retryOnFail boolean 否 nodes.[]maxTries number 否 nodes.[]waitBetweenTries number 否 nodes.[]continueOnFail boolean 否 请改用 onError nodes.[]onError string 否 nodes.[]position array 否 nodes.[]parameters object 否 nodes.[]credentials object 否 nodes.[]customTelemetryTags object 否 展开字段 字段 类型 必填 说明 nodes.[]customTelemetryTags.tag array 否
connections	object	是	节点之间的连接，以源节点名称为键
nodeGroups	array	是	在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 nodeGroups.[]id string 是 节点分组的唯一标识符 nodeGroups.[]name string 是 节点分组的显示名称 nodeGroups.[]description string 否 节点分组的可选纯文本说明 nodeGroups.[]nodeIds array 是 属于此分组的节点 ID
settings	object	是	工作流的执行和行为设置 展开字段 字段 类型 必填 说明 settings.saveExecutionProgress 联合类型 否 展开字段 结构 1 结构 2 settings.saveManualExecutions 联合类型 否 展开字段 结构 1 结构 2 settings.saveDataErrorExecution string 否 可选值：DEFAULT, all, none settings.saveDataSuccessExecution string 否 可选值：DEFAULT, all, none settings.executionTimeout number 否 settings.errorWorkflow string 否 包含错误触发器节点的工作流 ID。 settings.timezone string 否 settings.executionOrder string 否 settings.binaryMode string 否 控制如何从节点输入中解析二进制数据。这是内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 可选值：separate, combined settings.engineType string 否 运行此工作流的执行引擎。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 settings.callerPolicy string 否 控制哪些工作流可以通过 Execute Workflow 节点调用此工作流，默认为 workflowsFromSameOwner。 可选项： any：任何工作流均可调用此工作流，不作限制。 none：其他工作流均不能调用此工作流，即完全阻止。 workflowsFromSameOwner（默认）：仅属于同一项目的工作流可以调用此工作流。 workflowsFromAList：仅 callerIds 中列出的工作流可以调用此工作流。 可选值：any, none, workflowsFromAList, workflowsFromSameOwner settings.callerIds string 否 允许调用此工作流的工作流 ID 列表，以逗号分隔，仅在 workflowsFromAList 策略下使用 settings.timeSavedMode string 否 控制每次执行节省时间的计算方式。 可选项： fixed：使用 timeSavedPerExecution 的值，适用于每次执行节省时间相同的情况。 dynamic：根据实际执行指标计算节省时间，忽略 timeSavedPerExecution。 可选值：fixed, dynamic settings.timeSavedPerExecution number 否 每次执行预计节省的时间，单位为分钟 settings.redactionPolicy string 否 控制是否遮蔽此工作流的执行数据。 可选项： none（默认）：不遮蔽，存储所有执行数据。 non-manual：仅遮蔽生产执行，即非手动触发的执行。 manual-only：仅遮蔽手动触发的执行。 all：遮蔽手动和生产模式的全部执行。 可选值：none, non-manual, manual-only, all settings.redactCallerExecutions boolean 否 控制将此工作流作为子工作流调用的工作流，是否也在相同通道上遮蔽其执行数据。调用方的执行记录会保留此工作流输出的副本。默认为 true，仅当此工作流的输出不敏感时才应关闭。此工作流从自身子工作流收到的遮蔽要求，始终会传递给调用方。 settings.availableInMCP boolean 否 控制能否通过模型上下文协议（MCP）访问此工作流。默认为 false。工作流必须处于激活状态，且至少包含一个激活的 Webhook 节点。 settings.customTelemetryTags array 否 展开字段 字段 类型 必填 说明 settings.customTelemetryTags.[]key string 是 settings.customTelemetryTags.[]value string 是 settings.credentialResolverId string 否 为此工作流解析凭据的凭据解析器 ID。这是通过凭据解析器配置管理的内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。
staticData	object	是	工作流在执行之间保留的数据
pinData	object	否	节点的固定示例数据，以节点名称为键
meta	object	是	工作流元数据，例如模板信息 展开字段 字段 类型 必填 说明 meta.onboardingId string 否 meta.templateId string 否 meta.instanceId string 否 meta.templateCredsSetupCompleted boolean 否
tags	array	否	展开字段 字段 类型 必填 说明 tags.[]id string 是 只读。 tags.[]name string 是 tags.[]createdAt string 是 只读。 tags.[]updatedAt string 是 只读。
shared	array	是	展开字段 字段 类型 必填 说明 shared.[]role string 是 shared.[]workflowId string 是 shared.[]projectId string 是 shared.[]project object 是 展开字段 字段 类型 必填 说明 shared.[]project.id string 是 只读。 shared.[]project.name string 是 shared.[]project.type string 是 可选值：personal, team 只读。 shared.[]project.icon object 是 项目图标；项目没有图标时为 null shared.[]project.description string 是 shared.[]project.customTelemetryTags array 是 shared.[]project.creatorId string 是 shared.[]project.createdAt string 是 只读。 shared.[]project.updatedAt string 是 只读。 shared.[]createdAt string 是 shared.[]updatedAt string 是
activeVersion	object	是	展开字段 字段 类型 必填 说明 activeVersion.versionId string 是 activeVersion.workflowId string 是 activeVersion.nodes array 是 组成工作流的节点 展开字段 字段 类型 必填 说明 activeVersion.nodes.[]id string 否 activeVersion.nodes.[]name string 否 activeVersion.nodes.[]webhookId string 否 activeVersion.nodes.[]disabled boolean 否 activeVersion.nodes.[]notesInFlow boolean 否 activeVersion.nodes.[]notes string 否 activeVersion.nodes.[]type string 否 activeVersion.nodes.[]typeVersion number 否 activeVersion.nodes.[]executeOnce boolean 否 activeVersion.nodes.[]alwaysOutputData boolean 否 activeVersion.nodes.[]retryOnFail boolean 否 activeVersion.nodes.[]maxTries number 否 activeVersion.nodes.[]waitBetweenTries number 否 activeVersion.nodes.[]continueOnFail boolean 否 请改用 onError activeVersion.nodes.[]onError string 否 activeVersion.nodes.[]position array 否 activeVersion.nodes.[]parameters object 否 activeVersion.nodes.[]credentials object 否 activeVersion.nodes.[]customTelemetryTags object 否 activeVersion.connections object 是 节点之间的连接，以源节点名称为键 activeVersion.nodeGroups array 是 在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 activeVersion.nodeGroups.[]id string 是 节点分组的唯一标识符 activeVersion.nodeGroups.[]name string 是 节点分组的显示名称 activeVersion.nodeGroups.[]description string 否 节点分组的可选纯文本说明 activeVersion.nodeGroups.[]nodeIds array 是 属于此分组的节点 ID activeVersion.authors string 是 activeVersion.name string 是 activeVersion.description string 是 activeVersion.autosaved boolean 是 activeVersion.createdAt string 是 activeVersion.updatedAt string 是 activeVersion.workflowPublishHistory array 是 展开字段 字段 类型 必填 说明 activeVersion.workflowPublishHistory.[]id number 是 activeVersion.workflowPublishHistory.[]workflowId string 是 activeVersion.workflowPublishHistory.[]versionId string 是 activeVersion.workflowPublishHistory.[]event string 是 可选值：activated, deactivated activeVersion.workflowPublishHistory.[]userId string 是 activeVersion.workflowPublishHistory.[]createdAt string 是
parentFolder	object	是	放置工作流的文件夹；位于项目根目录时为 null 展开字段 字段 类型 必填 说明 parentFolder.id string 是 parentFolder.name string 是 parentFolder.parentFolderId string 是 parentFolder.createdAt string 是 parentFolder.updatedAt string 是

下载完整 OpenAPI 定义（JSON）

获取工作流

获取工作流。

GET/workflows/{workflowId}

请求参数

参数	位置	类型	必填	说明
workflowId	path	string	是	工作流的 ID。
excludePinnedData	query	string	否	默认值："false" 可选值：true, false

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
name	string	是
description	string	是
active	boolean	是	已弃用。请改为检查 activeVersionId 是否非 null。
activeVersionId	string	是
createdAt	string	是
updatedAt	string	是
isArchived	boolean	是
versionId	string	是
versionCounter	number	是
sourceWorkflowId	string	是
triggerCount	number	是
nodes	array	是	组成工作流的节点 展开字段 字段 类型 必填 说明 nodes.[]id string 否 nodes.[]name string 否 nodes.[]webhookId string 否 nodes.[]disabled boolean 否 nodes.[]notesInFlow boolean 否 nodes.[]notes string 否 nodes.[]type string 否 nodes.[]typeVersion number 否 nodes.[]executeOnce boolean 否 nodes.[]alwaysOutputData boolean 否 nodes.[]retryOnFail boolean 否 nodes.[]maxTries number 否 nodes.[]waitBetweenTries number 否 nodes.[]continueOnFail boolean 否 请改用 onError nodes.[]onError string 否 nodes.[]position array 否 nodes.[]parameters object 否 nodes.[]credentials object 否 nodes.[]customTelemetryTags object 否 展开字段 字段 类型 必填 说明 nodes.[]customTelemetryTags.tag array 否
connections	object	是	节点之间的连接，以源节点名称为键
nodeGroups	array	是	在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 nodeGroups.[]id string 是 节点分组的唯一标识符 nodeGroups.[]name string 是 节点分组的显示名称 nodeGroups.[]description string 否 节点分组的可选纯文本说明 nodeGroups.[]nodeIds array 是 属于此分组的节点 ID
settings	object	是	工作流的执行和行为设置 展开字段 字段 类型 必填 说明 settings.saveExecutionProgress 联合类型 否 展开字段 结构 1 结构 2 settings.saveManualExecutions 联合类型 否 展开字段 结构 1 结构 2 settings.saveDataErrorExecution string 否 可选值：DEFAULT, all, none settings.saveDataSuccessExecution string 否 可选值：DEFAULT, all, none settings.executionTimeout number 否 settings.errorWorkflow string 否 包含错误触发器节点的工作流 ID。 settings.timezone string 否 settings.executionOrder string 否 settings.binaryMode string 否 控制如何从节点输入中解析二进制数据。这是内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 可选值：separate, combined settings.engineType string 否 运行此工作流的执行引擎。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 settings.callerPolicy string 否 控制哪些工作流可以通过 Execute Workflow 节点调用此工作流，默认为 workflowsFromSameOwner。 可选项： any：任何工作流均可调用此工作流，不作限制。 none：其他工作流均不能调用此工作流，即完全阻止。 workflowsFromSameOwner（默认）：仅属于同一项目的工作流可以调用此工作流。 workflowsFromAList：仅 callerIds 中列出的工作流可以调用此工作流。 可选值：any, none, workflowsFromAList, workflowsFromSameOwner settings.callerIds string 否 允许调用此工作流的工作流 ID 列表，以逗号分隔，仅在 workflowsFromAList 策略下使用 settings.timeSavedMode string 否 控制每次执行节省时间的计算方式。 可选项： fixed：使用 timeSavedPerExecution 的值，适用于每次执行节省时间相同的情况。 dynamic：根据实际执行指标计算节省时间，忽略 timeSavedPerExecution。 可选值：fixed, dynamic settings.timeSavedPerExecution number 否 每次执行预计节省的时间，单位为分钟 settings.redactionPolicy string 否 控制是否遮蔽此工作流的执行数据。 可选项： none（默认）：不遮蔽，存储所有执行数据。 non-manual：仅遮蔽生产执行，即非手动触发的执行。 manual-only：仅遮蔽手动触发的执行。 all：遮蔽手动和生产模式的全部执行。 可选值：none, non-manual, manual-only, all settings.redactCallerExecutions boolean 否 控制将此工作流作为子工作流调用的工作流，是否也在相同通道上遮蔽其执行数据。调用方的执行记录会保留此工作流输出的副本。默认为 true，仅当此工作流的输出不敏感时才应关闭。此工作流从自身子工作流收到的遮蔽要求，始终会传递给调用方。 settings.availableInMCP boolean 否 控制能否通过模型上下文协议（MCP）访问此工作流。默认为 false。工作流必须处于激活状态，且至少包含一个激活的 Webhook 节点。 settings.customTelemetryTags array 否 展开字段 字段 类型 必填 说明 settings.customTelemetryTags.[]key string 是 settings.customTelemetryTags.[]value string 是 settings.credentialResolverId string 否 为此工作流解析凭据的凭据解析器 ID。这是通过凭据解析器配置管理的内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。
staticData	object	是	工作流在执行之间保留的数据
pinData	object	否	节点的固定示例数据，以节点名称为键
meta	object	是	工作流元数据，例如模板信息 展开字段 字段 类型 必填 说明 meta.onboardingId string 否 meta.templateId string 否 meta.instanceId string 否 meta.templateCredsSetupCompleted boolean 否
tags	array	否	展开字段 字段 类型 必填 说明 tags.[]id string 是 只读。 tags.[]name string 是 tags.[]createdAt string 是 只读。 tags.[]updatedAt string 是 只读。
shared	array	是	展开字段 字段 类型 必填 说明 shared.[]role string 是 shared.[]workflowId string 是 shared.[]projectId string 是 shared.[]project object 是 展开字段 字段 类型 必填 说明 shared.[]project.id string 是 只读。 shared.[]project.name string 是 shared.[]project.type string 是 可选值：personal, team 只读。 shared.[]project.icon object 是 项目图标；项目没有图标时为 null shared.[]project.description string 是 shared.[]project.customTelemetryTags array 是 shared.[]project.creatorId string 是 shared.[]project.createdAt string 是 只读。 shared.[]project.updatedAt string 是 只读。 shared.[]createdAt string 是 shared.[]updatedAt string 是
activeVersion	object	是	展开字段 字段 类型 必填 说明 activeVersion.versionId string 是 activeVersion.workflowId string 是 activeVersion.nodes array 是 组成工作流的节点 展开字段 字段 类型 必填 说明 activeVersion.nodes.[]id string 否 activeVersion.nodes.[]name string 否 activeVersion.nodes.[]webhookId string 否 activeVersion.nodes.[]disabled boolean 否 activeVersion.nodes.[]notesInFlow boolean 否 activeVersion.nodes.[]notes string 否 activeVersion.nodes.[]type string 否 activeVersion.nodes.[]typeVersion number 否 activeVersion.nodes.[]executeOnce boolean 否 activeVersion.nodes.[]alwaysOutputData boolean 否 activeVersion.nodes.[]retryOnFail boolean 否 activeVersion.nodes.[]maxTries number 否 activeVersion.nodes.[]waitBetweenTries number 否 activeVersion.nodes.[]continueOnFail boolean 否 请改用 onError activeVersion.nodes.[]onError string 否 activeVersion.nodes.[]position array 否 activeVersion.nodes.[]parameters object 否 activeVersion.nodes.[]credentials object 否 activeVersion.nodes.[]customTelemetryTags object 否 activeVersion.connections object 是 节点之间的连接，以源节点名称为键 activeVersion.nodeGroups array 是 在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 activeVersion.nodeGroups.[]id string 是 节点分组的唯一标识符 activeVersion.nodeGroups.[]name string 是 节点分组的显示名称 activeVersion.nodeGroups.[]description string 否 节点分组的可选纯文本说明 activeVersion.nodeGroups.[]nodeIds array 是 属于此分组的节点 ID activeVersion.authors string 是 activeVersion.name string 是 activeVersion.description string 是 activeVersion.autosaved boolean 是 activeVersion.createdAt string 是 activeVersion.updatedAt string 是 activeVersion.workflowPublishHistory array 是 展开字段 字段 类型 必填 说明 activeVersion.workflowPublishHistory.[]id number 是 activeVersion.workflowPublishHistory.[]workflowId string 是 activeVersion.workflowPublishHistory.[]versionId string 是 activeVersion.workflowPublishHistory.[]event string 是 可选值：activated, deactivated activeVersion.workflowPublishHistory.[]userId string 是 activeVersion.workflowPublishHistory.[]createdAt string 是
parentFolder	object	是	工作流所属文件夹；位于项目根目录时为 null 展开字段 字段 类型 必填 说明 parentFolder.id string 是 parentFolder.name string 是 parentFolder.parentFolderId string 是 parentFolder.createdAt string 是 parentFolder.updatedAt string 是

下载完整 OpenAPI 定义（JSON）

更新工作流

更新工作流。如果工作流已发布，除非将 `publishIfActive` 设为 `false`，否则更新后的版本会自动重新发布。重新发布会使新版本上线，因此还需要 `workflow:activate` API 密钥作用域和 `workflow:publish` 项目权限。调用方缺少其中任一项时仍可保存：新版本会存为草稿，响应为 `403`，并指出缺少的权限；已发布版本继续在线。保存未发布的工作流，或使用 `publishIfActive=false` 保存时，仅需 `workflow:update`。

PUT/workflows/{workflowId}

请求参数

参数	位置	类型	必填	说明
workflowId	path	string	是	工作流的 ID。
publishIfActive	query	string	否	工作流当前已发布时，是否发布此次更新。设为 false 时，将变更保存为当前已发布工作流的草稿，不发布变更。对当前未发布的工作流无效。 默认值："true" 可选值：true, false

请求体

application/json

字段	类型	必填	说明
id	string	否	只读。
name	string	是
active	boolean	否	已弃用。请改为检查 activeVersionId 是否非 null。 只读。
activeVersionId	string	否	只读。
createdAt	string	否	只读。
updatedAt	string	否	只读。
isArchived	boolean	否	只读。
versionId	string	否	用于乐观锁的当前版本标识符 只读。
triggerCount	integer	否	工作流中激活的触发器节点数量 只读。
nodes	array	是	组成工作流的节点 展开字段 字段 类型 必填 说明 nodes.[]id string 否 nodes.[]name string 否 nodes.[]webhookId string 否 nodes.[]disabled boolean 否 nodes.[]notesInFlow boolean 否 nodes.[]notes string 否 nodes.[]type string 否 nodes.[]typeVersion number 否 nodes.[]executeOnce boolean 否 nodes.[]alwaysOutputData boolean 否 nodes.[]retryOnFail boolean 否 nodes.[]maxTries number 否 nodes.[]waitBetweenTries number 否 nodes.[]continueOnFail boolean 否 请改用 onError nodes.[]onError string 否 nodes.[]position array 否 nodes.[]parameters object 否 nodes.[]credentials object 否 nodes.[]customTelemetryTags object 否 展开字段 字段 类型 必填 说明 nodes.[]customTelemetryTags.tag array 否 nodes.[]extendsCredential string 否 nodes.[]createdAt string 否 只读。 nodes.[]updatedAt string 否 只读。
connections	object	是	节点之间的连接，以源节点名称为键
settings	object	是	展开字段 字段 类型 必填 说明 settings.saveExecutionProgress boolean 否 settings.saveManualExecutions boolean 否 settings.saveDataErrorExecution string 否 可选值：all, none settings.saveDataSuccessExecution string 否 可选值：all, none settings.executionTimeout number 否 settings.errorWorkflow string 否 包含错误触发器节点的工作流 ID。 settings.timezone string 否 settings.executionOrder string 否 settings.binaryMode string 否 控制如何从节点输入中解析二进制数据。这是内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 可选值：separate, combined settings.engineType string 否 运行此工作流的执行引擎。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 settings.callerPolicy string 否 控制哪些工作流可以通过 Execute Workflow 节点调用此工作流，默认为 workflowsFromSameOwner。 可选项： any：任何工作流均可调用此工作流，不作限制。 none：其他工作流均不能调用此工作流，即完全阻止。 workflowsFromSameOwner（默认）：仅属于同一项目的工作流可以调用此工作流。 workflowsFromAList：仅 callerIds 中列出的工作流可以调用此工作流。 可选值：any, none, workflowsFromAList, workflowsFromSameOwner settings.callerIds string 否 允许调用此工作流的工作流 ID 列表，以逗号分隔，仅在 workflowsFromAList 策略下使用 settings.timeSavedMode string 否 控制每次执行节省时间的计算方式。 可选项： fixed：使用 timeSavedPerExecution 的值，适用于每次执行节省时间相同的情况。 dynamic：根据实际执行指标计算节省时间，忽略 timeSavedPerExecution。 可选值：fixed, dynamic settings.timeSavedPerExecution number 否 每次执行预计节省的时间，单位为分钟 settings.redactionPolicy string 否 控制是否遮蔽此工作流的执行数据。 可选项： none（默认）：不遮蔽，存储所有执行数据。 non-manual：仅遮蔽生产执行，即非手动触发的执行。 manual-only：仅遮蔽手动触发的执行。 all：遮蔽手动和生产模式的全部执行。 可选值：none, non-manual, manual-only, all settings.redactCallerExecutions boolean 否 控制将此工作流作为子工作流调用的工作流，是否也在相同通道上遮蔽其执行数据。调用方的执行记录会保留此工作流输出的副本。默认为 true，仅当此工作流的输出不敏感时才应关闭。此工作流从自身子工作流收到的遮蔽要求，始终会传递给调用方。 settings.availableInMCP boolean 否 控制能否通过模型上下文协议（MCP）访问此工作流。默认为 false。工作流必须处于激活状态，且至少包含一个激活的 Webhook 节点。 settings.customTelemetryTags array 否 展开字段 字段 类型 必填 说明 settings.customTelemetryTags.[]key string 是 settings.customTelemetryTags.[]value string 是 settings.credentialResolverId string 否 为此工作流解析凭据的凭据解析器 ID。这是通过凭据解析器配置管理的内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。
nodeGroups	array	否	在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 nodeGroups.[]id string 是 节点分组的唯一标识符 nodeGroups.[]name string 是 节点分组的显示名称 nodeGroups.[]description string 否 节点分组的可选纯文本说明 nodeGroups.[]nodeIds array 是 属于此分组的节点 ID
staticData	联合类型	否	工作流在执行之间保留的数据 展开字段 结构 1 结构 2 结构 3
pinData	object	否	节点的固定示例数据，以节点名称为键
parentFolderId	string	否	将工作流移入的文件夹 ID。传入 null 可移至项目根目录；省略则保持当前文件夹不变。
meta	object	否	工作流元数据，例如模板信息 只读。 展开字段 字段 类型 必填 说明 meta.onboardingId string 否 meta.templateId string 否 meta.instanceId string 否 meta.templateCredsSetupCompleted boolean 否
tags	array	否	只读。 展开字段 字段 类型 必填 说明 tags.[]id string 否 只读。 tags.[]name string 是 tags.[]createdAt string 否 只读。 tags.[]updatedAt string 否 只读。
shared	array	否	出于兼容性原因接受此值，但会忽略。所有者共享关系由目标项目确定。 展开字段 字段 类型 必填 说明 shared.[]role string 否 shared.[]workflowId string 否 shared.[]projectId string 否 shared.[]project object 否 展开字段 字段 类型 必填 说明 shared.[]project.id string 否 只读。 shared.[]project.name string 否 shared.[]project.type string 否 只读。 shared.[]createdAt string 否 只读。 shared.[]updatedAt string 否 只读。
activeVersion	object	否	只读。 展开字段 字段 类型 必填 说明 activeVersion.versionId string 否 此工作流版本的唯一标识符 只读。 activeVersion.workflowId string 否 此版本所属的工作流 只读。 activeVersion.nodes array 否 组成工作流的节点 只读。 展开字段 字段 类型 必填 说明 activeVersion.nodes.[]id string 否 activeVersion.nodes.[]name string 否 activeVersion.nodes.[]webhookId string 否 activeVersion.nodes.[]disabled boolean 否 activeVersion.nodes.[]notesInFlow boolean 否 activeVersion.nodes.[]notes string 否 activeVersion.nodes.[]type string 否 activeVersion.nodes.[]typeVersion number 否 activeVersion.nodes.[]executeOnce boolean 否 activeVersion.nodes.[]alwaysOutputData boolean 否 activeVersion.nodes.[]retryOnFail boolean 否 activeVersion.nodes.[]maxTries number 否 activeVersion.nodes.[]waitBetweenTries number 否 activeVersion.nodes.[]continueOnFail boolean 否 请改用 onError activeVersion.nodes.[]onError string 否 activeVersion.nodes.[]position array 否 activeVersion.nodes.[]parameters object 否 activeVersion.nodes.[]credentials object 否 activeVersion.nodes.[]customTelemetryTags object 否 activeVersion.nodes.[]createdAt string 否 只读。 activeVersion.nodes.[]updatedAt string 否 只读。 activeVersion.connections object 否 节点之间的连接，以源节点名称为键 只读。 activeVersion.nodeGroups array 否 在画布上以框架显示的节点视觉分组 只读。 展开字段 字段 类型 必填 说明 activeVersion.nodeGroups.[]id string 是 节点分组的唯一标识符 activeVersion.nodeGroups.[]name string 是 节点分组的显示名称 activeVersion.nodeGroups.[]description string 否 节点分组的可选纯文本说明 activeVersion.nodeGroups.[]nodeIds array 是 属于此分组的节点 ID activeVersion.authors string 否 对此版本作出贡献的作者 ID 列表，以逗号分隔 只读。 activeVersion.name string 否 此工作流版本的可选名称 只读。 activeVersion.description string 否 此工作流版本的可选说明 只读。 activeVersion.autosaved boolean 否 此版本是否由自动保存创建 只读。 activeVersion.createdAt string 否 只读。 activeVersion.updatedAt string 否 只读。
description	string	否	工作流说明

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	此次更新会重新发布工作流，但 API 密钥缺少 workflow:activate，或调用方缺少该项目的 workflow:publish 权限。更新仍会保存为草稿，其版本由 versionId 标识；已发布版本继续在线。
404	未找到指定资源。
409	冲突，例如存在尚未结束的工作流审核而阻止重新发布（此时包含 reason 和 workflowReviewRequestId，更新本身仍保存为草稿），或发生 webhook 路径冲突。
415	不支持的媒体类型。
422	无法处理的实体

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
name	string	是
description	string	是
active	boolean	是	已弃用。请改为检查 activeVersionId 是否非 null。
activeVersionId	string	是
createdAt	string	是
updatedAt	string	是
isArchived	boolean	是
versionId	string	是
versionCounter	number	是
sourceWorkflowId	string	是
triggerCount	number	是
nodes	array	是	组成工作流的节点 展开字段 字段 类型 必填 说明 nodes.[]id string 否 nodes.[]name string 否 nodes.[]webhookId string 否 nodes.[]disabled boolean 否 nodes.[]notesInFlow boolean 否 nodes.[]notes string 否 nodes.[]type string 否 nodes.[]typeVersion number 否 nodes.[]executeOnce boolean 否 nodes.[]alwaysOutputData boolean 否 nodes.[]retryOnFail boolean 否 nodes.[]maxTries number 否 nodes.[]waitBetweenTries number 否 nodes.[]continueOnFail boolean 否 请改用 onError nodes.[]onError string 否 nodes.[]position array 否 nodes.[]parameters object 否 nodes.[]credentials object 否 nodes.[]customTelemetryTags object 否 展开字段 字段 类型 必填 说明 nodes.[]customTelemetryTags.tag array 否
connections	object	是	节点之间的连接，以源节点名称为键
nodeGroups	array	是	在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 nodeGroups.[]id string 是 节点分组的唯一标识符 nodeGroups.[]name string 是 节点分组的显示名称 nodeGroups.[]description string 否 节点分组的可选纯文本说明 nodeGroups.[]nodeIds array 是 属于此分组的节点 ID
settings	object	是	工作流的执行和行为设置 展开字段 字段 类型 必填 说明 settings.saveExecutionProgress 联合类型 否 展开字段 结构 1 结构 2 settings.saveManualExecutions 联合类型 否 展开字段 结构 1 结构 2 settings.saveDataErrorExecution string 否 可选值：DEFAULT, all, none settings.saveDataSuccessExecution string 否 可选值：DEFAULT, all, none settings.executionTimeout number 否 settings.errorWorkflow string 否 包含错误触发器节点的工作流 ID。 settings.timezone string 否 settings.executionOrder string 否 settings.binaryMode string 否 控制如何从节点输入中解析二进制数据。这是内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 可选值：separate, combined settings.engineType string 否 运行此工作流的执行引擎。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 settings.callerPolicy string 否 控制哪些工作流可以通过 Execute Workflow 节点调用此工作流，默认为 workflowsFromSameOwner。 可选项： any：任何工作流均可调用此工作流，不作限制。 none：其他工作流均不能调用此工作流，即完全阻止。 workflowsFromSameOwner（默认）：仅属于同一项目的工作流可以调用此工作流。 workflowsFromAList：仅 callerIds 中列出的工作流可以调用此工作流。 可选值：any, none, workflowsFromAList, workflowsFromSameOwner settings.callerIds string 否 允许调用此工作流的工作流 ID 列表，以逗号分隔，仅在 workflowsFromAList 策略下使用 settings.timeSavedMode string 否 控制每次执行节省时间的计算方式。 可选项： fixed：使用 timeSavedPerExecution 的值，适用于每次执行节省时间相同的情况。 dynamic：根据实际执行指标计算节省时间，忽略 timeSavedPerExecution。 可选值：fixed, dynamic settings.timeSavedPerExecution number 否 每次执行预计节省的时间，单位为分钟 settings.redactionPolicy string 否 控制是否遮蔽此工作流的执行数据。 可选项： none（默认）：不遮蔽，存储所有执行数据。 non-manual：仅遮蔽生产执行，即非手动触发的执行。 manual-only：仅遮蔽手动触发的执行。 all：遮蔽手动和生产模式的全部执行。 可选值：none, non-manual, manual-only, all settings.redactCallerExecutions boolean 否 控制将此工作流作为子工作流调用的工作流，是否也在相同通道上遮蔽其执行数据。调用方的执行记录会保留此工作流输出的副本。默认为 true，仅当此工作流的输出不敏感时才应关闭。此工作流从自身子工作流收到的遮蔽要求，始终会传递给调用方。 settings.availableInMCP boolean 否 控制能否通过模型上下文协议（MCP）访问此工作流。默认为 false。工作流必须处于激活状态，且至少包含一个激活的 Webhook 节点。 settings.customTelemetryTags array 否 展开字段 字段 类型 必填 说明 settings.customTelemetryTags.[]key string 是 settings.customTelemetryTags.[]value string 是 settings.credentialResolverId string 否 为此工作流解析凭据的凭据解析器 ID。这是通过凭据解析器配置管理的内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。
staticData	object	是	工作流在执行之间保留的数据
pinData	object	否	节点的固定示例数据，以节点名称为键
meta	object	是	工作流元数据，例如模板信息 展开字段 字段 类型 必填 说明 meta.onboardingId string 否 meta.templateId string 否 meta.instanceId string 否 meta.templateCredsSetupCompleted boolean 否
tags	array	否	展开字段 字段 类型 必填 说明 tags.[]id string 是 只读。 tags.[]name string 是 tags.[]createdAt string 是 只读。 tags.[]updatedAt string 是 只读。
activeVersion	object	是	展开字段 字段 类型 必填 说明 activeVersion.versionId string 是 activeVersion.workflowId string 是 activeVersion.nodes array 是 组成工作流的节点 展开字段 字段 类型 必填 说明 activeVersion.nodes.[]id string 否 activeVersion.nodes.[]name string 否 activeVersion.nodes.[]webhookId string 否 activeVersion.nodes.[]disabled boolean 否 activeVersion.nodes.[]notesInFlow boolean 否 activeVersion.nodes.[]notes string 否 activeVersion.nodes.[]type string 否 activeVersion.nodes.[]typeVersion number 否 activeVersion.nodes.[]executeOnce boolean 否 activeVersion.nodes.[]alwaysOutputData boolean 否 activeVersion.nodes.[]retryOnFail boolean 否 activeVersion.nodes.[]maxTries number 否 activeVersion.nodes.[]waitBetweenTries number 否 activeVersion.nodes.[]continueOnFail boolean 否 请改用 onError activeVersion.nodes.[]onError string 否 activeVersion.nodes.[]position array 否 activeVersion.nodes.[]parameters object 否 activeVersion.nodes.[]credentials object 否 activeVersion.nodes.[]customTelemetryTags object 否 activeVersion.connections object 是 节点之间的连接，以源节点名称为键 activeVersion.nodeGroups array 是 在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 activeVersion.nodeGroups.[]id string 是 节点分组的唯一标识符 activeVersion.nodeGroups.[]name string 是 节点分组的显示名称 activeVersion.nodeGroups.[]description string 否 节点分组的可选纯文本说明 activeVersion.nodeGroups.[]nodeIds array 是 属于此分组的节点 ID activeVersion.authors string 是 activeVersion.name string 是 activeVersion.description string 是 activeVersion.autosaved boolean 是 activeVersion.createdAt string 是 activeVersion.updatedAt string 是 activeVersion.workflowPublishHistory array 否 展开字段 字段 类型 必填 说明 activeVersion.workflowPublishHistory.[]id number 是 activeVersion.workflowPublishHistory.[]workflowId string 是 activeVersion.workflowPublishHistory.[]versionId string 是 activeVersion.workflowPublishHistory.[]event string 是 可选值：activated, deactivated activeVersion.workflowPublishHistory.[]userId string 是 activeVersion.workflowPublishHistory.[]createdAt string 是

响应结构：403 · application/json

字段	类型	必填	说明
message	string	是
reason	string	否	可选值：insufficient_api_key_scope, insufficient_permissions
versionId	string	否

响应结构：409 · application/json

字段	类型	必填	说明
message	string	是
reason	string	否	可选值：review_pending, changes_requested
workflowReviewRequestId	string	否

下载完整 OpenAPI 定义（JSON）

删除工作流

删除工作流。

DELETE/workflows/{workflowId}

请求参数

参数	位置	类型	必填	说明
workflowId	path	string	是	工作流的 ID。

响应

状态码	说明
200	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。
409	冲突

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
name	string	是
description	string	是
active	boolean	是	已弃用。请改为检查 activeVersionId 是否非 null。
activeVersionId	string	是
createdAt	string	是
updatedAt	string	是
isArchived	boolean	是
versionId	string	是
versionCounter	number	是
sourceWorkflowId	string	是
triggerCount	number	是
nodes	array	是	组成工作流的节点 展开字段 字段 类型 必填 说明 nodes.[]id string 否 nodes.[]name string 否 nodes.[]webhookId string 否 nodes.[]disabled boolean 否 nodes.[]notesInFlow boolean 否 nodes.[]notes string 否 nodes.[]type string 否 nodes.[]typeVersion number 否 nodes.[]executeOnce boolean 否 nodes.[]alwaysOutputData boolean 否 nodes.[]retryOnFail boolean 否 nodes.[]maxTries number 否 nodes.[]waitBetweenTries number 否 nodes.[]continueOnFail boolean 否 请改用 onError nodes.[]onError string 否 nodes.[]position array 否 nodes.[]parameters object 否 nodes.[]credentials object 否 nodes.[]customTelemetryTags object 否 展开字段 字段 类型 必填 说明 nodes.[]customTelemetryTags.tag array 否
connections	object	是	节点之间的连接，以源节点名称为键
nodeGroups	array	是	在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 nodeGroups.[]id string 是 节点分组的唯一标识符 nodeGroups.[]name string 是 节点分组的显示名称 nodeGroups.[]description string 否 节点分组的可选纯文本说明 nodeGroups.[]nodeIds array 是 属于此分组的节点 ID
settings	object	是	工作流的执行和行为设置 展开字段 字段 类型 必填 说明 settings.saveExecutionProgress 联合类型 否 展开字段 结构 1 结构 2 settings.saveManualExecutions 联合类型 否 展开字段 结构 1 结构 2 settings.saveDataErrorExecution string 否 可选值：DEFAULT, all, none settings.saveDataSuccessExecution string 否 可选值：DEFAULT, all, none settings.executionTimeout number 否 settings.errorWorkflow string 否 包含错误触发器节点的工作流 ID。 settings.timezone string 否 settings.executionOrder string 否 settings.binaryMode string 否 控制如何从节点输入中解析二进制数据。这是内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 可选值：separate, combined settings.engineType string 否 运行此工作流的执行引擎。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 settings.callerPolicy string 否 控制哪些工作流可以通过 Execute Workflow 节点调用此工作流，默认为 workflowsFromSameOwner。 可选项： any：任何工作流均可调用此工作流，不作限制。 none：其他工作流均不能调用此工作流，即完全阻止。 workflowsFromSameOwner（默认）：仅属于同一项目的工作流可以调用此工作流。 workflowsFromAList：仅 callerIds 中列出的工作流可以调用此工作流。 可选值：any, none, workflowsFromAList, workflowsFromSameOwner settings.callerIds string 否 允许调用此工作流的工作流 ID 列表，以逗号分隔，仅在 workflowsFromAList 策略下使用 settings.timeSavedMode string 否 控制每次执行节省时间的计算方式。 可选项： fixed：使用 timeSavedPerExecution 的值，适用于每次执行节省时间相同的情况。 dynamic：根据实际执行指标计算节省时间，忽略 timeSavedPerExecution。 可选值：fixed, dynamic settings.timeSavedPerExecution number 否 每次执行预计节省的时间，单位为分钟 settings.redactionPolicy string 否 控制是否遮蔽此工作流的执行数据。 可选项： none（默认）：不遮蔽，存储所有执行数据。 non-manual：仅遮蔽生产执行，即非手动触发的执行。 manual-only：仅遮蔽手动触发的执行。 all：遮蔽手动和生产模式的全部执行。 可选值：none, non-manual, manual-only, all settings.redactCallerExecutions boolean 否 控制将此工作流作为子工作流调用的工作流，是否也在相同通道上遮蔽其执行数据。调用方的执行记录会保留此工作流输出的副本。默认为 true，仅当此工作流的输出不敏感时才应关闭。此工作流从自身子工作流收到的遮蔽要求，始终会传递给调用方。 settings.availableInMCP boolean 否 控制能否通过模型上下文协议（MCP）访问此工作流。默认为 false。工作流必须处于激活状态，且至少包含一个激活的 Webhook 节点。 settings.customTelemetryTags array 否 展开字段 字段 类型 必填 说明 settings.customTelemetryTags.[]key string 是 settings.customTelemetryTags.[]value string 是 settings.credentialResolverId string 否 为此工作流解析凭据的凭据解析器 ID。这是通过凭据解析器配置管理的内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。
staticData	object	是	工作流在执行之间保留的数据
pinData	object	否	节点的固定示例数据，以节点名称为键
meta	object	是	工作流元数据，例如模板信息 展开字段 字段 类型 必填 说明 meta.onboardingId string 否 meta.templateId string 否 meta.instanceId string 否 meta.templateCredsSetupCompleted boolean 否
tags	array	否	展开字段 字段 类型 必填 说明 tags.[]id string 是 只读。 tags.[]name string 是 tags.[]createdAt string 是 只读。 tags.[]updatedAt string 是 只读。
shared	array	是	展开字段 字段 类型 必填 说明 shared.[]role string 是 shared.[]workflowId string 是 shared.[]projectId string 是 shared.[]project object 是 展开字段 字段 类型 必填 说明 shared.[]project.id string 是 只读。 shared.[]project.name string 是 shared.[]project.type string 是 可选值：personal, team 只读。 shared.[]project.icon object 是 项目图标；项目没有图标时为 null shared.[]project.description string 是 shared.[]project.customTelemetryTags array 是 shared.[]project.creatorId string 是 shared.[]project.createdAt string 是 只读。 shared.[]project.updatedAt string 是 只读。 shared.[]createdAt string 是 shared.[]updatedAt string 是
activeVersion	object	否	展开字段 字段 类型 必填 说明 activeVersion.versionId string 是 activeVersion.workflowId string 是 activeVersion.nodes array 是 组成工作流的节点 展开字段 字段 类型 必填 说明 activeVersion.nodes.[]id string 否 activeVersion.nodes.[]name string 否 activeVersion.nodes.[]webhookId string 否 activeVersion.nodes.[]disabled boolean 否 activeVersion.nodes.[]notesInFlow boolean 否 activeVersion.nodes.[]notes string 否 activeVersion.nodes.[]type string 否 activeVersion.nodes.[]typeVersion number 否 activeVersion.nodes.[]executeOnce boolean 否 activeVersion.nodes.[]alwaysOutputData boolean 否 activeVersion.nodes.[]retryOnFail boolean 否 activeVersion.nodes.[]maxTries number 否 activeVersion.nodes.[]waitBetweenTries number 否 activeVersion.nodes.[]continueOnFail boolean 否 请改用 onError activeVersion.nodes.[]onError string 否 activeVersion.nodes.[]position array 否 activeVersion.nodes.[]parameters object 否 activeVersion.nodes.[]credentials object 否 activeVersion.nodes.[]customTelemetryTags object 否 activeVersion.connections object 是 节点之间的连接，以源节点名称为键 activeVersion.nodeGroups array 是 在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 activeVersion.nodeGroups.[]id string 是 节点分组的唯一标识符 activeVersion.nodeGroups.[]name string 是 节点分组的显示名称 activeVersion.nodeGroups.[]description string 否 节点分组的可选纯文本说明 activeVersion.nodeGroups.[]nodeIds array 是 属于此分组的节点 ID activeVersion.authors string 是 activeVersion.name string 是 activeVersion.description string 是 activeVersion.autosaved boolean 是 activeVersion.createdAt string 是 activeVersion.updatedAt string 是 activeVersion.workflowPublishHistory array 是 展开字段 字段 类型 必填 说明 activeVersion.workflowPublishHistory.[]id number 是 activeVersion.workflowPublishHistory.[]workflowId string 是 activeVersion.workflowPublishHistory.[]versionId string 是 activeVersion.workflowPublishHistory.[]event string 是 可选值：activated, deactivated activeVersion.workflowPublishHistory.[]userId string 是 activeVersion.workflowPublishHistory.[]createdAt string 是

下载完整 OpenAPI 定义（JSON）

归档工作流

通过归档软删除工作流。此操作具有幂等性：对已归档的工作流再次归档时，会返回 200 及当前工作流。

POST/workflows/{workflowId}/archive

请求参数

参数	位置	类型	必填	说明
workflowId	path	string	是	工作流的 ID。

响应

状态码	说明
200	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
name	string	是
description	string	是
active	boolean	是	已弃用。请改为检查 activeVersionId 是否非 null。
activeVersionId	string	是
createdAt	string	是
updatedAt	string	是
isArchived	boolean	是
versionId	string	是
versionCounter	number	是
sourceWorkflowId	string	是
triggerCount	number	是
nodes	array	是	组成工作流的节点 展开字段 字段 类型 必填 说明 nodes.[]id string 否 nodes.[]name string 否 nodes.[]webhookId string 否 nodes.[]disabled boolean 否 nodes.[]notesInFlow boolean 否 nodes.[]notes string 否 nodes.[]type string 否 nodes.[]typeVersion number 否 nodes.[]executeOnce boolean 否 nodes.[]alwaysOutputData boolean 否 nodes.[]retryOnFail boolean 否 nodes.[]maxTries number 否 nodes.[]waitBetweenTries number 否 nodes.[]continueOnFail boolean 否 请改用 onError nodes.[]onError string 否 nodes.[]position array 否 nodes.[]parameters object 否 nodes.[]credentials object 否 nodes.[]customTelemetryTags object 否 展开字段 字段 类型 必填 说明 nodes.[]customTelemetryTags.tag array 否
connections	object	是	节点之间的连接，以源节点名称为键
nodeGroups	array	是	在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 nodeGroups.[]id string 是 节点分组的唯一标识符 nodeGroups.[]name string 是 节点分组的显示名称 nodeGroups.[]description string 否 节点分组的可选纯文本说明 nodeGroups.[]nodeIds array 是 属于此分组的节点 ID
settings	object	是	工作流的执行和行为设置 展开字段 字段 类型 必填 说明 settings.saveExecutionProgress 联合类型 否 展开字段 结构 1 结构 2 settings.saveManualExecutions 联合类型 否 展开字段 结构 1 结构 2 settings.saveDataErrorExecution string 否 可选值：DEFAULT, all, none settings.saveDataSuccessExecution string 否 可选值：DEFAULT, all, none settings.executionTimeout number 否 settings.errorWorkflow string 否 包含错误触发器节点的工作流 ID。 settings.timezone string 否 settings.executionOrder string 否 settings.binaryMode string 否 控制如何从节点输入中解析二进制数据。这是内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 可选值：separate, combined settings.engineType string 否 运行此工作流的执行引擎。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 settings.callerPolicy string 否 控制哪些工作流可以通过 Execute Workflow 节点调用此工作流，默认为 workflowsFromSameOwner。 可选项： any：任何工作流均可调用此工作流，不作限制。 none：其他工作流均不能调用此工作流，即完全阻止。 workflowsFromSameOwner（默认）：仅属于同一项目的工作流可以调用此工作流。 workflowsFromAList：仅 callerIds 中列出的工作流可以调用此工作流。 可选值：any, none, workflowsFromAList, workflowsFromSameOwner settings.callerIds string 否 允许调用此工作流的工作流 ID 列表，以逗号分隔，仅在 workflowsFromAList 策略下使用 settings.timeSavedMode string 否 控制每次执行节省时间的计算方式。 可选项： fixed：使用 timeSavedPerExecution 的值，适用于每次执行节省时间相同的情况。 dynamic：根据实际执行指标计算节省时间，忽略 timeSavedPerExecution。 可选值：fixed, dynamic settings.timeSavedPerExecution number 否 每次执行预计节省的时间，单位为分钟 settings.redactionPolicy string 否 控制是否遮蔽此工作流的执行数据。 可选项： none（默认）：不遮蔽，存储所有执行数据。 non-manual：仅遮蔽生产执行，即非手动触发的执行。 manual-only：仅遮蔽手动触发的执行。 all：遮蔽手动和生产模式的全部执行。 可选值：none, non-manual, manual-only, all settings.redactCallerExecutions boolean 否 控制将此工作流作为子工作流调用的工作流，是否也在相同通道上遮蔽其执行数据。调用方的执行记录会保留此工作流输出的副本。默认为 true，仅当此工作流的输出不敏感时才应关闭。此工作流从自身子工作流收到的遮蔽要求，始终会传递给调用方。 settings.availableInMCP boolean 否 控制能否通过模型上下文协议（MCP）访问此工作流。默认为 false。工作流必须处于激活状态，且至少包含一个激活的 Webhook 节点。 settings.customTelemetryTags array 否 展开字段 字段 类型 必填 说明 settings.customTelemetryTags.[]key string 是 settings.customTelemetryTags.[]value string 是 settings.credentialResolverId string 否 为此工作流解析凭据的凭据解析器 ID。这是通过凭据解析器配置管理的内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。
staticData	object	是	工作流在执行之间保留的数据
pinData	object	否	节点的固定示例数据，以节点名称为键
meta	object	是	工作流元数据，例如模板信息 展开字段 字段 类型 必填 说明 meta.onboardingId string 否 meta.templateId string 否 meta.instanceId string 否 meta.templateCredsSetupCompleted boolean 否
tags	array	否	展开字段 字段 类型 必填 说明 tags.[]id string 是 只读。 tags.[]name string 是 tags.[]createdAt string 是 只读。 tags.[]updatedAt string 是 只读。
shared	array	是	展开字段 字段 类型 必填 说明 shared.[]role string 是 shared.[]workflowId string 是 shared.[]projectId string 是 shared.[]project object 是 展开字段 字段 类型 必填 说明 shared.[]project.id string 是 只读。 shared.[]project.name string 是 shared.[]project.type string 是 可选值：personal, team 只读。 shared.[]project.icon object 是 项目图标；项目没有图标时为 null shared.[]project.description string 是 shared.[]project.customTelemetryTags array 是 shared.[]project.creatorId string 是 shared.[]project.createdAt string 是 只读。 shared.[]project.updatedAt string 是 只读。 shared.[]createdAt string 是 shared.[]updatedAt string 是
activeVersion	object	是	展开字段 字段 类型 必填 说明 activeVersion.versionId string 是 activeVersion.workflowId string 是 activeVersion.nodes array 是 组成工作流的节点 展开字段 字段 类型 必填 说明 activeVersion.nodes.[]id string 否 activeVersion.nodes.[]name string 否 activeVersion.nodes.[]webhookId string 否 activeVersion.nodes.[]disabled boolean 否 activeVersion.nodes.[]notesInFlow boolean 否 activeVersion.nodes.[]notes string 否 activeVersion.nodes.[]type string 否 activeVersion.nodes.[]typeVersion number 否 activeVersion.nodes.[]executeOnce boolean 否 activeVersion.nodes.[]alwaysOutputData boolean 否 activeVersion.nodes.[]retryOnFail boolean 否 activeVersion.nodes.[]maxTries number 否 activeVersion.nodes.[]waitBetweenTries number 否 activeVersion.nodes.[]continueOnFail boolean 否 请改用 onError activeVersion.nodes.[]onError string 否 activeVersion.nodes.[]position array 否 activeVersion.nodes.[]parameters object 否 activeVersion.nodes.[]credentials object 否 activeVersion.nodes.[]customTelemetryTags object 否 activeVersion.connections object 是 节点之间的连接，以源节点名称为键 activeVersion.nodeGroups array 是 在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 activeVersion.nodeGroups.[]id string 是 节点分组的唯一标识符 activeVersion.nodeGroups.[]name string 是 节点分组的显示名称 activeVersion.nodeGroups.[]description string 否 节点分组的可选纯文本说明 activeVersion.nodeGroups.[]nodeIds array 是 属于此分组的节点 ID activeVersion.authors string 是 activeVersion.name string 是 activeVersion.description string 是 activeVersion.autosaved boolean 是 activeVersion.createdAt string 是 activeVersion.updatedAt string 是 activeVersion.workflowPublishHistory array 是 展开字段 字段 类型 必填 说明 activeVersion.workflowPublishHistory.[]id number 是 activeVersion.workflowPublishHistory.[]workflowId string 是 activeVersion.workflowPublishHistory.[]versionId string 是 activeVersion.workflowPublishHistory.[]event string 是 可选值：activated, deactivated activeVersion.workflowPublishHistory.[]userId string 是 activeVersion.workflowPublishHistory.[]createdAt string 是

下载完整 OpenAPI 定义（JSON）

取消归档工作流

恢复已归档的工作流。

POST/workflows/{workflowId}/unarchive

请求参数

参数	位置	类型	必填	说明
workflowId	path	string	是	工作流的 ID。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
name	string	是
description	string	是
active	boolean	是	已弃用。请改为检查 activeVersionId 是否非 null。
activeVersionId	string	是
createdAt	string	是
updatedAt	string	是
isArchived	boolean	是
versionId	string	是
versionCounter	number	是
sourceWorkflowId	string	是
triggerCount	number	是
nodes	array	是	组成工作流的节点 展开字段 字段 类型 必填 说明 nodes.[]id string 否 nodes.[]name string 否 nodes.[]webhookId string 否 nodes.[]disabled boolean 否 nodes.[]notesInFlow boolean 否 nodes.[]notes string 否 nodes.[]type string 否 nodes.[]typeVersion number 否 nodes.[]executeOnce boolean 否 nodes.[]alwaysOutputData boolean 否 nodes.[]retryOnFail boolean 否 nodes.[]maxTries number 否 nodes.[]waitBetweenTries number 否 nodes.[]continueOnFail boolean 否 请改用 onError nodes.[]onError string 否 nodes.[]position array 否 nodes.[]parameters object 否 nodes.[]credentials object 否 nodes.[]customTelemetryTags object 否 展开字段 字段 类型 必填 说明 nodes.[]customTelemetryTags.tag array 否
connections	object	是	节点之间的连接，以源节点名称为键
nodeGroups	array	是	在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 nodeGroups.[]id string 是 节点分组的唯一标识符 nodeGroups.[]name string 是 节点分组的显示名称 nodeGroups.[]description string 否 节点分组的可选纯文本说明 nodeGroups.[]nodeIds array 是 属于此分组的节点 ID
settings	object	是	工作流的执行和行为设置 展开字段 字段 类型 必填 说明 settings.saveExecutionProgress 联合类型 否 展开字段 结构 1 结构 2 settings.saveManualExecutions 联合类型 否 展开字段 结构 1 结构 2 settings.saveDataErrorExecution string 否 可选值：DEFAULT, all, none settings.saveDataSuccessExecution string 否 可选值：DEFAULT, all, none settings.executionTimeout number 否 settings.errorWorkflow string 否 包含错误触发器节点的工作流 ID。 settings.timezone string 否 settings.executionOrder string 否 settings.binaryMode string 否 控制如何从节点输入中解析二进制数据。这是内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 可选值：separate, combined settings.engineType string 否 运行此工作流的执行引擎。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 settings.callerPolicy string 否 控制哪些工作流可以通过 Execute Workflow 节点调用此工作流，默认为 workflowsFromSameOwner。 可选项： any：任何工作流均可调用此工作流，不作限制。 none：其他工作流均不能调用此工作流，即完全阻止。 workflowsFromSameOwner（默认）：仅属于同一项目的工作流可以调用此工作流。 workflowsFromAList：仅 callerIds 中列出的工作流可以调用此工作流。 可选值：any, none, workflowsFromAList, workflowsFromSameOwner settings.callerIds string 否 允许调用此工作流的工作流 ID 列表，以逗号分隔，仅在 workflowsFromAList 策略下使用 settings.timeSavedMode string 否 控制每次执行节省时间的计算方式。 可选项： fixed：使用 timeSavedPerExecution 的值，适用于每次执行节省时间相同的情况。 dynamic：根据实际执行指标计算节省时间，忽略 timeSavedPerExecution。 可选值：fixed, dynamic settings.timeSavedPerExecution number 否 每次执行预计节省的时间，单位为分钟 settings.redactionPolicy string 否 控制是否遮蔽此工作流的执行数据。 可选项： none（默认）：不遮蔽，存储所有执行数据。 non-manual：仅遮蔽生产执行，即非手动触发的执行。 manual-only：仅遮蔽手动触发的执行。 all：遮蔽手动和生产模式的全部执行。 可选值：none, non-manual, manual-only, all settings.redactCallerExecutions boolean 否 控制将此工作流作为子工作流调用的工作流，是否也在相同通道上遮蔽其执行数据。调用方的执行记录会保留此工作流输出的副本。默认为 true，仅当此工作流的输出不敏感时才应关闭。此工作流从自身子工作流收到的遮蔽要求，始终会传递给调用方。 settings.availableInMCP boolean 否 控制能否通过模型上下文协议（MCP）访问此工作流。默认为 false。工作流必须处于激活状态，且至少包含一个激活的 Webhook 节点。 settings.customTelemetryTags array 否 展开字段 字段 类型 必填 说明 settings.customTelemetryTags.[]key string 是 settings.customTelemetryTags.[]value string 是 settings.credentialResolverId string 否 为此工作流解析凭据的凭据解析器 ID。这是通过凭据解析器配置管理的内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。
staticData	object	是	工作流在执行之间保留的数据
pinData	object	否	节点的固定示例数据，以节点名称为键
meta	object	是	工作流元数据，例如模板信息 展开字段 字段 类型 必填 说明 meta.onboardingId string 否 meta.templateId string 否 meta.instanceId string 否 meta.templateCredsSetupCompleted boolean 否
tags	array	否	展开字段 字段 类型 必填 说明 tags.[]id string 是 只读。 tags.[]name string 是 tags.[]createdAt string 是 只读。 tags.[]updatedAt string 是 只读。
shared	array	是	展开字段 字段 类型 必填 说明 shared.[]role string 是 shared.[]workflowId string 是 shared.[]projectId string 是 shared.[]project object 是 展开字段 字段 类型 必填 说明 shared.[]project.id string 是 只读。 shared.[]project.name string 是 shared.[]project.type string 是 可选值：personal, team 只读。 shared.[]project.icon object 是 项目图标；项目没有图标时为 null shared.[]project.description string 是 shared.[]project.customTelemetryTags array 是 shared.[]project.creatorId string 是 shared.[]project.createdAt string 是 只读。 shared.[]project.updatedAt string 是 只读。 shared.[]createdAt string 是 shared.[]updatedAt string 是
activeVersion	object	是	展开字段 字段 类型 必填 说明 activeVersion.versionId string 是 activeVersion.workflowId string 是 activeVersion.nodes array 是 组成工作流的节点 展开字段 字段 类型 必填 说明 activeVersion.nodes.[]id string 否 activeVersion.nodes.[]name string 否 activeVersion.nodes.[]webhookId string 否 activeVersion.nodes.[]disabled boolean 否 activeVersion.nodes.[]notesInFlow boolean 否 activeVersion.nodes.[]notes string 否 activeVersion.nodes.[]type string 否 activeVersion.nodes.[]typeVersion number 否 activeVersion.nodes.[]executeOnce boolean 否 activeVersion.nodes.[]alwaysOutputData boolean 否 activeVersion.nodes.[]retryOnFail boolean 否 activeVersion.nodes.[]maxTries number 否 activeVersion.nodes.[]waitBetweenTries number 否 activeVersion.nodes.[]continueOnFail boolean 否 请改用 onError activeVersion.nodes.[]onError string 否 activeVersion.nodes.[]position array 否 activeVersion.nodes.[]parameters object 否 activeVersion.nodes.[]credentials object 否 activeVersion.nodes.[]customTelemetryTags object 否 activeVersion.connections object 是 节点之间的连接，以源节点名称为键 activeVersion.nodeGroups array 是 在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 activeVersion.nodeGroups.[]id string 是 节点分组的唯一标识符 activeVersion.nodeGroups.[]name string 是 节点分组的显示名称 activeVersion.nodeGroups.[]description string 否 节点分组的可选纯文本说明 activeVersion.nodeGroups.[]nodeIds array 是 属于此分组的节点 ID activeVersion.authors string 是 activeVersion.name string 是 activeVersion.description string 是 activeVersion.autosaved boolean 是 activeVersion.createdAt string 是 activeVersion.updatedAt string 是 activeVersion.workflowPublishHistory array 是 展开字段 字段 类型 必填 说明 activeVersion.workflowPublishHistory.[]id number 是 activeVersion.workflowPublishHistory.[]workflowId string 是 activeVersion.workflowPublishHistory.[]versionId string 是 activeVersion.workflowPublishHistory.[]event string 是 可选值：activated, deactivated activeVersion.workflowPublishHistory.[]userId string 是 activeVersion.workflowPublishHistory.[]createdAt string 是

下载完整 OpenAPI 定义（JSON）

将工作流转移到另一个项目

将工作流转移到另一个项目。

PUT/workflows/{workflowId}/transfer

请求参数

参数	位置	类型	必填	说明
workflowId	path	string	是	工作流的 ID。

请求体

application/json

字段	类型	必填	说明
destinationProjectId	string	是

响应

状态码	说明
204	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
415	不支持的媒体类型。

下载完整 OpenAPI 定义（JSON）

发布工作流

发布工作流。在 n8n v1 中，此操作称为激活工作流。

POST/workflows/{workflowId}/publish

请求参数

参数	位置	类型	必填	说明
workflowId	path	string	是	工作流的 ID。

请求体

application/json

字段	类型	必填	说明
versionId	string	否	要发布的具体版本 ID；不提供时使用最新版本。
name	string	否	发布时设置的可选工作流版本名称。
description	string	否	发布时设置的可选工作流版本说明。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
409	冲突，例如存在尚未结束的工作流审核而阻止发布（此时包含 reason 和 workflowReviewRequestId），或发生 webhook 路径冲突。
415	不支持的媒体类型。

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
name	string	是
description	string	是
active	boolean	是	已弃用。请改为检查 activeVersionId 是否非 null。
activeVersionId	string	是
createdAt	string	是
updatedAt	string	是
isArchived	boolean	是
versionId	string	是
versionCounter	number	是
sourceWorkflowId	string	是
triggerCount	number	是
nodes	array	是	组成工作流的节点 展开字段 字段 类型 必填 说明 nodes.[]id string 否 nodes.[]name string 否 nodes.[]webhookId string 否 nodes.[]disabled boolean 否 nodes.[]notesInFlow boolean 否 nodes.[]notes string 否 nodes.[]type string 否 nodes.[]typeVersion number 否 nodes.[]executeOnce boolean 否 nodes.[]alwaysOutputData boolean 否 nodes.[]retryOnFail boolean 否 nodes.[]maxTries number 否 nodes.[]waitBetweenTries number 否 nodes.[]continueOnFail boolean 否 请改用 onError nodes.[]onError string 否 nodes.[]position array 否 nodes.[]parameters object 否 nodes.[]credentials object 否 nodes.[]customTelemetryTags object 否 展开字段 字段 类型 必填 说明 nodes.[]customTelemetryTags.tag array 否
connections	object	是	节点之间的连接，以源节点名称为键
nodeGroups	array	是	在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 nodeGroups.[]id string 是 节点分组的唯一标识符 nodeGroups.[]name string 是 节点分组的显示名称 nodeGroups.[]description string 否 节点分组的可选纯文本说明 nodeGroups.[]nodeIds array 是 属于此分组的节点 ID
settings	object	是	工作流的执行和行为设置 展开字段 字段 类型 必填 说明 settings.saveExecutionProgress 联合类型 否 展开字段 结构 1 结构 2 settings.saveManualExecutions 联合类型 否 展开字段 结构 1 结构 2 settings.saveDataErrorExecution string 否 可选值：DEFAULT, all, none settings.saveDataSuccessExecution string 否 可选值：DEFAULT, all, none settings.executionTimeout number 否 settings.errorWorkflow string 否 包含错误触发器节点的工作流 ID。 settings.timezone string 否 settings.executionOrder string 否 settings.binaryMode string 否 控制如何从节点输入中解析二进制数据。这是内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 可选值：separate, combined settings.engineType string 否 运行此工作流的执行引擎。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 settings.callerPolicy string 否 控制哪些工作流可以通过 Execute Workflow 节点调用此工作流，默认为 workflowsFromSameOwner。 可选项： any：任何工作流均可调用此工作流，不作限制。 none：其他工作流均不能调用此工作流，即完全阻止。 workflowsFromSameOwner（默认）：仅属于同一项目的工作流可以调用此工作流。 workflowsFromAList：仅 callerIds 中列出的工作流可以调用此工作流。 可选值：any, none, workflowsFromAList, workflowsFromSameOwner settings.callerIds string 否 允许调用此工作流的工作流 ID 列表，以逗号分隔，仅在 workflowsFromAList 策略下使用 settings.timeSavedMode string 否 控制每次执行节省时间的计算方式。 可选项： fixed：使用 timeSavedPerExecution 的值，适用于每次执行节省时间相同的情况。 dynamic：根据实际执行指标计算节省时间，忽略 timeSavedPerExecution。 可选值：fixed, dynamic settings.timeSavedPerExecution number 否 每次执行预计节省的时间，单位为分钟 settings.redactionPolicy string 否 控制是否遮蔽此工作流的执行数据。 可选项： none（默认）：不遮蔽，存储所有执行数据。 non-manual：仅遮蔽生产执行，即非手动触发的执行。 manual-only：仅遮蔽手动触发的执行。 all：遮蔽手动和生产模式的全部执行。 可选值：none, non-manual, manual-only, all settings.redactCallerExecutions boolean 否 控制将此工作流作为子工作流调用的工作流，是否也在相同通道上遮蔽其执行数据。调用方的执行记录会保留此工作流输出的副本。默认为 true，仅当此工作流的输出不敏感时才应关闭。此工作流从自身子工作流收到的遮蔽要求，始终会传递给调用方。 settings.availableInMCP boolean 否 控制能否通过模型上下文协议（MCP）访问此工作流。默认为 false。工作流必须处于激活状态，且至少包含一个激活的 Webhook 节点。 settings.customTelemetryTags array 否 展开字段 字段 类型 必填 说明 settings.customTelemetryTags.[]key string 是 settings.customTelemetryTags.[]value string 是 settings.credentialResolverId string 否 为此工作流解析凭据的凭据解析器 ID。这是通过凭据解析器配置管理的内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。
staticData	object	是	工作流在执行之间保留的数据
pinData	object	否	节点的固定示例数据，以节点名称为键
meta	object	是	工作流元数据，例如模板信息 展开字段 字段 类型 必填 说明 meta.onboardingId string 否 meta.templateId string 否 meta.instanceId string 否 meta.templateCredsSetupCompleted boolean 否
tags	array	否	展开字段 字段 类型 必填 说明 tags.[]id string 是 只读。 tags.[]name string 是 tags.[]createdAt string 是 只读。 tags.[]updatedAt string 是 只读。
activeVersion	object	是	展开字段 字段 类型 必填 说明 activeVersion.versionId string 是 activeVersion.workflowId string 是 activeVersion.nodes array 是 组成工作流的节点 展开字段 字段 类型 必填 说明 activeVersion.nodes.[]id string 否 activeVersion.nodes.[]name string 否 activeVersion.nodes.[]webhookId string 否 activeVersion.nodes.[]disabled boolean 否 activeVersion.nodes.[]notesInFlow boolean 否 activeVersion.nodes.[]notes string 否 activeVersion.nodes.[]type string 否 activeVersion.nodes.[]typeVersion number 否 activeVersion.nodes.[]executeOnce boolean 否 activeVersion.nodes.[]alwaysOutputData boolean 否 activeVersion.nodes.[]retryOnFail boolean 否 activeVersion.nodes.[]maxTries number 否 activeVersion.nodes.[]waitBetweenTries number 否 activeVersion.nodes.[]continueOnFail boolean 否 请改用 onError activeVersion.nodes.[]onError string 否 activeVersion.nodes.[]position array 否 activeVersion.nodes.[]parameters object 否 activeVersion.nodes.[]credentials object 否 activeVersion.nodes.[]customTelemetryTags object 否 activeVersion.connections object 是 节点之间的连接，以源节点名称为键 activeVersion.nodeGroups array 是 在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 activeVersion.nodeGroups.[]id string 是 节点分组的唯一标识符 activeVersion.nodeGroups.[]name string 是 节点分组的显示名称 activeVersion.nodeGroups.[]description string 否 节点分组的可选纯文本说明 activeVersion.nodeGroups.[]nodeIds array 是 属于此分组的节点 ID activeVersion.authors string 是 activeVersion.name string 是 activeVersion.description string 是 activeVersion.autosaved boolean 是 activeVersion.createdAt string 是 activeVersion.updatedAt string 是 activeVersion.workflowPublishHistory array 是 展开字段 字段 类型 必填 说明 activeVersion.workflowPublishHistory.[]id number 是 activeVersion.workflowPublishHistory.[]workflowId string 是 activeVersion.workflowPublishHistory.[]versionId string 是 activeVersion.workflowPublishHistory.[]event string 是 可选值：activated, deactivated activeVersion.workflowPublishHistory.[]userId string 是 activeVersion.workflowPublishHistory.[]createdAt string 是

响应结构：409 · application/json

字段	类型	必填	说明
message	string	是
reason	string	否	可选值：review_pending, changes_requested
workflowReviewRequestId	string	否

下载完整 OpenAPI 定义（JSON）

取消发布工作流

取消发布工作流。在 n8n v1 中，此操作称为停用工作流。

POST/workflows/{workflowId}/unpublish

请求参数

参数	位置	类型	必填	说明
workflowId	path	string	是	工作流的 ID。

响应

状态码	说明
200	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
name	string	是
description	string	是
active	boolean	是	已弃用。请改为检查 activeVersionId 是否非 null。
activeVersionId	string	是
createdAt	string	是
updatedAt	string	是
isArchived	boolean	是
versionId	string	是
versionCounter	number	是
sourceWorkflowId	string	是
triggerCount	number	是
nodes	array	是	组成工作流的节点 展开字段 字段 类型 必填 说明 nodes.[]id string 否 nodes.[]name string 否 nodes.[]webhookId string 否 nodes.[]disabled boolean 否 nodes.[]notesInFlow boolean 否 nodes.[]notes string 否 nodes.[]type string 否 nodes.[]typeVersion number 否 nodes.[]executeOnce boolean 否 nodes.[]alwaysOutputData boolean 否 nodes.[]retryOnFail boolean 否 nodes.[]maxTries number 否 nodes.[]waitBetweenTries number 否 nodes.[]continueOnFail boolean 否 请改用 onError nodes.[]onError string 否 nodes.[]position array 否 nodes.[]parameters object 否 nodes.[]credentials object 否 nodes.[]customTelemetryTags object 否 展开字段 字段 类型 必填 说明 nodes.[]customTelemetryTags.tag array 否
connections	object	是	节点之间的连接，以源节点名称为键
nodeGroups	array	是	在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 nodeGroups.[]id string 是 节点分组的唯一标识符 nodeGroups.[]name string 是 节点分组的显示名称 nodeGroups.[]description string 否 节点分组的可选纯文本说明 nodeGroups.[]nodeIds array 是 属于此分组的节点 ID
settings	object	是	工作流的执行和行为设置 展开字段 字段 类型 必填 说明 settings.saveExecutionProgress 联合类型 否 展开字段 结构 1 结构 2 settings.saveManualExecutions 联合类型 否 展开字段 结构 1 结构 2 settings.saveDataErrorExecution string 否 可选值：DEFAULT, all, none settings.saveDataSuccessExecution string 否 可选值：DEFAULT, all, none settings.executionTimeout number 否 settings.errorWorkflow string 否 包含错误触发器节点的工作流 ID。 settings.timezone string 否 settings.executionOrder string 否 settings.binaryMode string 否 控制如何从节点输入中解析二进制数据。这是内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 可选值：separate, combined settings.engineType string 否 运行此工作流的执行引擎。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 settings.callerPolicy string 否 控制哪些工作流可以通过 Execute Workflow 节点调用此工作流，默认为 workflowsFromSameOwner。 可选项： any：任何工作流均可调用此工作流，不作限制。 none：其他工作流均不能调用此工作流，即完全阻止。 workflowsFromSameOwner（默认）：仅属于同一项目的工作流可以调用此工作流。 workflowsFromAList：仅 callerIds 中列出的工作流可以调用此工作流。 可选值：any, none, workflowsFromAList, workflowsFromSameOwner settings.callerIds string 否 允许调用此工作流的工作流 ID 列表，以逗号分隔，仅在 workflowsFromAList 策略下使用 settings.timeSavedMode string 否 控制每次执行节省时间的计算方式。 可选项： fixed：使用 timeSavedPerExecution 的值，适用于每次执行节省时间相同的情况。 dynamic：根据实际执行指标计算节省时间，忽略 timeSavedPerExecution。 可选值：fixed, dynamic settings.timeSavedPerExecution number 否 每次执行预计节省的时间，单位为分钟 settings.redactionPolicy string 否 控制是否遮蔽此工作流的执行数据。 可选项： none（默认）：不遮蔽，存储所有执行数据。 non-manual：仅遮蔽生产执行，即非手动触发的执行。 manual-only：仅遮蔽手动触发的执行。 all：遮蔽手动和生产模式的全部执行。 可选值：none, non-manual, manual-only, all settings.redactCallerExecutions boolean 否 控制将此工作流作为子工作流调用的工作流，是否也在相同通道上遮蔽其执行数据。调用方的执行记录会保留此工作流输出的副本。默认为 true，仅当此工作流的输出不敏感时才应关闭。此工作流从自身子工作流收到的遮蔽要求，始终会传递给调用方。 settings.availableInMCP boolean 否 控制能否通过模型上下文协议（MCP）访问此工作流。默认为 false。工作流必须处于激活状态，且至少包含一个激活的 Webhook 节点。 settings.customTelemetryTags array 否 展开字段 字段 类型 必填 说明 settings.customTelemetryTags.[]key string 是 settings.customTelemetryTags.[]value string 是 settings.credentialResolverId string 否 为此工作流解析凭据的凭据解析器 ID。这是通过凭据解析器配置管理的内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。
staticData	object	是	工作流在执行之间保留的数据
pinData	object	否	节点的固定示例数据，以节点名称为键
meta	object	是	工作流元数据，例如模板信息 展开字段 字段 类型 必填 说明 meta.onboardingId string 否 meta.templateId string 否 meta.instanceId string 否 meta.templateCredsSetupCompleted boolean 否
tags	array	否	展开字段 字段 类型 必填 说明 tags.[]id string 是 只读。 tags.[]name string 是 tags.[]createdAt string 是 只读。 tags.[]updatedAt string 是 只读。
shared	array	是	展开字段 字段 类型 必填 说明 shared.[]role string 是 shared.[]workflowId string 是 shared.[]projectId string 是 shared.[]project object 是 展开字段 字段 类型 必填 说明 shared.[]project.id string 是 只读。 shared.[]project.name string 是 shared.[]project.type string 是 可选值：personal, team 只读。 shared.[]project.icon object 是 项目图标；项目没有图标时为 null shared.[]project.description string 是 shared.[]project.customTelemetryTags array 是 shared.[]project.creatorId string 是 shared.[]project.createdAt string 是 只读。 shared.[]project.updatedAt string 是 只读。 shared.[]createdAt string 是 shared.[]updatedAt string 是
activeVersion	object	是	展开字段 字段 类型 必填 说明 activeVersion.versionId string 是 activeVersion.workflowId string 是 activeVersion.nodes array 是 组成工作流的节点 展开字段 字段 类型 必填 说明 activeVersion.nodes.[]id string 否 activeVersion.nodes.[]name string 否 activeVersion.nodes.[]webhookId string 否 activeVersion.nodes.[]disabled boolean 否 activeVersion.nodes.[]notesInFlow boolean 否 activeVersion.nodes.[]notes string 否 activeVersion.nodes.[]type string 否 activeVersion.nodes.[]typeVersion number 否 activeVersion.nodes.[]executeOnce boolean 否 activeVersion.nodes.[]alwaysOutputData boolean 否 activeVersion.nodes.[]retryOnFail boolean 否 activeVersion.nodes.[]maxTries number 否 activeVersion.nodes.[]waitBetweenTries number 否 activeVersion.nodes.[]continueOnFail boolean 否 请改用 onError activeVersion.nodes.[]onError string 否 activeVersion.nodes.[]position array 否 activeVersion.nodes.[]parameters object 否 activeVersion.nodes.[]credentials object 否 activeVersion.nodes.[]customTelemetryTags object 否 activeVersion.connections object 是 节点之间的连接，以源节点名称为键 activeVersion.nodeGroups array 是 在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 activeVersion.nodeGroups.[]id string 是 节点分组的唯一标识符 activeVersion.nodeGroups.[]name string 是 节点分组的显示名称 activeVersion.nodeGroups.[]description string 否 节点分组的可选纯文本说明 activeVersion.nodeGroups.[]nodeIds array 是 属于此分组的节点 ID activeVersion.authors string 是 activeVersion.name string 是 activeVersion.description string 是 activeVersion.autosaved boolean 是 activeVersion.createdAt string 是 activeVersion.updatedAt string 是 activeVersion.workflowPublishHistory array 是 展开字段 字段 类型 必填 说明 activeVersion.workflowPublishHistory.[]id number 是 activeVersion.workflowPublishHistory.[]workflowId string 是 activeVersion.workflowPublishHistory.[]versionId string 是 activeVersion.workflowPublishHistory.[]event string 是 可选值：activated, deactivated activeVersion.workflowPublishHistory.[]userId string 是 activeVersion.workflowPublishHistory.[]createdAt string 是

下载完整 OpenAPI 定义（JSON）

发布工作流

已弃用：请改用 POST /workflows/{id}/publish。发布工作流。在 n8n v1 中，此操作称为激活工作流。

POST/workflows/{workflowId}/activate

请求参数

参数	位置	类型	必填	说明
workflowId	path	string	是	工作流的 ID。

请求体

application/json

字段	类型	必填	说明
versionId	string	否	要激活或发布的具体版本 ID；不提供时使用最新版本。
name	string	否	激活时设置的可选工作流版本名称。
description	string	否	激活时设置的可选工作流版本说明。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
409	冲突，例如存在尚未结束的工作流审核而阻止发布（此时包含 reason 和 workflowReviewRequestId），或发生 webhook 路径冲突。
415	不支持的媒体类型。

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
name	string	是
description	string	是
active	boolean	是	已弃用。请改为检查 activeVersionId 是否非 null。
activeVersionId	string	是
createdAt	string	是
updatedAt	string	是
isArchived	boolean	是
versionId	string	是
versionCounter	number	是
sourceWorkflowId	string	是
triggerCount	number	是
nodes	array	是	组成工作流的节点 展开字段 字段 类型 必填 说明 nodes.[]id string 否 nodes.[]name string 否 nodes.[]webhookId string 否 nodes.[]disabled boolean 否 nodes.[]notesInFlow boolean 否 nodes.[]notes string 否 nodes.[]type string 否 nodes.[]typeVersion number 否 nodes.[]executeOnce boolean 否 nodes.[]alwaysOutputData boolean 否 nodes.[]retryOnFail boolean 否 nodes.[]maxTries number 否 nodes.[]waitBetweenTries number 否 nodes.[]continueOnFail boolean 否 请改用 onError nodes.[]onError string 否 nodes.[]position array 否 nodes.[]parameters object 否 nodes.[]credentials object 否 nodes.[]customTelemetryTags object 否 展开字段 字段 类型 必填 说明 nodes.[]customTelemetryTags.tag array 否
connections	object	是	节点之间的连接，以源节点名称为键
nodeGroups	array	是	在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 nodeGroups.[]id string 是 节点分组的唯一标识符 nodeGroups.[]name string 是 节点分组的显示名称 nodeGroups.[]description string 否 节点分组的可选纯文本说明 nodeGroups.[]nodeIds array 是 属于此分组的节点 ID
settings	object	是	工作流的执行和行为设置 展开字段 字段 类型 必填 说明 settings.saveExecutionProgress 联合类型 否 展开字段 结构 1 结构 2 settings.saveManualExecutions 联合类型 否 展开字段 结构 1 结构 2 settings.saveDataErrorExecution string 否 可选值：DEFAULT, all, none settings.saveDataSuccessExecution string 否 可选值：DEFAULT, all, none settings.executionTimeout number 否 settings.errorWorkflow string 否 包含错误触发器节点的工作流 ID。 settings.timezone string 否 settings.executionOrder string 否 settings.binaryMode string 否 控制如何从节点输入中解析二进制数据。这是内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 可选值：separate, combined settings.engineType string 否 运行此工作流的执行引擎。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 settings.callerPolicy string 否 控制哪些工作流可以通过 Execute Workflow 节点调用此工作流，默认为 workflowsFromSameOwner。 可选项： any：任何工作流均可调用此工作流，不作限制。 none：其他工作流均不能调用此工作流，即完全阻止。 workflowsFromSameOwner（默认）：仅属于同一项目的工作流可以调用此工作流。 workflowsFromAList：仅 callerIds 中列出的工作流可以调用此工作流。 可选值：any, none, workflowsFromAList, workflowsFromSameOwner settings.callerIds string 否 允许调用此工作流的工作流 ID 列表，以逗号分隔，仅在 workflowsFromAList 策略下使用 settings.timeSavedMode string 否 控制每次执行节省时间的计算方式。 可选项： fixed：使用 timeSavedPerExecution 的值，适用于每次执行节省时间相同的情况。 dynamic：根据实际执行指标计算节省时间，忽略 timeSavedPerExecution。 可选值：fixed, dynamic settings.timeSavedPerExecution number 否 每次执行预计节省的时间，单位为分钟 settings.redactionPolicy string 否 控制是否遮蔽此工作流的执行数据。 可选项： none（默认）：不遮蔽，存储所有执行数据。 non-manual：仅遮蔽生产执行，即非手动触发的执行。 manual-only：仅遮蔽手动触发的执行。 all：遮蔽手动和生产模式的全部执行。 可选值：none, non-manual, manual-only, all settings.redactCallerExecutions boolean 否 控制将此工作流作为子工作流调用的工作流，是否也在相同通道上遮蔽其执行数据。调用方的执行记录会保留此工作流输出的副本。默认为 true，仅当此工作流的输出不敏感时才应关闭。此工作流从自身子工作流收到的遮蔽要求，始终会传递给调用方。 settings.availableInMCP boolean 否 控制能否通过模型上下文协议（MCP）访问此工作流。默认为 false。工作流必须处于激活状态，且至少包含一个激活的 Webhook 节点。 settings.customTelemetryTags array 否 展开字段 字段 类型 必填 说明 settings.customTelemetryTags.[]key string 是 settings.customTelemetryTags.[]value string 是 settings.credentialResolverId string 否 为此工作流解析凭据的凭据解析器 ID。这是通过凭据解析器配置管理的内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。
staticData	object	是	工作流在执行之间保留的数据
pinData	object	否	节点的固定示例数据，以节点名称为键
meta	object	是	工作流元数据，例如模板信息 展开字段 字段 类型 必填 说明 meta.onboardingId string 否 meta.templateId string 否 meta.instanceId string 否 meta.templateCredsSetupCompleted boolean 否
tags	array	否	展开字段 字段 类型 必填 说明 tags.[]id string 是 只读。 tags.[]name string 是 tags.[]createdAt string 是 只读。 tags.[]updatedAt string 是 只读。
activeVersion	object	是	展开字段 字段 类型 必填 说明 activeVersion.versionId string 是 activeVersion.workflowId string 是 activeVersion.nodes array 是 组成工作流的节点 展开字段 字段 类型 必填 说明 activeVersion.nodes.[]id string 否 activeVersion.nodes.[]name string 否 activeVersion.nodes.[]webhookId string 否 activeVersion.nodes.[]disabled boolean 否 activeVersion.nodes.[]notesInFlow boolean 否 activeVersion.nodes.[]notes string 否 activeVersion.nodes.[]type string 否 activeVersion.nodes.[]typeVersion number 否 activeVersion.nodes.[]executeOnce boolean 否 activeVersion.nodes.[]alwaysOutputData boolean 否 activeVersion.nodes.[]retryOnFail boolean 否 activeVersion.nodes.[]maxTries number 否 activeVersion.nodes.[]waitBetweenTries number 否 activeVersion.nodes.[]continueOnFail boolean 否 请改用 onError activeVersion.nodes.[]onError string 否 activeVersion.nodes.[]position array 否 activeVersion.nodes.[]parameters object 否 activeVersion.nodes.[]credentials object 否 activeVersion.nodes.[]customTelemetryTags object 否 activeVersion.connections object 是 节点之间的连接，以源节点名称为键 activeVersion.nodeGroups array 是 在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 activeVersion.nodeGroups.[]id string 是 节点分组的唯一标识符 activeVersion.nodeGroups.[]name string 是 节点分组的显示名称 activeVersion.nodeGroups.[]description string 否 节点分组的可选纯文本说明 activeVersion.nodeGroups.[]nodeIds array 是 属于此分组的节点 ID activeVersion.authors string 是 activeVersion.name string 是 activeVersion.description string 是 activeVersion.autosaved boolean 是 activeVersion.createdAt string 是 activeVersion.updatedAt string 是 activeVersion.workflowPublishHistory array 是 展开字段 字段 类型 必填 说明 activeVersion.workflowPublishHistory.[]id number 是 activeVersion.workflowPublishHistory.[]workflowId string 是 activeVersion.workflowPublishHistory.[]versionId string 是 activeVersion.workflowPublishHistory.[]event string 是 可选值：activated, deactivated activeVersion.workflowPublishHistory.[]userId string 是 activeVersion.workflowPublishHistory.[]createdAt string 是

响应结构：409 · application/json

字段	类型	必填	说明
message	string	是
reason	string	否	可选值：review_pending, changes_requested
workflowReviewRequestId	string	否

下载完整 OpenAPI 定义（JSON）

停用工作流

已弃用：请改用 POST /workflows/{id}/unpublish。停用工作流。

POST/workflows/{workflowId}/deactivate

请求参数

参数	位置	类型	必填	说明
workflowId	path	string	是	工作流的 ID。

响应

状态码	说明
200	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
name	string	是
description	string	是
active	boolean	是	已弃用。请改为检查 activeVersionId 是否非 null。
activeVersionId	string	是
createdAt	string	是
updatedAt	string	是
isArchived	boolean	是
versionId	string	是
versionCounter	number	是
sourceWorkflowId	string	是
triggerCount	number	是
nodes	array	是	组成工作流的节点 展开字段 字段 类型 必填 说明 nodes.[]id string 否 nodes.[]name string 否 nodes.[]webhookId string 否 nodes.[]disabled boolean 否 nodes.[]notesInFlow boolean 否 nodes.[]notes string 否 nodes.[]type string 否 nodes.[]typeVersion number 否 nodes.[]executeOnce boolean 否 nodes.[]alwaysOutputData boolean 否 nodes.[]retryOnFail boolean 否 nodes.[]maxTries number 否 nodes.[]waitBetweenTries number 否 nodes.[]continueOnFail boolean 否 请改用 onError nodes.[]onError string 否 nodes.[]position array 否 nodes.[]parameters object 否 nodes.[]credentials object 否 nodes.[]customTelemetryTags object 否 展开字段 字段 类型 必填 说明 nodes.[]customTelemetryTags.tag array 否
connections	object	是	节点之间的连接，以源节点名称为键
nodeGroups	array	是	在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 nodeGroups.[]id string 是 节点分组的唯一标识符 nodeGroups.[]name string 是 节点分组的显示名称 nodeGroups.[]description string 否 节点分组的可选纯文本说明 nodeGroups.[]nodeIds array 是 属于此分组的节点 ID
settings	object	是	工作流的执行和行为设置 展开字段 字段 类型 必填 说明 settings.saveExecutionProgress 联合类型 否 展开字段 结构 1 结构 2 settings.saveManualExecutions 联合类型 否 展开字段 结构 1 结构 2 settings.saveDataErrorExecution string 否 可选值：DEFAULT, all, none settings.saveDataSuccessExecution string 否 可选值：DEFAULT, all, none settings.executionTimeout number 否 settings.errorWorkflow string 否 包含错误触发器节点的工作流 ID。 settings.timezone string 否 settings.executionOrder string 否 settings.binaryMode string 否 控制如何从节点输入中解析二进制数据。这是内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 可选值：separate, combined settings.engineType string 否 运行此工作流的执行引擎。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 settings.callerPolicy string 否 控制哪些工作流可以通过 Execute Workflow 节点调用此工作流，默认为 workflowsFromSameOwner。 可选项： any：任何工作流均可调用此工作流，不作限制。 none：其他工作流均不能调用此工作流，即完全阻止。 workflowsFromSameOwner（默认）：仅属于同一项目的工作流可以调用此工作流。 workflowsFromAList：仅 callerIds 中列出的工作流可以调用此工作流。 可选值：any, none, workflowsFromAList, workflowsFromSameOwner settings.callerIds string 否 允许调用此工作流的工作流 ID 列表，以逗号分隔，仅在 workflowsFromAList 策略下使用 settings.timeSavedMode string 否 控制每次执行节省时间的计算方式。 可选项： fixed：使用 timeSavedPerExecution 的值，适用于每次执行节省时间相同的情况。 dynamic：根据实际执行指标计算节省时间，忽略 timeSavedPerExecution。 可选值：fixed, dynamic settings.timeSavedPerExecution number 否 每次执行预计节省的时间，单位为分钟 settings.redactionPolicy string 否 控制是否遮蔽此工作流的执行数据。 可选项： none（默认）：不遮蔽，存储所有执行数据。 non-manual：仅遮蔽生产执行，即非手动触发的执行。 manual-only：仅遮蔽手动触发的执行。 all：遮蔽手动和生产模式的全部执行。 可选值：none, non-manual, manual-only, all settings.redactCallerExecutions boolean 否 控制将此工作流作为子工作流调用的工作流，是否也在相同通道上遮蔽其执行数据。调用方的执行记录会保留此工作流输出的副本。默认为 true，仅当此工作流的输出不敏感时才应关闭。此工作流从自身子工作流收到的遮蔽要求，始终会传递给调用方。 settings.availableInMCP boolean 否 控制能否通过模型上下文协议（MCP）访问此工作流。默认为 false。工作流必须处于激活状态，且至少包含一个激活的 Webhook 节点。 settings.customTelemetryTags array 否 展开字段 字段 类型 必填 说明 settings.customTelemetryTags.[]key string 是 settings.customTelemetryTags.[]value string 是 settings.credentialResolverId string 否 为此工作流解析凭据的凭据解析器 ID。这是通过凭据解析器配置管理的内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。
staticData	object	是	工作流在执行之间保留的数据
pinData	object	否	节点的固定示例数据，以节点名称为键
meta	object	是	工作流元数据，例如模板信息 展开字段 字段 类型 必填 说明 meta.onboardingId string 否 meta.templateId string 否 meta.instanceId string 否 meta.templateCredsSetupCompleted boolean 否
tags	array	否	展开字段 字段 类型 必填 说明 tags.[]id string 是 只读。 tags.[]name string 是 tags.[]createdAt string 是 只读。 tags.[]updatedAt string 是 只读。
shared	array	是	展开字段 字段 类型 必填 说明 shared.[]role string 是 shared.[]workflowId string 是 shared.[]projectId string 是 shared.[]project object 是 展开字段 字段 类型 必填 说明 shared.[]project.id string 是 只读。 shared.[]project.name string 是 shared.[]project.type string 是 可选值：personal, team 只读。 shared.[]project.icon object 是 项目图标；项目没有图标时为 null shared.[]project.description string 是 shared.[]project.customTelemetryTags array 是 shared.[]project.creatorId string 是 shared.[]project.createdAt string 是 只读。 shared.[]project.updatedAt string 是 只读。 shared.[]createdAt string 是 shared.[]updatedAt string 是
activeVersion	object	是	展开字段 字段 类型 必填 说明 activeVersion.versionId string 是 activeVersion.workflowId string 是 activeVersion.nodes array 是 组成工作流的节点 展开字段 字段 类型 必填 说明 activeVersion.nodes.[]id string 否 activeVersion.nodes.[]name string 否 activeVersion.nodes.[]webhookId string 否 activeVersion.nodes.[]disabled boolean 否 activeVersion.nodes.[]notesInFlow boolean 否 activeVersion.nodes.[]notes string 否 activeVersion.nodes.[]type string 否 activeVersion.nodes.[]typeVersion number 否 activeVersion.nodes.[]executeOnce boolean 否 activeVersion.nodes.[]alwaysOutputData boolean 否 activeVersion.nodes.[]retryOnFail boolean 否 activeVersion.nodes.[]maxTries number 否 activeVersion.nodes.[]waitBetweenTries number 否 activeVersion.nodes.[]continueOnFail boolean 否 请改用 onError activeVersion.nodes.[]onError string 否 activeVersion.nodes.[]position array 否 activeVersion.nodes.[]parameters object 否 activeVersion.nodes.[]credentials object 否 activeVersion.nodes.[]customTelemetryTags object 否 activeVersion.connections object 是 节点之间的连接，以源节点名称为键 activeVersion.nodeGroups array 是 在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 activeVersion.nodeGroups.[]id string 是 节点分组的唯一标识符 activeVersion.nodeGroups.[]name string 是 节点分组的显示名称 activeVersion.nodeGroups.[]description string 否 节点分组的可选纯文本说明 activeVersion.nodeGroups.[]nodeIds array 是 属于此分组的节点 ID activeVersion.authors string 是 activeVersion.name string 是 activeVersion.description string 是 activeVersion.autosaved boolean 是 activeVersion.createdAt string 是 activeVersion.updatedAt string 是 activeVersion.workflowPublishHistory array 是 展开字段 字段 类型 必填 说明 activeVersion.workflowPublishHistory.[]id number 是 activeVersion.workflowPublishHistory.[]workflowId string 是 activeVersion.workflowPublishHistory.[]versionId string 是 activeVersion.workflowPublishHistory.[]event string 是 可选值：activated, deactivated activeVersion.workflowPublishHistory.[]userId string 是 activeVersion.workflowPublishHistory.[]createdAt string 是

下载完整 OpenAPI 定义（JSON）

获取工作流版本历史

返回工作流版本的分页列表，包含版本 ID 和元数据。

GET/workflows/{workflowId}/history

请求参数

参数	位置	类型	必填	说明
limit	query	number	否	最多返回的数据项数量。 默认值：100
cursor	query	string	否	将 cursor 参数设为上次请求响应中的 nextCursor 属性，以进行分页。使用默认值时，获取集合的第一页。更多信息，请参阅分页说明。
workflowId	path	string	是	工作流的 ID。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]versionId string 是 data.[]workflowId string 是 data.[]authors string 是 data.[]name string 是 data.[]description string 是 data.[]createdAt string 是 data.[]updatedAt string 是
nextCursor	string	是

下载完整 OpenAPI 定义（JSON）

获取工作流版本

从版本历史中获取工作流的单个版本。

GET/workflows/{workflowId}/versions/{workflowVersionId}

请求参数

参数	位置	类型	必填	说明
workflowId	path	string	是	工作流的 ID。
workflowVersionId	path	string	是	工作流版本的 ID。

响应

状态码	说明
200	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
versionId	string	是
workflowId	string	是
nodes	array	是	组成工作流的节点 展开字段 字段 类型 必填 说明 nodes.[]id string 否 nodes.[]name string 否 nodes.[]webhookId string 否 nodes.[]disabled boolean 否 nodes.[]notesInFlow boolean 否 nodes.[]notes string 否 nodes.[]type string 否 nodes.[]typeVersion number 否 nodes.[]executeOnce boolean 否 nodes.[]alwaysOutputData boolean 否 nodes.[]retryOnFail boolean 否 nodes.[]maxTries number 否 nodes.[]waitBetweenTries number 否 nodes.[]continueOnFail boolean 否 请改用 onError nodes.[]onError string 否 nodes.[]position array 否 nodes.[]parameters object 否 nodes.[]credentials object 否 nodes.[]customTelemetryTags object 否 展开字段 字段 类型 必填 说明 nodes.[]customTelemetryTags.tag array 否
connections	object	是	节点之间的连接，以源节点名称为键
nodeGroups	array	是	在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 nodeGroups.[]id string 是 节点分组的唯一标识符 nodeGroups.[]name string 是 节点分组的显示名称 nodeGroups.[]description string 否 节点分组的可选纯文本说明 nodeGroups.[]nodeIds array 是 属于此分组的节点 ID
authors	string	是
name	string	是
description	string	是
createdAt	string	是
updatedAt	string	是

下载完整 OpenAPI 定义（JSON）

获取工作流标签

获取工作流标签。

GET/workflows/{workflowId}/tags

请求参数

参数	位置	类型	必填	说明
workflowId	path	string	是	工作流的 ID。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
[]id	string	是	只读。
[]name	string	是
[]createdAt	string	是	只读。
[]updatedAt	string	是	只读。

下载完整 OpenAPI 定义（JSON）

更新工作流标签

更新工作流标签。

PUT/workflows/{workflowId}/tags

请求参数

参数	位置	类型	必填	说明
workflowId	path	string	是	工作流的 ID。

请求体

application/json

字段	类型	必填	说明
[]id	string	是

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
415	不支持的媒体类型。

响应结构：200 · application/json

字段	类型	必填	说明
[]id	string	是	只读。
[]name	string	是
[]createdAt	string	是	只读。
[]updatedAt	string	是	只读。

下载完整 OpenAPI 定义（JSON）

列出工作流依赖项

列出工作流使用的凭据、数据表、子工作流和错误工作流，以及使用此工作流的工作流和智能体。

GET/workflows/{workflowId}/dependencies

请求参数

参数	位置	类型	必填	说明
limit	query	number	否	最多返回的数据项数量。 默认值：100
cursor	query	string	否	将 cursor 参数设为上次请求响应中的 nextCursor 属性，以进行分页。使用默认值时，获取集合的第一页。更多信息，请参阅分页说明。
workflowId	path	string	是	工作流的 ID。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]type string 是 与所请求资源的关系。credential、dataTable、subWorkflow、errorWorkflow：所请求的工作流使用此依赖项。parentWorkflow：此工作流使用所请求的资源。errorWorkflowParent：此工作流将所请求的工作流用作错误工作流。agent：此智能体使用所请求的资源。 可选值：agent, credential, dataTable, errorWorkflow, errorWorkflowParent, parentWorkflow, subWorkflow data.[]id string 是 data.[]name string 是 data.[]projectId string 否 依赖项所属项目（已知时返回）。
nextCursor	string	是
inaccessibleCount	integer	是	你无权访问的依赖项数量；这些依赖项不会列出。

下载完整 OpenAPI 定义（JSON）

获取工作流的特定版本

已弃用：请改用 GET /workflows/{workflowId}/versions/{workflowVersionId}。从工作流历史中获取工作流的特定版本。

GET/workflows/{workflowId}/{workflowVersionId}

请求参数

参数	位置	类型	必填	说明
workflowId	path	string	是	工作流的 ID。
workflowVersionId	path	string	是	工作流版本的 ID。

响应

状态码	说明
200	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
versionId	string	是
workflowId	string	是
nodes	array	是	组成工作流的节点 展开字段 字段 类型 必填 说明 nodes.[]id string 否 nodes.[]name string 否 nodes.[]webhookId string 否 nodes.[]disabled boolean 否 nodes.[]notesInFlow boolean 否 nodes.[]notes string 否 nodes.[]type string 否 nodes.[]typeVersion number 否 nodes.[]executeOnce boolean 否 nodes.[]alwaysOutputData boolean 否 nodes.[]retryOnFail boolean 否 nodes.[]maxTries number 否 nodes.[]waitBetweenTries number 否 nodes.[]continueOnFail boolean 否 请改用 onError nodes.[]onError string 否 nodes.[]position array 否 nodes.[]parameters object 否 nodes.[]credentials object 否 nodes.[]customTelemetryTags object 否 展开字段 字段 类型 必填 说明 nodes.[]customTelemetryTags.tag array 否
connections	object	是	节点之间的连接，以源节点名称为键
nodeGroups	array	否	在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 nodeGroups.[]id string 是 节点分组的唯一标识符 nodeGroups.[]name string 是 节点分组的显示名称 nodeGroups.[]description string 否 节点分组的可选纯文本说明 nodeGroups.[]nodeIds array 是 属于此分组的节点 ID
authors	string	是
name	string	否
description	string	否
createdAt	string	否
updatedAt	string	否

下载完整 OpenAPI 定义（JSON）