跳转到主要内容
POST /api/v1/cloud/sessions/{session_id}/cancel 请求取消 Session 当前轮(turn)的执行。对运行中的 Session 执行 Cancel 返回 HTTP 202 Accepted,Session 状态从 canceling 自动回到 idle;对空闲 Session 执行 Cancel 是幂等的 no-op,返回 HTTP 200 OK

路径参数

参数类型说明
session_idstringsess_ 为前缀的 Session ID

请求头

头部必选说明
AuthorizationBearer $QODER_PAT

示例请求

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

示例响应

HTTP 200 OK (no-op) or HTTP 202 Accepted (cancellation applied)
{
  "id": "sess_019ef30a4f0275678965d496ab542ef0",
  "type": "session",
  "status": "canceling"
}
status 字段在两种情况下均为 "canceling"。当前 turn 中止后,Session 将恢复为 idle

错误码

HTTP类型触发条件
401authentication_errorPAT 无效或过期
404not_found_errorSession 不存在或已归档
备注: 对已处于 idle 状态的 Session 调用 cancel 是安全的空操作(no-op),返回 HTTP 200。无论是否实际触发了取消(202 表示已触发,200 表示空操作),响应均使用相同的轻量格式。
HTTP 404 Not Found
{
  "type": "error",
  "request_id": "cb80235f-76a2-4ff3-9e28-5aa2da12dc14",
  "error": {
    "type": "not_found_error",
    "message": "Session 'sess_does_not_exist_0000000000000000000000000000' was not found."
  }
}
完整错误信封格式见 错误参考

相关

启动 Session

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