Skip to main content

列出 Event

分页查询会话历史事件,返回结构同 SSE 帧的 data。支持时间窗口过滤与排序。

前提

已创建会话,详见创建 Session。{session_id} 形如 sesn_xxx...。

接口

GET /sessions/{session_id}/events 返回结构同 SSE 帧的 data。事件信封字段含义详见订阅 Event SSE 事件流中的事件信封一节。

Query 参数

参数类型默认说明
typesstring—按事件类型过滤,可重复传入。如 ?types=message&types=tool_approval_request。用 types=error 补拉运行期错误
orderstringasc排序方向:asc(升序) / desc(降序)
created_at[gt] / [gte] / [lt] / [lte]string—按时间窗口过滤,ISO 8601;四个比较运算符可组合
limitint20每页数量,最大 100
pagestring—首次不传,后续传上一次响应的 next_page

请求示例

curl "$AGENTSTUDIO_URL/sessions/sesn_xxx/events?order=asc&limit=100" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"

响应说明

返回 data(事件 Message 对象数组,结构同 SSE 帧的 data 字段,详见订阅 Event SSE 事件流)、next_page(下一页游标,无更多数据时不返回或为 null)与 request_id。type=error 为独立分支:错误详情位于 Message 顶层的 error 对象(error.code / error.message),不在 content[].data 中。Message 对象字段如下:

响应字段

字段类型说明
dataarray<object>事件 Message 对象数组,按 order 排序
data[].objectstring恒为 message
data[].idstring事件 ID,前缀 msg_ 或 out_
data[].created_atstring事件时间戳,ISO 8601
data[].statusstring恒为 completed
data[].rolestringuser / assistant / tool
data[].typestring事件类型,取值同 SSE 服务端推送事件,详见订阅 Event SSE 事件流
data[].contentarray<object>ContentBlock 数组,结构同发送侧
data[].is_errorbool仅工具输出事件(tool_call_output / mcp_call_output)出现,写在 Message 顶层:true 表示该次工具执行失败或被中断 / 拒绝;此时 data 仍为 ToolCallOutput / McpCallOutput,至少含 call_id 与 output
data[].metadataobject事件附加信息(如 thread_id、call_id 等)
next_pagestring / null下一页游标;无更多数据时不返回或为 null
request_idstring本次请求的唯一标识
Flow Agent API
Sandbox API
RAG API
长期记忆
ParseX API
Security API
框架集成
Assistant API(下线中)