GET https://ark.cn-beijing.volces.com/api/v3/sessions/{session_id}/threads/{thread_id}/stream
通过 SSE(Server-Sent Events)协议订阅指定线程视角的实时事件。订阅主线程时,可能同时收到子线程的创建、状态变化和需要主线程处理的工具请求通知。所有事件的结构定义详情请参见 会话事件结构参考。
鉴权#
本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。
- API Key 鉴权,请在 API Key 管理 页面,获取长效 API Key。
请求参数#
Path 参数#
session_id string 必选 | 会话 ID
会话 ID,形如 sesn-...
thread_id string 必选 | 线程 ID
线程 ID,以 sthr- 开头
Query 参数#
在 URL Query String 中传入。
event_deltas array | 流式预览事件类型
指定希望以 event_start 和 event_delta 预览的事件类型。当前支持 agent.message 和 agent.thinking;未提供时不返回预览帧
响应参数#
SSE 流式响应,每个事件为一个 SessionEvent 对象,仅包含当前线程相关事件#
data string | 事件 JSON 数据
服务端通过 data: 行返回事件 JSON。SSE 响应中可能没有 event: 行;这种情况下,客户端仍可按默认的 message 事件读取 data: 内容。
JSON 中的 type 字段表示具体的业务事件类型。
完整事件的公共字段包括 id、type 和 processed_at。session_thread_id 仅在对应事件结构中明确列出时返回,其他字段随 type 不同。
event string | SSE 事件类型
SSE 事件类型固定为 message。服务端不显式返回 event: 行时,SSE 客户端使用该默认值;业务事件类型从 data.type 读取