创建工作流模板¶

在当前工作区创建自定义工作流模板。创建内置模板需要管理员权限。

POST https://moi.matrixorigin.cn/newmoi/workflow-templates

调用前准备¶

准备具有目标工作区访问权限的个人访问令牌、目标工作区 ID和模板的工作流 DSL。

请求体¶

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和示例中的模板内容替换为实际值。

输入示例

curl -X POST "https://moi.matrixorigin.cn/newmoi/workflow-templates" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "daily-import-template",
    "description": "每日导入工作流模板",
    "dsl_yaml": "workflow:\\n  name: daily-import\\n  root: main\\nroot:\\n  chain: []\\n",
    "runtime_fields": "{\"fields\":[]}",
    "is_builtin": false
  }'

参数说明

参数	类型	是否必填	说明
`name`	string	是	模板名称。自定义模板在当前工作区、当前语言下不能重名。
`description`	string	否	模板说明。
`dsl_yaml`	string	是	工作流 DSL 的 YAML 文本。
`runtime_fields`	string	否	运行时字段定义的 JSON 文本；提供时必须是合法 JSON。
`is_builtin`	boolean	否	是否创建为内置模板；省略时为 `false`。设为 `true` 需要管理员权限。
`template_key`	string	条件必填	内置模板标识。创建内置模板时必填；创建自定义模板时忽略。

成功响应¶

成功时返回 200 和新建的模板。记录 data.id，用于查看、更新或删除模板。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": 12,
    "workspace_id": "ws-001",
    "name": "daily-import-template",
    "description": "每日导入工作流模板",
    "language": "zh-CN",
    "dsl_yaml": "workflow: {}",
    "runtime_fields": "{\"fields\":[]}",
    "is_builtin": false,
    "created_at": "2026-08-18T10:00:00Z",
    "updated_at": "2026-08-18T10:00:00Z"
  }
}

字段说明

通用字段

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	object	响应数据。

模板信息

下面表格展开响应示例中的 data 对象；每一行是该对象的一个字段。

字段	类型	说明
`id`	integer	模板 ID。
`workspace_id`	string	所属工作区 ID；内置模板为空字符串。
`created_by`	string	创建者标识。
`updated_by`	string	最后更新者标识。
`template_key`	string	内置模板标识；自定义模板为空字符串。
`name`	string	模板名称。
`description`	string	模板说明。
`language`	string	模板语言。
`dsl_yaml`	string	已保存的工作流 DSL YAML。
`runtime_fields`	string	已保存的运行时字段 JSON 文本；未配置时为空字符串。
`is_builtin`	boolean	是否为内置模板。
`created_at`	string	创建时间；服务端未提供时省略。
`updated_at`	string	最后更新时间；服务端未提供时省略。

错误响应¶

响应示例

{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	可读错误信息。
`data`	null	错误响应中为 `null`。

后续操作¶

使用 data.id 查看工作流模板详情。

最后更新于 2026 年 9 月 3 日