Session & Event

Subscribe to Event Stream

Subscribe to session events in real time via SSE

GET

/api/v1/agentstudio/sessions/{session_id}/events/stream

cURL

curl --request GET \
  --url 'https://{workspace_id}.{region}.maas.aliyuncs.com/api/v1/agentstudio/sessions/{session_id}/events/stream' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Accept: text/event-stream'

{
  "object": "message",
  "id": "msg_001",
  "created_at": "2025-10-24T08:15:30.500Z",
  "role": "assistant",
  "type": "message",
  "status": "completed",
  "sequence_number": 0,
  "content": [
    {
      "type": "text",
      "text": "开始分析"
    }
  ]
}

Authorizations

string

header

required

DashScope API Key

Header Parameters

enum<string>

required

固定为 text/event-stream

Available options:text/event-stream

Path Parameters

string

required

Response

200-text/event-stream

普通事件

string

恒为 message

string

事件 ID（前缀 msg_ 或 out_）。客户端用此 ID 在业务层去重

string

ISO 8601 时间戳

enum<string>

Available options:user,assistant,tool

enum<string>

服务端推送事件类型：message（助手输出消息，可流式分块，按 sequence_number 累加）；tool_call（内置工具调用请求）；tool_call_output（内置工具执行结果）；tool_approval_request（工具审批请求，当工具需要审批时单独发送一次，data 携带 batch_id、call_id、name、arguments、tool_type，是否需要审批以本事件为准）；tool_approval_response（工具审批裁决，双向事件：客户端上行提交裁决，服务端也会下行补发——requires_action 下发送纯 interrupt 时，服务端为批次内每个尚未执行的调用（含已裁决但因批次未收齐而未执行的调用）补发 result=deny 并伴随对应 *_call_output（is_error=true），该配对仅用于展示与审计、尽力而为，待审批集合仍以 pending_call_ids 为准）；function_call（自托管函数调用请求，需客户端回填 function_call_output）；function_call_output（服务端确认收到的函数结果回显）；mcp_call（MCP 工具调用请求）；mcp_call_output（MCP 工具执行结果）；session_status（会话状态变更，含 stop_reason）。type=error 见独立分支

Available options:message,tool_call,tool_call_output,tool_approval_request,tool_approval_response,function_call,function_call_output,mcp_call,mcp_call_output,session_status

string

number | null

流式分块序号

object[]

ContentBlock 数组，结构同发送侧

boolean

仅工具输出事件（tool_call_output / mcp_call_output）出现，写在 Message 顶层（不在 content[].data 内）：true 表示该次工具执行失败或被中断/拒绝；此时 data 仍为 ToolCallOutput / McpCallOutput，至少含 call_id 与 output。客户端应读取顶层 is_error 判断成败，读取 data.output 取输出

object

事件附加信息（如 thread_id、call_id 等）

cURL

curl --request GET \
  --url 'https://{workspace_id}.{region}.maas.aliyuncs.com/api/v1/agentstudio/sessions/{session_id}/events/stream' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Accept: text/event-stream'

{
  "object": "message",
  "id": "msg_001",
  "created_at": "2025-10-24T08:15:30.500Z",
  "role": "assistant",
  "type": "message",
  "status": "completed",
  "sequence_number": 0,
  "content": [
    {
      "type": "text",
      "text": "开始分析"
    }
  ]
}