You need to enable JavaScript to run this app.
文档中心
火山方舟

火山方舟

复制全文
下载 pdf
会话事件
流式获取会话事件
复制全文
下载 pdf
流式获取会话事件
GET https://ark.cn-beijing.volces.com/api/v3/sessions/{session_id}/events/stream​
通过 HTTP 长连接的 SSE(Server-Sent Events)协议订阅会话主线程的事件。事件范围如下:​
  • 会话主线程的事件完整返回。​
  • 子 Agent 线程返回生命周期、协作消息、自定义工具调用和需要客户端处理的工具授权事件。​
  • 自托管 Environment 中需要宿主执行的内置工具调用也会返回。​
说明​
  • 线程相关事件通过 session_thread_id 标识所属线程。​
  • 自托管 Worker 按 Session 事件顺序执行内置工具调用,并按 tool_use_id 回传结果;不要依赖 session_thread_id 进行结果路由。​
  • 子 Agent 线程的思考、普通回复、Span 和预览帧不会返回,服务端生成的工具执行结果也不展开,需通过对应的 线程事件流 接收。客户端回传的工具结果和工具授权回复仍会返回,便于核对结果是否已送达。​
  • 本接口不支持断线续传。连接中断后,可通过 获取会话事件列表 查询中断期间产生的事件,再重新建立流式连接。​
  • 连接建立后先收到 : ready。服务端随后约每 15 秒发送一次 : heartbeat;服务实例退出前可能发送 : server draining, reconnect。这些以冒号开头的行均为 SSE 注释,客户端应忽略并将读取超时设置为至少两个心跳周期。​
  • 服务端通过 data: 行发送可解析的事件 JSON,可以省略显式 event: 行。连接通过 EOF、session.deleted 或客户端主动断开结束;业务处理是否完成以会话状态事件为准。​
所有事件的字段结构请参见 会话事件结构参考。​
鉴权​
本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。​
  • API Key 鉴权,请在 API Key 管理 页面,获取长效 API Key。​
​​
请求参数​
Path 参数​
session_id string 必选 | 会话 ID​
​
​
Query 参数​
在 URL Query String 中传入。​
event_deltas array | 预览事件类型​
​
​
响应参数​
流式响应(SSE)​
data string | 事件 JSON 数据​
​
​

Request

curl -sS --fail-with-body -N "https://ark.cn-beijing.volces.com/api/v3/sessions/<SESSION_ID>/events/stream" \
  -H "Authorization: Bearer $ARK_API_KEY" \
  -H "Accept: text/event-stream"

Response

: ready

: heartbeat

data: {"id":"sevt-20260926143025-a1b2c","type":"user.message","processed_at":"2026-09-26T14:30:25.123Z","session_id":"<SESSION_ID>","content":[{"type":"text","text":"帮我梳理 Q3 目标"}]}

data: {"id":"sevt-20260926143027-c3d4e","type":"agent.message","processed_at":"2026-09-26T14:30:27.045Z","session_thread_id":"<THREAD_ID>","content":[{"type":"text","text":"好的,我先按 OKR 分层梳理。"}]}

data: {"id":"sevt-20260926143029-e5f6a","type":"session.thread_status_idle","processed_at":"2026-09-26T14:30:29.180Z","agent_name":"<AGENT_NAME>","session_thread_id":"<THREAD_ID>","stop_reason":{"type":"end_turn"}}

data: {"id":"sevt-usg-sevt-20260926143029-e5f6g","type":"session.usage","processed_at":"2026-09-26T14:30:29.220Z","usage":{"active_seconds":147.661,"cache_creation":{"ephemeral_1h_input_tokens":0,"ephemeral_5m_input_tokens":0},"cache_read_input_tokens":271227,"input_tokens":34,"output_tokens":7774,"server_tool_use":{"web_fetch_requests":0,"web_search_requests":2,"general_search_requests":1,"visual_search_requests":1}}}

data: {"id":"sevt-20260926143029-e5f6g","type":"session.status_idle","processed_at":"2026-09-26T14:30:29.220Z","stop_reason":{"type":"end_turn"}}
最近更新时间:2026.11.04 18:12:41
这个页面对您有帮助吗?
有用
有用
无用
无用