# 查询工作流模板列表

列出当前工作区可见的内置和自定义工作流模板。内置模板按当前语言返回；自定义模板仅返回当前工作区创建的模板。

```text
GET https://moi.matrixorigin.cn/newmoi/workflow-templates
```

## 调用前准备

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：目标工作区 ID，通过 `X-Workspace-ID` Header 传递。

## 查询参数

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `summary` | boolean | 否 | 设为字符串 `true` 时仅返回 `id`、`name`、`description` 和 `is_builtin`；其他值或不传时返回完整模板定义。 |

## 请求示例

查询摘要列表：

```bash
curl "https://moi.matrixorigin.cn/newmoi/workflow-templates?summary=true" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"
```

## 成功响应

成功时返回 `200`。`summary=true` 时 `data` 是摘要对象数组：

```json
{
  "code": "OK",
  "msg": "OK",
  "data": [
    {
      "id": 12,
      "name": "daily-import-template",
      "description": "每日导入工作流模板",
      "is_builtin": false
    }
  ]
}
```

不传 `summary=true` 时，每一项返回完整模板定义：

```json
{
  "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"
    }
  ]
}
```

响应字段如下。

本文中，字段路径中的 `[]` 表示数组中的每一项。例如，`items[].name` 表示 `items` 数组中每一项的 `name` 字段。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data` | object（对象数组） | 模板列表；没有可见模板时返回空数组。 |
| `data[].id` | integer | 模板 ID。 |
| `data[].name` | string | 模板名称。 |
| `data[].description` | string | 模板说明。 |
| `data[].is_builtin` | boolean | 是否为内置模板。 |
| `data[].workspace_id` | string | 完整模式下的所属工作区 ID；内置模板为空字符串。 |
| `data[].created_by` | string | 完整模式下的创建者标识。 |
| `data[].updated_by` | string | 完整模式下的最后更新者标识。 |
| `data[].template_key` | string | 完整模式下的内置模板标识；自定义模板为空字符串。 |
| `data[].language` | string | 完整模式下的模板语言。 |
| `data[].dsl_yaml` | string | 完整模式下的工作流 DSL YAML。 |
| `data[].runtime_fields` | string | 完整模式下的运行时字段 JSON 文本。 |
| `data[].created_at` | string | 完整模式下的创建时间；服务端未提供时可能省略。 |
| `data[].updated_at` | string | 完整模式下的最后更新时间；服务端未提供时可能省略。 |

## 错误响应

失败响应的 `data` 为 `null`。

```json
{
  "code": "ErrWorkspaceIDMissing",
  "msg": "需要工作区标识",
  "data": null
}
```

### 常见 HTTP 错误

```{list-table}
:header-rows: 1
:widths: 12 22 32 34

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrWorkspaceIDMissing`
  - 请求上下文中缺少工作区。
  - 传入有效的 `X-Workspace-ID`。
* - `500`
  - `ErrServer`
  - 服务端未能读取模板列表。
  - 稍后重试。
```

## 后续操作

使用 `data[].id` [查询工作流模板详情](get-workflow-template.md)。