取消 Session

取消正在处理中的 Session，中断 Agent 执行。

POST /v1/sessions/{session_id}/cancel

取消正在处理中的 Session。只有当前 turn 正在处理时，cancel 才会实际中断 Agent 执行；中断完成后 turn 会回到 idle。Session 仍可继续使用，等待 idle 后直接发送下一条 user.message 即可。如果没有正在处理的 turn，cancel 是空操作并返回 HTTP 200。

​

请求头

头部	必选	说明
Authorization	是	Bearer <PAT>

​

路径参数

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

​

示例请求

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

​

示例响应

HTTP 202 Accepted

取消指令异步执行，返回精简的状态确认对象。HTTP 202 表示取消已作用于正在处理的 turn；HTTP 200 表示本次调用为空操作，通常因为没有正在处理的 turn。两种情况的响应体结构相同。

{
  "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 不存在

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

​

相关

启动 Session

让 Agent 在环境中以有状态对话的方式运行。