Skip to main content

Session 对象

创建、获取、列出、更新和归档接口都会返回该对象。 Session 响应不再包含旧字段 agent_idturn_statusmemory_store_idsusage

Agent 引用

创建 Session 时的 agent 可以是 Agent ID 字符串,也可以是如下对象:

Session 嵌入 agent

Session 对象 中返回的 agent 是该 Session 固定的 Agent 快照,与原始 Agent 相比有以下字段会被裁剪:
  • created_atupdated_at:嵌入 Agent 中始终不返回。
  • archivedarchived_at:嵌入 Agent 中始终不返回;Session 不受 Agent 归档状态影响。
  • metadata:Agent 自身的 metadata 被裁剪;只暴露 Session 级别的 metadata
  • instructions:被替换为 system
当 Agent 配置 multiagent.type = "coordinator" 时,agent.multiagent.agents[] 中的桩 {type, id, version} 会被服务端展开为完整 Agent 定义(详见 Multiagent 阵列元素)。在 Session Thread 对象 中,嵌入 agent 还会额外去掉 multiagent 字段——协调器子线程只携带各自的 Agent 快照。

agent.model.effective_context_window

Session 响应在 agent.model 中额外返回只读字段 effective_context_window(int64,单位 token),表示当前 Session 实际生效的上下文窗口(已考虑 Environment 级 override)。值为非正或缺失时不返回;客户端将该字段视为参考即可。

Session resource

resources[] 通过 type 区分资源类型。

File resource

GitHub repository resource

Memory Store resource

Memory Store resource 不包含 idcreated_atupdated_at 字段。

Session stats

Multiagent 阵列元素

当嵌入 Agent 配置 multiagent.type = "coordinator" 时,Session 接口返回的 agent.multiagent.agents[] 每条元素都会从原始桩引用展开为完整 Agent 定义(同样遵循 Session 嵌入 agent 的字段裁剪规则,且每条元素自身的 multiagent 字段会被裁掉)。 桩引用解析失败(例如目标 Agent 版本已删除)的元素将原样返回。

Event 对象

send、list 和 stream 接口返回的事件是按事件类型变化的 JSON 对象。公开响应只暴露文档中定义的公开字段。 不同事件类型还可能包含 contentinputnametool_use_idmcp_tool_use_idcustom_tool_use_idresultdeny_messagerubricoutcome_idsession_thread_idstop_reasonerrorusage 等字段。

客户端可发送事件类型

POST /api/v1/cloud/sessions/{session_id}/events 只接受以下事件类型:

公开事件类型

list 和 stream 接口可能暴露以下事件类型: user.messageuser.interruptuser.tool_confirmationuser.custom_tool_resultuser.define_outcomeuser.tool_resultsystem.messageagent.custom_tool_useagent.mcp_tool_resultagent.mcp_tool_useagent.messageagent.thinkingagent.thread_context_compactedagent.thread_message_receivedagent.thread_message_sentagent.tool_resultagent.tool_usesession.deletedsession.errorsession.status_idlesession.status_rescheduledsession.status_runningsession.status_terminatedsession.thread_createdsession.thread_status_idlesession.thread_status_rescheduledsession.thread_status_runningsession.thread_status_terminatedsession.updatedspan.model_request_startspan.model_request_endspan.outcome_evaluation_startspan.outcome_evaluation_ongoingspan.outcome_evaluation_end

Event delta stream 帧

buffered 事件是内容生成完成后输出并写入 Session 事件历史的完整公开 Event 对象,也是客户端应采用的权威结果。 event_startevent_delta 是用于增量输出的 stream-only SSE payload,不属于公开 Event 对象,也不会出现在事件 list/history 响应中。它们的 JSON payload 不包含顶层 idprocessed_at;SSE id: 字段携带正在增量输出的事件 ID,并可用于 Last-Event-ID

Event start 帧

event_start 帧用于标识已经开始增量输出的公开事件。 event 对象包含以下字段: agent.message 的 start 之后会输出文本 event_deltaagent.thinking 只有 start,不会输出 delta;如果本轮产生 thinking,则使用相同 ID 的 buffered agent.thinking 事件表示该 thinking 阶段结束。

Event delta 帧

event_delta 帧用于向增量输出的 agent.message 追加文本。 delta 对象包含以下字段:

Model request span 事件

span.model_request_start 表示一次模型请求开始。 span.model_request_end 表示该模型请求结束。 Model request span 的公开响应不包含模型用量或内部耗时信息。

Session Thread 对象

Managed-agent 场景下,Session 内的每个线程使用如下结构。 Thread 响应不再包含旧字段 agent_idagent_versionnamerolestop_reasoncreated_by_tool_use_idusage