查询工作流模板详情¶

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

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

调用前准备¶

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

下方示例使用：

$AI_STUDIO_API_KEY：实际个人访问令牌，通过 X-API-Key Header 传递。
$WORKSPACE_ID：目标工作区 ID，通过 X-Workspace-ID Header 传递。
$TEMPLATE_ID：要查询的模板 ID。

路径参数¶

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

请求示例¶

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

成功响应¶

成功时返回 200。data 为完整模板对象。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": 12,
    "workspace_id": "ws-001",
    "created_by": "user-001",
    "updated_by": "user-001",
    "template_key": "",
    "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.id`	integer	模板 ID。
`data.workspace_id`	string	所属工作区 ID；内置模板为空字符串。
`data.created_by`	string	创建者标识。
`data.updated_by`	string	最后更新者标识。
`data.template_key`	string	内置模板标识；自定义模板为空字符串。
`data.name`	string	模板名称。
`data.description`	string	模板说明。
`data.language`	string	模板语言。
`data.dsl_yaml`	string	工作流 DSL YAML。
`data.runtime_fields`	string	运行时字段 JSON 文本；未配置时为空字符串。
`data.is_builtin`	boolean	是否为内置模板。
`data.created_at`	string	创建时间；服务端未提供时可能省略。
`data.updated_at`	string	最后更新时间；服务端未提供时可能省略。

错误响应¶

失败响应的 data 为 null。

{
  "code": "ErrNotFound",
  "msg": "模板不存在",
  "data": null
}

常见 HTTP 错误¶

HTTP 状态码	错误代码	常见原因	建议操作
`400`	`ErrParamInvalid`	`id` 不是大于 `0` 的整数。	使用列表响应中的 `id`。
`400`	`ErrWorkspaceIDMissing`	请求上下文中缺少工作区。	传入有效的 `X-Workspace-ID`。
`404`	`ErrNotFound`	模板不存在、不是当前语言的内置模板，或不是当前工作区的自定义模板。	核对模板 ID 和工作区。
`500`	`ErrServer`	服务端未能读取模板。	稍后重试。

后续操作¶

需要修改定义时更新工作流模板；不再使用时删除工作流模板。

最后更新于 2026 年 8 月 22 日