Skip to main content
Sessions

更新 Session

更新 Forward Session 的标题、metadata 或环境变量。

POST /api/v1/forward/sessions/{session_id} 只更新稳定的会话字段;config 当前仅支持更新 environment_variables

请求头

Header是否必填说明
AuthorizationBearer <PAT 或 SAT>
Content-Typeapplication/json
Idempotency-Key有副作用请求可选的幂等键。

路径参数

参数类型是否必填说明
session_idstringSession ID。

请求体参数

参数类型是否必填说明
titlestring新的 Session 标题。
metadataobjectmetadata merge patch;传入的 key 覆盖已有 key,未出现的 key 保留。
configobjectSession 配置更新,当前只允许包含 environment_variablesnull 不合法。
config.environment_variablesobjectSession 环境变量 key-value,value 必须为 string。null 不合法。传入的 map 整组替换已有的 Session 级环境变量,替换后在 Template + Identity Config 编译结果基础上追加合并,同名变量覆盖基础层的值。
config.environment_variables 更新语义:
  • 缺省或 config{}:不修改环境变量。
  • 非空 object:整组替换 Session 级环境变量 map,不与旧值增量合并,未出现的旧 key 会被删除。
  • 空 object {}:清空 Session 级环境变量。
  • 整组替换只作用于 Session 级这一层;更新后 Session 的运行时环境变量仍在 Template + Identity Config 编译结果基础上追加合并,同名变量以 Session 级的值覆盖。
  • 环境变量名称、保留字与容量限制由运行时校验,不合法时返回 400。

示例请求

curl -s -X POST 'https://api.qoder.com/api/v1/forward/sessions/sess_xxx' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Updated session title",
  "metadata": {
    "source": "mobile",
    "biz_id": "ticket_123"
  },
  "config": {
    "environment_variables": {
      "API_KEY": "sk-xxx",
      "REGION": "cn-hangzhou"
    }
  }
}'

示例响应

HTTP 200 OK
{
  "id": "sess_xxx",
  "type": "session",
  "identity_id": "idn_xxx",
  "template": {
    "id": "tmpl_support",
    "type": "template",
    "name": "Support assistant",
    "model": "ultimate",
    "version": 3
  },
  "source_type": "api",
  "status": "idle",
  "title": "Updated session title",
  "metadata": {
    "source": "mobile",
    "biz_id": "ticket_123"
  },
  "config": {
    "environment_variables": {
      "API_KEY": "sk-xxx",
      "REGION": "cn-hangzhou"
    }
  },
  "stats": {
    "active_seconds": 30,
    "duration_seconds": 3600
  },
  "usage": {
    "total_credits": 12.7
  },
  "archived_at": null,
  "created_at": "2026-06-22T10:00:00Z",
  "updated_at": "2026-06-22T12:00:00Z"
}

响应字段

字段类型说明
返回值object更新后的 Session 对象。

错误

HTTPTypeCode触发条件
400invalid_request_errorinvalid_request更新请求体不合法。
400invalid_request_errorinvalid_request_body请求体 JSON 不合法,或 configconfig.environment_variablesnull
404not_found_errorsession_not_foundSession 不存在。
409conflict_errorsession_archivedSession 已归档。
401authentication_errorauthentication_requiredPAT 或 SAT 无效或已过期。

备注

  • resources 是创建时配置,不能通过本接口修改;如需在会话进行中追加文件资源,请使用添加 Session 资源接口。
  • 响应中的 config.environment_variables 反映更新后的结果。

相关