启动 Session

Session 生命周期

1. 创建 → idle

   新 Session 进入 idle，等待输入。

2. idle → processing

   发送 user.message 事件后，状态切换到 processing。

3. processing → idle

   本轮完成后回到 idle，可继续下一轮。

4. processing → canceling → idle

   取消正在执行的 Session 后，状态先经过 canceling，再回到 idle，Session 仍可继续使用。

5. archived（终态）

   归档是终态，Session 不再可恢复。

Session 是一个状态机，核心状态如下：

字段说明

创建 Session

创建 Session 时需要指定 agent 和 environment_id：

方式一：使用 Agent ID（字符串）

绑定该 Agent 的最新版本：

# 使用 Agent ID 创建 Session
curl -s -X POST https://api.qoder.com.cn/api/v1/cloud/sessions \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "agent": "agent_019e5ce0bf307a1a8f952eb814aea3d5",
    "environment_id": "env_019e44eb66bb748cabcd1489f6fa4428"
  }' | jq .

方式二：使用 Agent 对象（指定版本）

绑定 Agent 的特定版本，确保行为一致性：

# 指定 Agent 版本创建 Session
curl -s -X POST https://api.qoder.com.cn/api/v1/cloud/sessions \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "agent": {
      "id": "agent_019e5ce0bf307a1a8f952eb814aea3d5",
      "version": 2
    },
    "environment_id": "env_019e44eb66bb748cabcd1489f6fa4428"
  }' | jq .

成功返回 201 Created：

{
  "id": "sess_019e5ce0bf9074b69c3481e93771a522",
  "agent": {
    "created_at": "2026-05-18T10:00:00Z",
    "default_environment": "",
    "description": "",
    "id": "agent_019e5ce0bf307a1a8f952eb814aea3d5",
    "instructions": "你是代码审查专家。",
    "mcp_servers": [],
    "model": "ultimate",
    "name": "code-reviewer",
    "system": "你是代码审查专家。",
    "tools": [
      {
        "type": "agent_toolset_20260401",
        "enabled_tools": ["Bash", "Read", "Write"]
      }
    ],
    "type": "agent",
    "updated_at": "2026-05-18T10:00:00Z",
    "version": 2
  },
  "agent_id": "agent_019e5ce0bf307a1a8f952eb814aea3d5",
  "environment_id": "env_019e44eb66bb748cabcd1489f6fa4428",
  "status": "idle",
  "title": "",
  "turn_status": "idle",
  "memory_store_ids": [],
  "resources": [],
  "vault_ids": [],
  "type": "session",
  "created_at": "2026-05-18T12:00:00Z",
  "updated_at": "2026-05-18T12:00:00Z"
}

在生产环境中建议使用方式二（指定版本），避免因 Agent 更新导致行为变化。

agent 字段格式

状态流转

事件请求体格式

POST /sessions/{id}/events 的请求体必须使用 events 数组包装，content 是内容块数组：

idle → processing

当你向 Session 发送 user.message 事件时，状态从 idle 变为 processing：

# 发送消息触发处理
curl -s -X POST "https://api.qoder.com.cn/api/v1/cloud/sessions/sess_019e5ce0bf9074b69c3481e93771a522/events" \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "events": [{
      "type": "user.message",
      "content": [{"type": "text", "text": "分析当前目录下所有 Python 文件的代码复杂度。"}]
    }]
  }' | jq .

processing → idle

Agent 完成处理后自动回到 idle，通过事件流会收到 session.status_idle 事件。

取消 Session

中断正在执行的 Session：

# 取消 Session
curl -s -X POST "https://api.qoder.com.cn/api/v1/cloud/sessions/sess_019e5ce0bf9074b69c3481e93771a522/cancel" \
  -H "Authorization: Bearer $QODER_PAT"

查询 Session

# 获取单个 Session 详情
curl -s "https://api.qoder.com.cn/api/v1/cloud/sessions/sess_019e5ce0bf9074b69c3481e93771a522" \
  -H "Authorization: Bearer $QODER_PAT"

# 列出所有 Session（支持分页）
curl -s "https://api.qoder.com.cn/api/v1/cloud/sessions?limit=10" \
  -H "Authorization: Bearer $QODER_PAT"

分页响应：

