导入 Workflow 版本
导入 Workflow 版本
支持上传 .flow 文件替换当前 Workflow 配置,并保存为新版本。
该接口使用目标 Workflow 自身的 API Key 鉴权,只允许开启版本管理权限的 Workflow 调用。
请求方式
POST
调用地址
https://api.${endpoint}/v1/workflow/version/import
调用验证
详情参见 API 概述的鉴权方式说明。请使用目标 Workflow 的 API Key 作为 token。
请求
请求示例
curl -X POST 'https://api.${endpoint}/v1/workflow/version/import' \
-H 'Authorization: Bearer ${token}' \
-F 'file=@/path/to/workflow.flow' \
-F 'versionDesc=Update workflow nodes'
curl -X POST 'https://api.${endpoint}/v1/workflow/version/import' \
-H 'Authorization: Bearer ${token}' \
-F 'file=@/path/to/workflow.flow' \
-F 'versionDesc=Update workflow nodes'
此代码块在浮窗中显示
请求头
| 字段 | 类型 | 说明 |
|---|---|---|
| Authorization | Bearer ${token} | 使用目标 Workflow 的 API Key 进行调用验证。 |
| Content-Type | multipart/form-data | 文件上传表单。 |
请求参数(Form Data)
| 参数 | 类型 | 说明 | required |
|---|---|---|---|
| file | File | .flow 文件。 |
true |
| versionDesc | String | 版本说明。 | false |
响应
响应体
{
"code": 0,
"message": "OK",
"data": {
"botId": "workflow-xxxx",
"botType": "FLOW_AGENT",
"version": "v2",
"warning": null
}
}
{
"code": 0,
"message": "OK",
"data": {
"botId": "workflow-xxxx",
"botType": "FLOW_AGENT",
"version": "v2",
"warning": null
}
}
此代码块在浮窗中显示
成功响应
| 字段 | 类型 | 说明 |
|---|---|---|
| botId | String | 目标 Workflow ID。 |
| botType | String | Bot 类型。 |
| version | String | 保存的版本号,同时成为当前版本。 |
| warning | String | 导入警告信息,无则为 null。 |
失败响应
| 字段 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码。 |
| message | string | 错误信息。 |
状态码
| 状态码 | 说明 |
|---|---|
| 200 | 成功 |
| 400 | 参数错误 |
| 401 | 未授权 |
| 403 | 权限不足或 API Key 未开启版本管理权限 |
| 429 | 请求过于频繁 |
| 500 | 服务器错误 |
