面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/stream-events-api.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

流式获取会话事件

GET https://ark.cn-beijing.volces.com/api/v3/sessions/{session_id}/events/stream

通过 HTTP 长连接的 SSE(Server-Sent Events)协议订阅会话主线程收到的实时事件。所有事件的结构定义详情请参见 会话事件结构参考。

鉴权#

本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。

  • API Key 鉴权,请在 API Key 管理 页面,获取长效 API Key。

请求参数#

Path 参数#

session_id string 必选  |  会话 ID

填写要订阅事件的会话 ID,形如 sesn-...

Query 参数#

在 URL Query String 中传入。

event_deltas array  |  预览事件类型

指定需要通过 event_start 和 event_delta 接收预览内容的事件类型。当前支持 agent.message 和 agent.thinking。

未提供该参数时不返回预览帧。预览帧可能不完整,请以随后返回的完整事件为准。

响应参数#

流式响应(SSE)#

data string  |  事件 JSON 数据

服务端通过 data: 行返回事件 JSON。SSE 响应中可能没有 event: 行;这种情况下,客户端仍可按默认的 message 事件读取 data: 内容。

根据事件种类解析 type:

  • 完整事件顶层的 type 表示业务事件类型。
  • 预览帧顶层的 type 固定为 event_start 或 event_delta。其中,event_start.event.type 表示被预览的业务事件类型。

完整事件和每个预览帧均包含各自的 id、type 和 processed_at。预览帧还包含以下增量信息:

  • event_start.event 包含被预览事件的 id 和 type。
  • event_delta.delta 包含增量 type、content 和 index。

预览帧顶层 id 是当前帧的 ID;event_start.event.id 和 event_delta.event_id 指向被预览的完整事件。

预览帧可能不完整,最终以同一被预览事件 ID 的完整事件为准。

session_thread_id 不是公共字段,仅在对应事件结构中明确列出时返回。完整结构请参见 会话事件结构参考。