Skip to main content
POST
更新会话
每个请求都必须发送 ?beta=true

授权

X-Api-Key
string
header
默认值:sk-ant-local-default
必填

OMA 工作区 API 密钥。

请求头

anthropic-version
string
anthropic-beta
string

路径参数

session_id
string
必填

会话标识符。

查询参数

beta
enum<boolean>
必填

为此接口启用 Beta API 合同,必须为 true

可用选项:
true

请求体

application/json

用于更新 session 的请求参数。省略字段以保留其当前值。

title
string | null

人类可读的会话标题。

Required string length: 1 - 500
示例:

"订单 #1234 咨询"

metadata
object | null

元数据补丁。将某个键设为字符串可插入或更新该键,设为 null 可删除该键。省略该字段则保持不变。

vault_ids
string[]

要附加到会话的密钥库 ID(vlt_*)。尚不支持;设置了此字段的请求将被拒绝。保留供将来使用。

agent
object

智能体配置更新。会话进行中只有 toolsmcp_servers 可更新。仅对从智能体或部署引用创建的会话有效。该会话不得处于运行状态。

budget
object | null

会话的强制消费上限。传入对象可替换创建时带有预算的会话的预算,传入 null 可将其移除;省略则保持不变。不能为创建时没有预算的会话添加预算(会以原因 budget_create_only 拒绝),已移除的预算也不能重新添加。在任何未终止状态下均允许。将 max_list_cost 降低到等于或低于会话已消费的列表成本会以原因 budget_not_raised 拒绝,并且会话可能运行的每个模型都必须具有公开的列表价格,否则请求会以原因 model_not_budgetable 拒绝。

响应

请求成功。

托管智能体的 session

type
enum<string>
必填
可用选项:
session
示例:

"session"

id
string
必填
示例:

"sesn_011CZkZAtmR3yMPDzynEDxu7"

status
enum<string>
必填

会话状态枚举

可用选项:
rescheduling,
running,
idle,
terminated
示例:

"idle"

created_at
string<date-time>
必填

RFC 3339 格式的时间戳

示例:

"2026-03-15T10:00:00Z"

updated_at
string<date-time>
必填

RFC 3339 格式的时间戳

示例:

"2026-03-15T10:00:00Z"

environment_id
string
必填
示例:

"env_011CZkZ9X2dpNyB7HsEFoRfW"

title
string | null
必填
示例:

"订单 #1234 咨询"

metadata
object
必填
示例:
agent
object
必填

已解析的 session 所用 agent 定义。session 创建时该 agent 的快照。

示例:
resources
object[]
必填
示例:
示例:
vault_ids
string[]
必填

创建时附加到会话的密钥库 ID 列表。未提供密钥库时为空。

示例:
outcome_evaluations
object[]
必填

按结果划分的评估状态。发送给会话的每个 define_outcome 事件对应一个条目。

示例:
usage
object
必填

会话的累计令牌用量。

示例:
stats
object
必填

该会话的计时统计信息。

示例:
archived_at
string<date-time> | null
必填

会话的归档时间。未归档时为 null。

示例:

null

budget
object | null
必填

会话强制执行的花费上限;未设置预算时为 null。

示例:

null

deployment_id
string | null

当会话由部署引用创建时对应的部署 ID。否则为 Null。