查询自动化任务列表

查询当前工作区中可读取的自动化任务。结果支持按智能体、状态、触发方式和关键词筛选。

GET https://moi.matrixorigin.cn/newmoi/workspaces/{workspace_id}/agent-automation-tasks

调用前准备

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

下方示例使用:

  • $AI_STUDIO_API_KEY:实际个人访问令牌,通过 X-API-Key Header 传递。

  • $WORKSPACE_ID:要查询的工作区 ID,通过 X-Workspace-ID Header 传递,同时作为路径中的 workspace_id

路径参数

参数

类型

是否必填

说明

workspace_id

string

工作区 ID。

查询参数

未提供 limitoffset 时,服务默认返回 50 条记录并从第 0 条开始;limit 最大为 200。

参数

类型

是否必填

说明

agent_id

string

按一个或多个智能体 ID 筛选。

agent_workspace_id

string

智能体所属工作区。

status

string

按任务状态筛选。

trigger_mode

string

按触发方式筛选,例如 cronapicallback

query

string

按任务信息搜索。

limit

integer

返回数量。

offset

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"

成功响应

成功时返回 200data.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 字段。

字段

类型

说明

code

integer

成功时为 0

data.items

array

可读取的自动化任务。

data.items[].id

string

任务、工作区和目标智能体标识。

data.items[].workspace_id

string

任务、工作区和目标智能体标识。

data.items[].agent_id

string

任务、工作区和目标智能体标识。

data.items[].name

string

任务名称、触发配置、状态和版本。

data.items[].trigger

object

任务名称、触发配置、状态和版本。

data.items[].status

string

任务名称、触发配置、状态和版本。

data.items[].version

integer

任务名称、触发配置、状态和版本。

data.items[].agent_summary

object

可读取时返回的目标智能体摘要。

data.total

integer

匹配总数、当前页大小和偏移量。

data.limit

integer

匹配总数、当前页大小和偏移量。

data.offset

integer

匹配总数、当前页大小和偏移量。

错误响应

{
  "code": 2,
  "message": "<错误信息>"
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

2INVALID_ARGUMENT

agent_idagent_workspace_id 或其他筛选参数无效。

检查查询参数。

401

6UNAUTHENTICATED

缺少有效身份凭据。

检查 API Key。

403

5PERMISSION_DENIED

当前身份没有读取关联智能体的权限。

检查工作区和智能体授权。

503

15UNAVAILABLE

自动化任务服务、权限筛选或智能体摘要投影依赖不可用。

稍后重试。

后续操作

保存目标任务的 id,再查询自动化任务详情

最后更新于