取消 Session - Qoder CN

取消正在处理中的 Session。仅在 processing 状态下调用 cancel 才会实际中断 Agent 执行：状态先转为 canceling，中断完成后自动回到 idle，Session 仍可继续使用------直接发送下一条 user.message 即可，无需创建新 Session。如果 Session 已处于 idle，cancel 是空操作，同样返回 200，状态保持 idle 不变。

请求头

头部	必选	说明
`Authorization`	是	`Bearer <PAT>`
`Content-Type`	是	`application/json`

路径参数

参数	类型	必选	说明
`session_id`	string	是	Session ID（`sess_` 前缀）

示例请求

curl -X POST "https://api.qoder.com.cn/api/v1/cloud/sessions/sess_019e3bb1e8c171fd9abbb1477ffb84cc/cancel" \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json"

示例响应

HTTP 202 Accepted 取消指令异步执行，返回精简的状态确认对象。最终轮次状态回到 idle，对应 session.status_idle 事件的 stop_reason.type 为 cancelled。

{
  "id": "sess_019e3bb1e8c171fd9abbb1477ffb84cc",
  "type": "session",
  "status": "canceling"
}

响应字段

字段	类型	说明
`id`	string	Session ID
`type`	string	固定值 `"session"`
`status`	string	取消后的状态，值为 `"canceling"`

canceling 是中间状态，表示取消指令已发出。中断完成后最终状态变为 idle，可通过 SSE 流监听 session.status_idle 事件确认。

错误码

HTTP	type	触发条件
401	`authentication_error`	PAT 无效或过期
404	`not_found_error`	Session 不存在

完整错误信封说明详见错误参考。

​请求头

​路径参数

​示例请求

​示例响应

​响应字段

​错误码

请求头

路径参数

示例请求

示例响应

响应字段

错误码