查询自动化任务列表¶
查询当前工作区中可读取的自动化任务。结果支持按智能体、状态、触发方式和关键词筛选。
GET https://moi.matrixorigin.cn/newmoi/workspaces/{workspace_id}/agent-automation-tasks
调用前准备¶
准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。
下方示例使用:
$AI_STUDIO_API_KEY:实际个人访问令牌,通过X-API-KeyHeader 传递。$WORKSPACE_ID:要查询的工作区 ID,通过X-Workspace-IDHeader 传递,同时作为路径中的workspace_id。
路径参数¶
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
工作区 ID。 |
查询参数¶
未提供 limit 或 offset 时,服务默认返回 50 条记录并从第 0 条开始;limit 最大为 200。
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
否 |
按一个或多个智能体 ID 筛选。 |
|
string |
否 |
智能体所属工作区。 |
|
string |
否 |
按任务状态筛选。 |
|
string |
否 |
按触发方式筛选,例如 |
|
string |
否 |
按任务信息搜索。 |
|
integer |
否 |
返回数量。 |
|
integer |
否 |
返回列表的起始位置。 |
请求示例¶
curl "https://moi.matrixorigin.cn/newmoi/workspaces/$WORKSPACE_ID/agent-automation-tasks?status=active&limit=20&offset=0" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
成功响应¶
成功时返回 200。data.items 为任务列表,data.total 为匹配总数;当任务关联的智能体仍可读取时,还会返回 agent_summary。
{
"code": 0,
"data": {
"items": [
{
"id": "task_01",
"workspace_id": "ws_01",
"name": "每日摘要",
"agent_id": "agent_01",
"trigger": {
"mode": "cron"
},
"status": "active",
"version": 1,
"agent_summary": {
"id": "agent_01",
"workspace_id": "ws_01",
"name": "摘要助手",
"status": "active"
}
}
],
"total": 1,
"limit": 50,
"offset": 0
}
}
响应字段如下。
本文中,字段路径中的 [] 表示数组中的每一项。例如,items[].name 表示 items 数组中每一项的 name 字段。
字段 |
类型 |
说明 |
|---|---|---|
|
integer |
成功时为 |
|
array |
可读取的自动化任务。 |
|
string |
任务、工作区和目标智能体标识。 |
|
string |
任务、工作区和目标智能体标识。 |
|
string |
任务、工作区和目标智能体标识。 |
|
string |
任务名称、触发配置、状态和版本。 |
|
object |
任务名称、触发配置、状态和版本。 |
|
string |
任务名称、触发配置、状态和版本。 |
|
integer |
任务名称、触发配置、状态和版本。 |
|
object |
可读取时返回的目标智能体摘要。 |
|
integer |
匹配总数、当前页大小和偏移量。 |
|
integer |
匹配总数、当前页大小和偏移量。 |
|
integer |
匹配总数、当前页大小和偏移量。 |
错误响应¶
{
"code": 2,
"message": "<错误信息>"
}
常见 HTTP 错误¶
HTTP 状态码 |
错误代码 |
常见原因 |
建议操作 |
|---|---|---|---|
|
|
|
检查查询参数。 |
|
|
缺少有效身份凭据。 |
检查 API Key。 |
|
|
当前身份没有读取关联智能体的权限。 |
检查工作区和智能体授权。 |
|
|
自动化任务服务、权限筛选或智能体摘要投影依赖不可用。 |
稍后重试。 |
后续操作¶
保存目标任务的 id,再查询自动化任务详情。