完整文档索引见 llms.txt。在页面 URL 后附加
.md即可获取 Markdown 版本;本页的 Markdown 版本可在此获取。
n8n 包
Beta 阶段,即使不提升主版本号,也可能出现破坏性变更。
Beta:将 n8n 包导入项目
**Beta**——即使不提升主版本号,也可能出现破坏性变更。
将 gzip 压缩的 tar 包(`.n8np`)导入目标项目。使用 multipart 字段 `package` 发送归档。可选的目标路由使用表单字段 `projectId` 和 `folderId`,省略或发送空值时使用默认值。所有可选模式/策略字段(凭据、工作流、项目、文件夹、数据表、变量和标签)在省略时均采用默认值;唯一不固定的默认值是 `folderConflictPolicy`,项目包中它遵循 `projectConflictPolicy`。必填的 `workflowConflictPolicy` 控制包内工作流按源 id 匹配到目标项目中的现有工作流时如何处理。最大上传大小为 `N8N_ENDPOINTS_PAYLOAD_SIZE_MAX` MB,默认 16。
包必须在 `manifest.json` 中声明清单,并包含清单引用的每个文件。
任何工作流写入之前,都会先解析凭据引用。
/n8n-packages/import请求参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
Idempotency-Key | header | string | 否 | 此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求,会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试,会返回 409。 |
请求体
multipart/form-data
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
package | string | 是 | gzip 压缩的 tar 包( |
projectId | string | 否 | 目标项目 id。省略或发送空值时,导入调用方的个人项目。 |
folderId | string | 否 | 目标项目中的可选文件夹。省略或发送空值时,使用项目根目录。 |
credentialMatchingMode | string | 否 | 如何在目标实例上匹配 可选值: 默认值: |
credentialMissingMode | string | 否 | 无法解析凭据引用时如何处理。 可选值: 默认值: |
credentialConflictPolicy | string | 否 | 凭据引用匹配到现有凭据、但包内值与现有值不同时如何处理。 可选值: 默认值: |
bindings | string | 否 | 可选的显式源→目标 id 绑定 JSON 对象,以实体类型为键。目前仅支持 默认值: |
workflowConflictPolicy | string | 是 |
可选值: |
workflowPublishingPolicy | string | 否 | 控制内容写入后是否发布导入工作流。 可选值: 默认值: |
workflowIdPolicy | string | 否 | 控制新建工作流获得的 id。 可选值: 默认值: |
missingNodeTypeMode | string | 否 | 包内工作流使用了实例未安装的节点类型或节点类型版本时如何处理。 可选值: 默认值: |
projectConflictPolicy | string | 否 | 包定义的项目已在实例中存在(按 id 匹配)时如何处理,以及在未被 可选值: 默认值: |
folderConflictPolicy | string | 否 | 包内文件夹已存在于目标项目相同位置时如何处理。默认遵循 可选值: |
overwriteDeletionPolicy | string | 否 |
可选值: 默认值: |
dataTableMatchingMode | string | 否 | 如何将包内工作流引用的数据表与目标项目匹配。 可选值: 默认值: |
dataTableMissingMode | string | 否 | 引用 的数据表在目标项目中没有匹配项时如何处理。 可选值: 默认值: |
dataTableSchemaConflictPolicy | string | 否 | 比较匹配数据表架构时的严格程度。
可选值: 默认值: |
variableMissingMode | string | 否 | 包内工作流引用的变量在目标项目和全局作用域均不存在时如何处理,查找顺序为先项目、后全局。 可选值: 默认值: |
variableConflictPolicy | string | 否 | 引用变量已在目标项目或全局作用域解析到,但包内携带了不同值时如何处理。 可选值: 默认值: |
variableParentPolicy | string | 否 | 工作流包或文件夹包中, 可选值: |
tagMissingMode | string | 否 | 包内工作流引用的标签在目标实例上没有相同 id 标签时如何处理。标签按源 id 匹配,绝不按名称匹配。 可选值: 默认值: |
tagConflictPolicy | string | 否 | 引用标签在目标实例上发生冲突时如何处理,包括相同 id 的目标标签名称不同(重命名漂移),或标签名称已被其他标签占用(名称冲突)。 可选值: 默认值: |
响应
| 状态码 | 说明 |
|---|---|
200 | 操作成功。 |
400 | 请求无效,或提供的数据格式错误。 |
401 | 未授权 |
403 | 禁止访问 |
404 | 未找到指定资源。 |
409 | 至少存在一项冲突而阻止导入,例如工作流源 id 冲突、文件夹冲突、标签冲突(重命名漂移或名称冲突)、数据表冲突(id 属于其他项目,或名称被项目内其他表占用)、变量包内值与解析到的目标值不同,或选定目标同时被指定删除。 |
413 | 内容过大。 |
415 | 不支持的媒体类型。 |
422 | 仅因非冲突问题而阻止导入,例如未解析的凭据或变量、实例未安装的节点类型、调用方无权进行的删除,或创建变量占位项会超过实例变量配额。 |
500 | 服务器内部错误。 |
响应结构:200 · application/json
| 字段 | 类型 | 必填 | 说明 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
package | object | 是 | 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
workflows | array | 是 | 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
removedWorkflows | array | 是 | 此次导入期间从目标移除的工作流。 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
removedFolders | array | 是 | 包未定义、且在对齐处理后变为空的文件夹,由 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
folders | array | 是 | 在目标项目中创建或跳过的文件夹结构。 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
projects | array | 是 | 创建的项目结构,或匹配后更新或保留原样的项目结构,参见 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bindings | object | 是 | 导入产生的源 id → 目标 id 映射,每种实体类型一个映射。每个值都将实体在包中的 id 映射到目标实例上的 id。 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
credentials | object | 是 | 按解析结果分组的源凭据 id:匹配现有凭据、创建空白占位凭据、创建带初始数据的凭据、创建不完整凭据,或匹配到此次导入已更新的凭据。完整的源→目标 id 映射见 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dataTables | object | 是 | 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
variables | object | 是 | 包的变量需求解析结果。仅返回名称,响应绝不包含值。对于项目包,这些数组是在包级别汇总各目标结果得到的并集,可能重叠,例如某名称在一个项目中创建时带有值,在另一个项目中创建为空白占位变量;存在外部并发写入时,只能尽力准确分类。 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | object | 是 | 导入工作流引用的标签的解析结果,按源 id 匹配,仅包含标签名称。 展开字段
|
响应结构:409 · application/json
| 字段 | 类型 | 必填 | 说明 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
message | string | 是 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
issues | array | 是 | 展开字段结构 1
结构 2
结构 3
结构 4
结构 5
结构 6
结构 7
结构 8
结构 9
结构 10
结构 11
结构 12
结构 13
结构 14
结构 15
结构 16
结构 17
结构 18
结构 19
结构 20
结构 21
结构 22
结构 23
结构 24
结构 25
|
响应结构:422 · application/json
| 字段 | 类型 | 必填 | 说明 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
message | string | 是 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
issues | array | 是 | 展开字段结构 1
结构 2
结构 3
结构 4
结构 5
结构 6
结构 7
结构 8
结构 9
结构 10
结构 11
结构 12
结构 13
结构 14
结构 15
结构 16
结构 17
结构 18
结构 19
结构 20
结构 21
结构 22
结构 23
结构 24
结构 25
|
Beta:从 n8n 包导入所选工作流 子集
**Beta**——即使不提升主版本号,也可能出现破坏性变更。
从 gzip 压缩的 tar 包(`.n8np`)的一个源项目中导入所选工作流子集,而非整个包。使用 multipart 字段 `package` 发送归档。导入采用**增量选择**方式(cherry-pick),绝不移除选择中省略的工作流:仅创建或更新 `selectedWorkflowIds` 指定的工作流,仅删除 `deletedWorkflowIds` 指定的目标工作流。
`selectedProjectId` 指定此次选择所属的单个源项目,使用它在包中的 id。所选工作流写入实例上 id 与源项目相同的项目;项目不存在时创建,没有单独的目标项目字段。`selectedWorkflowIds` 是该项目内的源 id,属于其他项目的 id 会被丢弃。`deletedWorkflowIds` 是同一项目中的目标 id;不存在的 id 视为可接受的空操作,删除需要 `workflow:delete` 作用域。删除 id 不得与任何所选工作流的目标 id 相同,即使 `workflowConflictPolicy=skip` 也不允许;重叠会在任何写入前返回 409。
必须使用项目包,工作流包会以 400 拒绝。选择导入的文件夹、标签和项目冲突策略固定,不接受配置;仅 `workflowConflictPolicy`、`workflowIdPolicy` 和 `overwriteDeletionPolicy` 可配置。最大上传大小为 `N8N_ENDPOINTS_PAYLOAD_SIZE_MAX` MB,默认 16。调用方通过 `workflow:import` 作用域获得授权。
/n8n-packages/import-selection请求参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
Idempotency-Key | header | string | 否 | 此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求,会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试,会返回 409。 |
请求体
multipart/form-data
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
package | string | 是 | gzip 压缩的 tar 包( |
selectedProjectId | string | 是 | 此次选择所属的单个源项目 id,使用它在包中的值。 |
selectedWorkflowIds | string | 是 | 以 JSON 编码的源工作流 id 数组,指定从 |
deletedWorkflowIds | string | 否 | 可选的 JSON 编码目标工作流 id 数组,指定从相应项目移除的工作流,例如 |
workflowConflictPolicy | string | 否 | 所选工作流按源 id 匹配到目标项目现有工作流时如何处理。 可选值: 默认值: |
workflowIdPolicy | string | 否 | 控制新建工作流获得的 id。 可选值: 默认值: |
overwriteDeletionPolicy | string | 否 | 如何移除 可选值: 默认值: |
响应
| 状态码 | 说明 |
|---|---|
200 | 操作成功。 |
400 | 请求无效,或提供的数据格式错误。 |
401 | 未授权 |
403 | 禁止访问 |
404 | 未找到指定资源。 |
409 | 至少存在一项冲突而阻止导入,例如 |
413 | 内容过大。 |
415 | 不支持的媒体类型。 |
422 | 仅因非冲突问题而阻止导入,例如调用方无权进行的删除( |
500 | 服务器内部错误。 |
响应结构:200 · application/json
| 字段 | 类型 | 必填 | 说明 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
package | object | 是 | 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
workflows | array | 是 | 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
removedWorkflows | array | 是 | 此次导入期间从目标移除的工作流。 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
removedFolders | array | 是 | 包未定义、且在对齐处理后变为空的文件夹,由 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
folders | array | 是 | 在目标项目中创建或跳过的文件夹结构。 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
projects | array | 是 | 创建的项目结构,或匹配后更新或保留原样的项目结构,参见 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bindings | object | 是 | 导入产生的源 id → 目标 id 映射,每种实体类型一个映射。每个值都将实体在包中的 id 映射到目标实例上的 id。 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
credentials | object | 是 | 按解析结果分组的源凭据 id:匹配现有凭据、创建空白占位凭据、创建带初始数据的凭据、创建不完整凭据,或匹配到此次导入已更新的凭据。完整的源→目标 id 映射见 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dataTables | object | 是 | 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
variables | object | 是 | 包的变量需求解析结果。仅返回名称,响应绝不包含值。对于项目包,这些数组是在包级别汇总各目标结果得到的并集,可能重叠,例如某名称在一个项目中创建时带有值,在另一个项目中创建为空白占位变量;存在外部并发写入时,只能尽力准确分类。 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | object | 是 | 导入工作流引用的标签的解析结果,按源 id 匹配,仅包含标签名称。 展开字段
|
响应结构:409 · application/json
| 字段 | 类型 | 必填 | 说明 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
message | string | 是 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
issues | array | 是 | 展开字段结构 1
结构 2
结构 3
结构 4
结构 5
结构 6
结构 7
结构 8
结构 9
结构 10
结构 11
结构 12
结构 13
结构 14
结构 15
结构 16
结构 17
结构 18
结构 19
结构 20
结构 21
结构 22
结构 23
结构 24
结构 25
|
响应结构:422 · application/json
| 字段 | 类型 | 必填 | 说明 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
message | string | 是 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
issues | array | 是 | 展开字段结构 1
结构 2
结构 3
结构 4
结构 5
结构 6
结构 7
结构 8
结构 9
结构 10
结构 11
结构 12
结构 13
结构 14
结构 15
结构 16
结构 17
结构 18
结构 19
结构 20
结构 21
结构 22
结构 23
结构 24
结构 25
|
Beta:将智能体、工作流、文件夹或项目导出为 n8n 包
**Beta**——即使不提升主版本号,也可能出现破坏性变更。
将智能体、工作流、文件夹或整个项目导出为经 gzip 压缩的 tar
归档(.n8np)。提供 `agentIds`/`workflowIds`/`folderIds`,或 `projectIds`。
两组不可混用。每个导出的文件夹都包括其嵌套
文件夹。启用智能体模块时,整个项目的导出会包含其智能体。
显式选择智能体需要启用智能体模块。空项目仅导出
项目元数据。`versionPolicy` 选择智能体和
工作流的版本,默认为 `latest`。`dependencyPolicy` 应用于这两类实体,
所需定义未包含在包中时,默认为 `fail`。
响应以 `application/gzip` 流式传输,并包含 `Content-Disposition`
附件响应头。需要获得 n8n Packages 功能许可。
API 密钥作用域:显式选择智能体需要 `agent:export`。
显式选择工作流或文件夹需要 `workflow:export`。
导出整个项目只需 `project:export`,其中包括项目的
智能体和工作流。包含的依赖项无需额外 API 密钥作用域。
调用方的项目权限适用于所有包含的实体。当
`includeVariableValues` 为 true(默认),且导出实体引用变量时,
还需要 `variable:list`;未引用变量的导出
无需此作用域。
智能体定义包含引用的技能、自定义工具和计划。
不包含知识库文件和运行时数据。智能体包导入
仍不可用。
/n8n-packages/export请求参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
Idempotency-Key | header | string | 否 | 此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求,会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试,会返回 409。 |
请求体
application/json
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
agentIds | array | 否 | 要包含的智能体 ID,需要启用智能体模块。 |
workflowIds | array | 否 | 导出包中要包含的工作流 ID。 |
folderIds | array | 否 | 导出包中要包含的文件夹 ID,每个文件夹连同其嵌套文件夹一起导出。 |
projectIds | array | 否 | 导出包中要包含的项目 ID,启用智能体模块时包括其智能体。 |
includeVariableValues | boolean | 否 | 是否将导出实体引用的变量值包含在包中。为 默认值: |
includeTags | boolean | 否 | 是否将导出工作流关联的标签包含在包中。为 默认值: |
dependencyPolicy | string | 否 | 处理所选包内容之外的工作流和智能体依赖项的策略,包括静态工作流引用和已禁用的智能体引用。 可选值: 默认值: |
versionPolicy | string | 否 | 包携带的各工作流和智能体版本。 可选值: 默认值: |
credentialExportPolicy | string | 否 | 是否将凭据数据中的表达式值包含在包中。 可选值: 默认值: |
includeArchivedWorkflows | boolean | 否 | 文件夹和项目导出是否包含已归档工作流。为 默认值: |
响应
| 状态码 | 说明 |
|---|---|
200 | 包含导出包内容的 gzip 压缩 tar 归档。 |
400 | 请求无效,或提供的数据格式错误。 |
401 | 未授权 |
403 | 禁止访问 |
404 | 未找到指定资源。 |
409 | 冲突 |
415 | 不支持的媒体类型。 |
422 | 无法处理的实体 |