订阅 SSE 事件流
更新时间:2026-09-11
GET
https://api.dumate.cn/api/v1/sessions/{sessionId}/events/stream
本接口通过服务器发送事件(Server-Sent Events,SSE)订阅会话(Session)的实时事件,包含会话状态变化、消息创建更新和消息片段的增量输出。
权限说明
使用 API Key 鉴权调用 API 流程,具体调用流程,请查看认证鉴权。
请求参数
Headers 参数
除公共头域外,还包含以下特殊头域
Accept
string
固定值text/event-stream
可选
URL 参数
sessionId
string
会话(Session)标识,由创建会话接口返回。
必选
请求结构
GET /api/v1/sessions/{sessionId}/events/stream HTTP/1.1
Host: api.dumate.cn
Authorization: Bearer <YOUR_API_KEY>
Accept: text/event-stream
示例代码
请求示例
curl -N --location --request GET "https://api.dumate.cn/api/v1/sessions/ses_01ABC/events/stream" \
--header 'Authorization: Bearer <YOUR_API_KEY>' \
--header 'Accept: text/event-stream'
返回响应
Headers 参数
除公共头域外,无其它特殊头域
返回参数
type
string
事件类型。
可选
properties
object
事件属性。
不同事件类型的字段不同,详见下方事件类型说明。
可选
显示子属性
隐藏子属性
响应示例
data: {"type":"server.connected","properties":{}}
data: {"type":"session.status","properties":{"sessionID":"ses_01ABC","status":{"type":"busy"}}}
data: {"type":"message.updated","properties":{"info":{"id":"msg_01ABC","sessionID":"ses_01ABC","role":"assistant","time":{"created":1786000001000}}}}
data: {"type":"message.part.updated","properties":{"part":{"id":"prt_01ABC","sessionID":"ses_01ABC","messageID":"msg_01ABC","type":"text","text":""}}}
data: {"type":"message.part.delta","properties":{"sessionID":"ses_01ABC","messageID":"msg_01ABC","partID":"prt_01ABC","field":"text","delta":"本周有三项主要风险。"}}
data: {"type":"session.status","properties":{"sessionID":"ses_01ABC","status":{"type":"idle"}}}
常见事件类型
| 事件类型 | 说明 | 关键属性 |
|---|---|---|
server.connected |
SSE 连接已建立。 | properties |
session.status |
会话(Session)状态变化。 | sessionID、status.type |
message.updated |
消息创建或更新。 | info |
message.part.updated |
消息片段创建或更新。 | part |
message.part.delta |
消息片段的增量输出,根据对应part.type 区分 reasoning 和 text。 |
sessionID、messageID、partID、field、delta |
server.disposed |
事件流连接已关闭。 | reason |
message.part.delta 的 partID 对应 message.part.updated 中的 part.id。part.type 为 reasoning 表示思考片段,为 text 表示消息正文;仅将助手消息(role 为 assistant)的 text 片段作为对话结果。
评价此篇文章
