Skip to main content

Session & Event

会话与事件 API 提供会话生命周期管理、消息发送与 SSE 事件流订阅。

创建 Session

POST /sessions

请求体

字段必填类型说明
agent是string智能体 ID
environment_id是string运行环境 ID
title否string会话标题
resources否array<object>挂载资源列表，每项含 type（file）、file_id、mount_path
vault_id否string凭证库 ID
metadata否object业务自定义键值

请求示例

curl -X POST "$AGENTSTUDIO_URL/sessions" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent": "agent_xxx",
    "environment_id": "env_xxx",
    "title": "Q3 销售数据分析",
    "resources": [
      {"type": "file", "file_id": "file_xxx", "mount_path": "/workspace/data.csv"}
    ]
  }'

获取 Session

GET /sessions/{session_id}

列出 Session

GET /sessions 分页列出工作空间下的会话。

更新 Session

PATCH /sessions/{session_id} 更新会话元数据，如重命名。

删除 Session

DELETE /sessions/{session_id} 硬删除，会话元数据、事件历史、资源副本全部清除，不可恢复。

归档 Session

POST /sessions/{session_id}/archive 会话状态变为 terminated，事件历史保留可查。

发送 Event

POST /sessions/{session_id}/events 向会话写入用户消息，触发智能体处理。

请求体

字段必填类型说明
input是array<object>事件列表，每项含 role（user）、type（message）、content（内容块数组）

请求示例

curl -X POST "$AGENTSTUDIO_URL/sessions/sesn_xxx/events" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input": [
      {
        "role": "user",
        "type": "message",
        "content": [
          {"type": "text", "text": "分析 /mnt/session/uploads/sales.csv 中 Q3 的销售趋势"}
        ]
      }
    ]
  }'

订阅 Event SSE 事件流

GET /sessions/{session_id}/events/stream 设置 Accept: text/event-stream 请求头，响应以 SSE 格式实时推送事件。

请求示例

curl -N "$AGENTSTUDIO_URL/sessions/sesn_xxx/events/stream" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Accept: text/event-stream"

列出 Event

GET /sessions/{session_id}/events 不设置 Accept: text/event-stream 时，返回已有事件的完整列表（可用于轮询增量）。
概览
构建 Agent
配置环境
委派任务
上下文管理
更新日志