查看工作流模板列表¶
列出当前工作区可见的内置和自定义工作流模板。内置模板按当前语言返回;自定义模板仅返回当前工作区创建的模板。
GET https://moi.matrixorigin.cn/newmoi/workflow-templates
调用前准备¶
查询参数¶
将 $AI_STUDIO_API_KEY 和 $WORKSPACE_ID 替换为实际值。
curl "https://moi.matrixorigin.cn/newmoi/workflow-templates?summary=true" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
boolean |
否 |
传 |
成功响应¶
成功时返回 200 和模板列表。summary=true 时每项仅返回摘要字段。
{
"code": "OK",
"msg": "OK",
"data": [
{
"id": 12,
"name": "daily-import-template",
"description": "每日导入工作流模板",
"is_builtin": false
}
]
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
array of object |
模板列表;没有可见模板时为空数组。 |
下面表格展开响应示例中 data 列表的一项;每一行是一个模板字段。
字段 |
类型 |
说明 |
|---|---|---|
|
integer |
模板 ID。 |
|
string |
模板名称。 |
|
string |
模板说明。 |
|
boolean |
是否为内置模板。 |
省略 summary 时,列表中的每一项还会返回以下字段。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
所属工作区 ID;内置模板为空字符串。 |
|
string |
创建者标识。 |
|
string |
最后更新者标识。 |
|
string |
内置模板标识;自定义模板为空字符串。 |
|
string |
模板语言。 |
|
string |
工作流 DSL YAML。 |
|
string |
运行时字段 JSON 文本。 |
|
string |
创建时间;服务端未提供时省略。 |
|
string |
最后更新时间;服务端未提供时省略。 |
错误响应¶
{
"code": "ErrWorkspaceIDMissing",
"msg": "需要工作区 ID",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
可读错误信息。 |
|
null |
错误响应中为 |
后续操作¶
使用列表项的 id 查看工作流模板详情。