查询会话列表

查询工作区中的可见会话。可按智能体、状态、用途或置顶状态筛选,并通过分页参数分段读取。

GET https://moi.matrixorigin.cn/newmoi/workspaces/{workspace_id}/conversations

调用前准备

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。如需按智能体筛选,先取得智能体 ID。

下方示例使用:

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

  • $WORKSPACE_ID:目标工作区 ID,通过 X-Workspace-ID Header 传递。

  • $AGENT_ID:可选的智能体筛选 ID。

路径参数

参数

类型

是否必填

说明

workspace_id

string

当前工作区 ID,必须与 X-Workspace-ID 一致。

查询参数

参数

类型

是否必填

说明

agent_id

string

仅返回指定智能体的会话。

agent_workspace_id

string

智能体所属工作区 ID。指定 agent_id 时未提供该参数则使用当前工作区;只能指定当前工作区或系统工作区。

status

string

按会话状态筛选。

purpose

string

按会话用途筛选,可为 chatworkflow

pinned

boolean

true1 时仅返回已置顶会话;为其他值时筛选未置顶会话。

visibility

string

仅接受 visible;未提供时仅返回可见会话。

parent_conversation_id

string

按父会话 ID 筛选。

limit

integer

单次返回数量。未提供或小于等于 0 时为 50,最大为 200

offset

integer

返回偏移量。未提供或小于 0 时为 0

请求示例

curl --get "https://moi.matrixorigin.cn/newmoi/workspaces/$WORKSPACE_ID/conversations" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  --data-urlencode "agent_id=$AGENT_ID" \
  --data-urlencode "status=active" \
  --data-urlencode "limit=20" \
  --data-urlencode "offset=0"

成功响应

成功时返回 200data.items 是本页会话,data.total 是筛选结果总数,data.limitdata.offset 是本次实际采用的分页值。

{
  "code": 0,
  "data": {
    "items": [
      {
        "id": "conv_01",
        "workspace_id": "ws_01",
        "agent_workspace_id": "ws_01",
        "agent_id": "agent_01",
        "agent_summary": {
          "id": "agent_01",
          "display_name": "销售分析助手",
          "available": true
        },
        "title": "销售分析",
        "status": "active",
        "purpose": "chat",
        "visibility": "visible",
        "pinned": false,
        "created_at": "2026-01-02T15:04:05Z",
        "updated_at": "2026-01-02T15:04:05Z"
      }
    ],
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}

响应字段如下。

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

字段

类型

说明

code

integer

成功时为 0

data.items

object(对象数组)

本页会话列表。

data.items[].id

string

会话 ID。

data.items[].workspace_id

string

会话所属工作区 ID。

data.items[].agent_workspace_id

string

智能体所属工作区 ID。

data.items[].agent_id

string

智能体 ID。

data.items[].agent_summary

object

智能体展示摘要。

data.items[].title

string

会话标题;未设置时不返回。

data.items[].status

string

会话状态。

data.items[].purpose

string

会话用途。

data.items[].visibility

string

会话可见性。

data.items[].pinned

boolean

是否置顶。

data.items[].head_message_id

string

最近消息 ID;没有消息时不返回。

data.items[].active_task_id

string

当前活动任务 ID;没有活动任务时不返回。

data.items[].last_message_at

string

最近消息时间;没有消息时不返回。

data.items[].created_at

string

创建和最近更新时间,采用 RFC 3339 格式。

data.items[].updated_at

string

创建和最近更新时间,采用 RFC 3339 格式。

data.total

integer

符合筛选条件的会话总数。

data.limit

integer

本次实际采用的返回数量上限。

data.offset

integer

本次实际采用的偏移量。

错误响应

{
  "code": 2,
  "message": "请求参数无效",
  "details": {
    "cause": "invalid runtime conversation"
  }
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

2INVALID_ARGUMENT

智能体 ID、工作区 ID、用途、可见性或分页参数无效。

检查查询参数;visibility 只能为 visible

500

1INTERNAL

服务端无法查询会话或生成会话展示信息。

记录请求时间和错误信息后重试。

503

15UNAVAILABLE

会话服务暂不可用。

稍后重试。

后续操作

使用返回的 data.items[].id 调用查询会话详情查询会话消息

最后更新于