面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/send-event-api.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

发送会话事件

POST https://ark.cn-beijing.volces.com/api/v3/sessions/{session_id}/events

向指定会话发送用户侧事件。

需要实时接收智能体输出和状态变化时,创建会话后先建立 流式事件连接,再调用本接口发送事件。无需实时接收时,可在发送后通过 获取会话事件列表 查询结果。

接口成功响应仅表示事件已受理,不表示本轮处理完成。事件字段结构请参见 会话事件结构参考。

鉴权#

本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。

  • API Key 鉴权,请在 API Key 管理 页面,获取长效 API Key。

请求参数#

Path 参数#

session_id string 必选  |  会话 ID

填写要接收事件的会话 ID,形如 sesn-...

Body 参数#

events object[] 必选  |  事件列表

要发送的用户侧事件列表,至少包含 1 条事件。每个事件对象至少包含 type 字段,其余字段随事件类型不同而变化。

支持的事件类型、字段结构和批次顺序请参见 会话事件结构参考。

type string 必选  |  事件类型

events.type

事件类型标识符。支持的取值及对应字段结构详见 会话事件结构参考。

响应参数#

data object[]  |  已接收事件列表

服务端已受理的事件列表,与请求中的 events 一一对应。每个元素的字段随 type 变化,详情请参见 会话事件结构参考。

接口成功响应仅表示事件已受理,不表示本轮处理完成。可通过 流式获取会话事件 实时接收结果,或通过 获取会话事件列表 查询已经产生的事件。

type string  |  事件类型

data.type

事件类型,与请求中传入的 type 一致,如 user.message

id string  |  事件 ID

data.id

回执中的事件 ID。服务端会为未提供 ID 的用户事件生成形如 sevt-... 的 ID;system.message 等事件可能返回空字符串,最终事件 ID 以事件列表或流式事件为准