{
  "data": [
    {
      "id": "sess_019e5ce0bf9074b69c3481e93771a522",
      "type": "session",
      "agent_id": "agent_019e5ce0bf307a1a8f952eb814aea3d5",
      "environment_id": "env_019e44eb66bb748cabcd1489f6fa4428",
      "status": "idle",
      "turn_status": "idle",
      "title": "",
      "memory_store_ids": [],
      "vault_ids": [],
      "resources": [],
      "created_at": "2026-05-18T12:00:00Z",
      "updated_at": "2026-05-18T12:30:00Z"
    }
  ],
  "first_id": "sess_019e5ce0bf9074b69c3481e93771a522",
  "last_id": "sess_019e5ce0bf9074b69c3481e93771a522",
  "has_more": false
}

Usage 统计

每轮的 token 用量不通过 REST 接口返回。要查看用量，请监听每轮结束的 SSE session.status_idle 事件，其 usage 字段携带累计计数：

SSE 事件中的示例 payload：

{
  "type": "session.status_idle",
  "usage": {
    "input_tokens": 3840,
    "output_tokens": 2156,
    "cache_read_input_tokens": 0,
    "cache_creation_input_tokens": 0
  }
}

Session 与 Agent 版本绑定

Session 创建时会快照 Agent 的配置：

• 使用字符串形式 "agent": "agent_xxx" 绑定创建时刻的最新版本

• 使用对象形式 "agent": {"id": "agent_xxx", "version": N} 绑定精确版本

• Session 创建后，修改 Agent 不会影响已存在的 Session

• 想要使用新版 Agent，需要创建新的 Session

多轮对话

Session 支持多轮对话。每次发送消息后等待 session.status_idle，然后继续发送：

#!/bin/bash
# 多轮对话示例
BASE_URL="https://api.qoder.com.cn/api/v1/cloud"
SESSION_ID="sess_019e5ce0bf9074b69c3481e93771a522"
HEADERS=(
  -H "Authorization: Bearer $QODER_PAT"
)

# 第一轮：提出需求
curl -s -X POST "$BASE_URL/sessions/$SESSION_ID/events" \
  "${HEADERS[@]}" \
  -H "Content-Type: application/json" \
  -d '{"events": [{"type": "user.message", "content": [{"type": "text", "text": "创建一个 Python Flask 项目脚手架。"}]}]}'

# 等待处理完成...（轮询或监听 SSE）
sleep 30

# 第二轮：追加要求
curl -s -X POST "$BASE_URL/sessions/$SESSION_ID/events" \
  "${HEADERS[@]}" \
  -H "Content-Type: application/json" \
  -d '{"events": [{"type": "user.message", "content": [{"type": "text", "text": "给项目添加单元测试和 CI 配置。"}]}]}'

状态相关错误码

向 Session 发送事件时，常见的状态相关错误：

409 错误响应示例：

{
  "type": "error",
  "error": {
    "type": "conflict_error",
    "message": "Session is currently processing a turn. Cancel the current turn or wait for completion."
  }
}

最佳实践

1. 版本锁定 — 生产环境始终使用 {"id": ..., "version": ...} 形式创建 Session

2. 及时取消 — 不再需要的 Session 及时 cancel，释放资源

3. 监控用量 — 定期检查 usage 字段，避免意外消耗

4. 元数据标记 — 用 metadata 记录业务上下文（任务 ID、触发来源等）

常见问题

Q: Session 有超时机制吗？

A: Session 在 idle 状态下会保持一段时间。长时间不活跃的 Session 可能被系统自动归档。建议按需创建，任务完成后主动 cancel。

Q: 向 processing 状态的 Session 发消息会怎样？

A: 会返回 HTTP 409 conflict_error，错误信息为 Session is currently processing a turn. Cancel the current turn or wait for completion.。需要先取消当前轮（cancel）或等待 Session 回到 idle，再发送新消息。

Q: 一个 Session 最多支持多少轮对话？

A: 没有硬性轮次限制，但受模型上下文窗口大小约束。随着对话增长，早期内容可能被截断。

Q: 如何获取 Session 的完整对话历史？

A: 通过 GET /sessions/{id}/events 获取该 Session 的所有事件，包括用户消息和 Agent 响应。

Q: 取消后的 Session 还能继续用吗？

A: 可以。cancel 后状态从 canceling 自动回到 idle，Session 保持可用——直接发送下一条 user.message 即可继续对话。仅 archived 是终态，归档后无法恢复。