流式获取会话事件(SSE)
通过 Server-Sent Events 打开会话的实时事件流。
连接在事件到达期间保持打开,在客户端断开时结束。
每个帧包含:
event:事件的type,例如agent.messageid:恢复游标,可作为cursor或Last-Event-ID发送data:单行的完整 SessionEvent JSON
?cursor=now 仅接收将来的事件,流以一个携带恢复游标的 event: control 帧开始。会话尚无任何事件时,该游标为 0。服务器无法再提供的 cursor 会在流打开前失败,返回 400 invalid_parameter_error。以 : 开头的行必须忽略。流传输失败时发送一个最终的 event: error 帧,随后连接关闭。
下面的示例展示打开时的控制帧和一个事件帧(每个帧以一个空行结束):
event: control
id: 4096
data: {"cursor":"4096","reason":"tail"}
id: 4128
event: agent.message
data: {"id":"sevt_01","type":"agent.message","processed_at":"2026-01-01T00:00:00Z","data":{"content":[{"type":"text","text":"hi"}]}}
: hb
失败时的终止帧使用 event: error,错误体放在 data: 行上,随后流结束。
请求头
本次请求使用的 API 版本,格式为 YYYY-MM-DD。发送 2026-09-01-beta 即使用本文档所述版本。/v1/files* 之外必传:未携带请求头将被拒绝并返回 400 invalid_request_error;在 /v1/files* 上缺省时选择兼容行为。所有端点对未知取值均返回 400 invalid_request_error。
平台当前支持的 API 版本。新的日期版本发布时加入;版本在公告的 Sunset 日期后移除。
2026-09-01-beta 从上一个 SSE id: 帧之后恢复。两者同时设置时以 cursor 为准。
路径参数
会话 ID。
查询参数
从上一个 id: 帧之后恢复。now 表示只接收将来的事件。
响应
实时 Server-Sent Events 事件流,帧格式见本接口说明。
The response is of type string.