# 更新会话

更新可见会话的标题、状态或置顶状态。将会话归档时，如果会话仍关联未结束的任务，服务端会拒绝该请求。

```text
PATCH https://moi.matrixorigin.cn/newmoi/workspaces/{workspace_id}/conversations/{conversation_id}
```

## 调用前准备

先[查询会话列表](list-sessions.md)或[创建会话](create-session.md)取得会话 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和会话 ID。

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：目标工作区 ID，通过 `X-Workspace-ID` Header 传递。
- `$CONVERSATION_ID`：要更新的会话 ID。
- `$AGENT_ID`：可选的智能体筛选 ID。

## 路径参数

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `workspace_id` | string | 是 | 当前工作区 ID，必须与 `X-Workspace-ID` 一致。 |
| `conversation_id` | string | 是 | 要更新的会话 ID。 |

## 查询参数

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `agent_id` | string | 否 | 限制为指定智能体的会话。未提供时不按智能体 ID 过滤。 |
| `agent_workspace_id` | string | 否 | 智能体所属工作区 ID。指定 `agent_id` 时未提供该参数则使用当前工作区；只能指定当前工作区或系统工作区。 |

## 请求体

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `title` | string | 否 | 新会话标题，长度不得超过 256。 |
| `status` | string | 否 | 新会话状态，可为 `active` 或 `archived`。 |
| `pinned` | boolean | 否 | 是否置顶。 |

## 请求示例

```bash
curl -X PATCH "https://moi.matrixorigin.cn/newmoi/workspaces/$WORKSPACE_ID/conversations/$CONVERSATION_ID?agent_id=$AGENT_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "华东销售分析",
    "pinned": true
  }'
```

## 成功响应

成功时返回 `200`。`data` 为更新后的会话。

```json
{
  "code": 0,
  "data": {
    "id": "conv_01",
    "workspace_id": "ws_01",
    "agent_workspace_id": "ws_01",
    "agent_id": "agent_01",
    "title": "华东销售分析",
    "status": "active",
    "purpose": "chat",
    "visibility": "visible",
    "pinned": true,
    "created_at": "2026-01-02T15:04:05Z",
    "updated_at": "2026-01-02T15:04:05Z"
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer | 成功时为 `0`。 |
| `data.id` | string | 会话 ID。 |
| `data.workspace_id` | string | 会话所属工作区 ID。 |
| `data.agent_workspace_id` | string | 智能体所属工作区 ID。 |
| `data.agent_id` | string | 智能体 ID。 |
| `data.agent_summary` | object | 智能体展示摘要；展示信息可用时返回。 |
| `data.title` | string | 更新后的会话标题；未设置时不返回。 |
| `data.status` | string | 更新后的会话状态。 |
| `data.purpose` | string | 会话用途。 |
| `data.visibility` | string | 会话可见性。 |
| `data.pinned` | boolean | 更新后的置顶状态。 |
| `data.head_message_id` | string | 最近消息 ID；尚无消息时不返回。 |
| `data.active_task_id` | string | 当前活动任务 ID；没有活动任务时不返回。 |
| `data.last_message_at` | string | 最近消息时间；尚无消息时不返回。 |
| `data.created_at` | string | 创建和最近更新时间，采用 RFC 3339 格式。 |
| `data.updated_at` | string | 创建和最近更新时间，采用 RFC 3339 格式。 |

## 错误响应

```json
{
  "code": 2,
  "message": "请求参数无效",
  "details": {
    "cause": "conversation with an active task cannot be archived"
  }
}
```

### 常见 HTTP 错误

```{list-table}
:header-rows: 1
:widths: 12 22 32 34

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `2`（`INVALID_ARGUMENT`）
  - 请求体无法解析，标题超过长度限制，状态无效，或尝试归档仍有关联未结束任务的会话。
  - 检查字段；先等待或结束活动任务，再归档会话。
* - `404`
  - `3`（`NOT_FOUND`）
  - 会话不存在、不可见，或不属于指定的智能体范围。
  - 确认会话 ID 和智能体筛选条件。
* - `500`
  - `1`（`INTERNAL`）
  - 服务端无法更新会话或生成智能体展示信息。
  - 记录请求时间和错误信息后重试。
* - `503`
  - `15`（`UNAVAILABLE`）
  - 会话服务暂不可用。
  - 稍后重试。
```

## 后续操作

调用[查询会话详情](get-session.md)确认会话的当前状态。
