查看工作流模板详情¶

读取一个工作流模板的完整定义。可读取当前语言的内置模板，以及当前工作区创建的自定义模板。

GET https://api.moi.matrixorigin.cn/v5/workflow-templates/{id}

调用前准备¶

先查看工作流模板列表取得模板 ID。准备具有目标工作区访问权限的个人访问令牌和目标工作区 ID。

路径参数¶

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和 $TEMPLATE_ID 替换为实际值。

调用示例

curl "https://api.moi.matrixorigin.cn/v5/workflow-templates/$TEMPLATE_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

参数说明

参数	类型	是否必填	说明
`id`	integer	是	大于 0 的模板 ID。

成功响应¶

成功时返回 200 和完整模板定义。

响应示例

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

字段说明

通用字段

字段	类型	说明
`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": "ErrNotFound",
  "msg": "未找到工作流模板",
  "data": null
}

字段说明

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

后续操作¶

使用模板 ID 更新工作流模板或删除工作流模板。

最后更新于 2026 年 9 月 11 日