查看工作区列表

查看当前身份可访问的工作区。可按名称筛选结果。

GET https://api.moi.matrixorigin.cn/v5/workspaces

调用前准备

准备个人访问令牌。此接口不需要先进入某个工作区。

查询参数

将 $AI_STUDIO_API_KEY 替换为实际值。不需要按名称筛选时，去掉 name 查询参数。

调用示例

curl --get "https://api.moi.matrixorigin.cn/v5/workspaces" \
  --data-urlencode "name=$WORKSPACE_NAME" \
  -H "X-API-Key: $AI_STUDIO_API_KEY"

参数说明

参数	类型	是否必填	说明
name	string	否	按工作区名称筛选。不区分大小写的包含匹配；省略时返回当前身份可访问的全部工作区。此接口不分页，data.total 等于返回数组的长度。

成功响应

成功时返回 200。没有匹配项时，data.workspaces 为空数组。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "workspaces": [
      {
        "id": "ws_01",
        "name": "分析工作区",
        "status": "active",
        "owner_id": "user_01",
        "owner_name": "张三",
        "owner_email": "zhangsan@example.com",
        "created_at": "2026-08-01T09:00:00Z",
        "access_status": "active"
      }
    ],
    "total": 1
  }
}

字段说明

字段	类型	说明
code	string	成功时为 OK。
msg	string	成功时为 OK。
data.workspaces	array of object	工作区列表。没有匹配项时为空数组。
data.workspaces.id	string	工作区 ID。
data.workspaces.name	string	工作区名称。
data.workspaces.status	string	工作区当前状态。
data.workspaces.owner_id	string	所有者的用户 ID。
data.workspaces.owner_name	string	所有者名称。
data.workspaces.owner_email	string	所有者邮箱。
data.workspaces.created_at	string	创建时间。
data.workspaces.access_status	string	当前身份对该工作区的访问状态。
data.workspaces.invitation_id	string	与当前身份相关的待处理邀请 ID；没有邀请时省略。
data.total	integer	返回的工作区数量。

错误响应

响应示例

{
  "code": "ErrWorkspaceListFailed",
  "msg": "查询工作区失败",
  "data": null
}

字段说明

字段	类型	说明
code	string	错误代码。
msg	string	可读错误信息。
data	null	错误响应中为 null。

后续操作

记录目标工作区的 id。需要创建新工作区时，提交创建工作区任务；需要处理未完成邀请时，使用 invitation_id 接受工作区邀请。

最后更新于 2026 年 9 月 11 日