更新会话¶
更新可见会话的标题、状态或置顶状态。将会话归档时,如果会话仍关联未结束的任务,服务端会拒绝该请求。
PATCH https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/conversations/{conversation_id}
调用前准备¶
请求体¶
curl -X PATCH "https://api.moi.matrixorigin.cn/v5/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
}'
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
string |
否 |
新会话标题,长度不得超过 256。 |
|
string |
否 |
新会话状态,可为 active 或 archived。 |
|
boolean |
否 |
是否置顶。 |
请求参数¶
curl -X PATCH "https://api.moi.matrixorigin.cn/v5/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
}'
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
string |
是 |
当前工作区 ID,必须与 X-Workspace-ID 一致。 |
|
string |
是 |
要更新的会话 ID。 |
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
string |
否 |
限制为指定智能体的会话。未提供时不按智能体 ID 过滤。 |
|
string |
否 |
智能体所属工作区 ID。指定 agent_id 时未提供该参数则使用当前工作区;只能指定当前工作区或系统工作区。 |
成功响应¶
{
"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"
}
}
成功时返回 200。data 为更新后的会话。
字段 |
类型 |
说明 |
|---|---|---|
|
integer |
成功时为 0。 |
字段 |
类型 |
说明 |
|---|---|---|
|
string |
会话 ID。 |
|
string |
会话所属工作区 ID。 |
|
string |
智能体所属工作区 ID。 |
|
string |
智能体 ID。 |
|
object |
智能体展示摘要;展示信息可用时返回。 |
|
string |
更新后的会话标题;未设置时不返回。 |
|
string |
更新后的会话状态。 |
|
string |
会话用途。 |
|
string |
会话可见性。 |
|
boolean |
更新后的置顶状态。 |
|
string |
最近消息 ID;尚无消息时不返回。 |
|
string |
当前活动任务 ID;没有活动任务时不返回。 |
|
string |
最近消息时间;尚无消息时不返回。 |
|
string |
创建和最近更新时间,采用 RFC 3339 格式。 |
|
string |
创建和最近更新时间,采用 RFC 3339 格式。 |
错误响应¶
{
"code": 2,
"message": "请求参数无效",
"details": {
"cause": "conversation with an active task cannot be archived"
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
|
请求体无法解析,标题超过长度限制,状态无效,或尝试归档仍有关联未结束任务的会话。建议:检查字段;先等待或结束活动任务,再归档会话。 |
|
|
会话不存在、不可见,或不属于指定的智能体范围。建议:确认会话 ID 和智能体筛选条件。 |
|
|
服务端无法更新会话或生成智能体展示信息。建议:记录请求时间和错误信息后重试。 |
|
|
会话服务暂不可用。建议:稍后重试。 |
后续操作¶
调用查询会话详情确认会话的当前状态。