logo
开发者文档
搜索
导入创建 Workflow

导入创建 Workflow

支持上传 .flow 文件并导入为组织下的 Workflow。

可以通过该接口,上传 .flow 文件并导入为组织下的 Workflow。导入成功后会自动创建 API Key,并默认关闭版本管理。

请求方式

POST

调用地址

https://api.${endpoint}/v1/org/workflow/import

调用验证

使用账号级 DevKey / DevSecret 的 Basic 鉴权,并要求调用账号具备组织 Workflow 创建权限。

请求

请求示例

curl -X POST 'https://api.${endpoint}/v1/org/workflow/import' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -F 'file=@/path/to/workflow.flow' \ -F 'org_id=p-xxxx' \ -F 'custom_name=Imported Workflow' \ -F 'enable_api=true'
                      
                      curl -X POST 'https://api.${endpoint}/v1/org/workflow/import' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -F 'file=@/path/to/workflow.flow' \
  -F 'org_id=p-xxxx' \
  -F 'custom_name=Imported Workflow' \
  -F 'enable_api=true'

                    
此代码块在浮窗中显示

请求头

字段 类型 说明
Authorization Basic ${BASIC_TOKEN} 使用 DevKey:DevSecret Base64 后的 Basic Token。
Content-Type multipart/form-data 文件上传表单。

请求参数(Form Data)

参数 类型 说明 required
file File .flow 文件。 true
org_id String 组织 ID。 true
custom_name String 导入后的自定义 Workflow 名称。 false
enable_api Boolean 是否尝试开启 API,默认 true。套餐不支持 API 时导入仍成功,返回 api_enabled=false false

响应

响应示例

{ "code": 0, "message": "OK", "data": { "workflow_id": "workflow-xxxx", "name": "Imported Workflow", "api_key": "app-xxxx", "api_enabled": true, "version_manage_enabled": false, "warning": null } }
                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "workflow_id": "workflow-xxxx",
    "name": "Imported Workflow",
    "api_key": "app-xxxx",
    "api_enabled": true,
    "version_manage_enabled": false,
    "warning": null
  }
}

                    
此代码块在浮窗中显示

成功响应

字段 类型 说明
workflow_id String 导入后的 Workflow ID。
name String Workflow 名称。
api_key String 自动创建的 API Key,仅返回一次。
api_enabled Boolean 是否已开启 API。
version_manage_enabled Boolean 是否允许版本管理;导入默认关闭。
warning String 导入警告。

失败响应

字段 类型 说明
code Integer 错误码。
message String 错误详情。

状态码

状态码 说明
200 成功
400 参数错误
401 未授权
403 权限不足
429 请求过于频繁
500 服务器错误