VolcengineVolcengine ADK

API 服务接口

API Server 模式运行时,智能体对外暴露一组标准 HTTP 接口,用于管理会话并运行智能体(支持流式)。本地用 veadk web 启动,生产环境通过 VeADK Web 模式部署(接口相同,由 API 网关统一鉴权)。

veadk web              # 本地启动,默认 http://localhost:8000

接口默认无鉴权,仅用于本地开发。对外暴露时请加 SSO / 入站认证

接口一览

方法路径说明
GET/list-apps列出可用的智能体应用
POST/apps/{app}/users/{user}/sessions新建会话(自动生成 ID)
POST/apps/{app}/users/{user}/sessions/{session}以指定 ID 新建会话
GET/apps/{app}/users/{user}/sessions列出会话
GET/apps/{app}/users/{user}/sessions/{session}获取会话(含历史事件)
DELETE/apps/{app}/users/{user}/sessions/{session}删除会话
POST/run运行智能体,一次性返回事件列表
POST/run_sse运行智能体,以 SSE 流式返回事件
GET/apps/{app}/users/{user}/sessions/{session}/artifacts列出产物(artifacts)
GET/health/version健康检查与版本

{app} 为智能体应用名(即 --agents-dir 下的子目录名)。

运行智能体

先创建会话,再运行。/run_sseSSE 流式返回事件,适合实时展示;/run 一次性返回全部事件。

创建会话

curl -X POST http://localhost:8000/apps/my_agent/users/u1/sessions \
  -H 'Content-Type: application/json' -d '{}'
# 返回的 JSON 中包含 id 字段,即 sessionId

运行并流式接收

curl -N -X POST http://localhost:8000/run_sse \
  -H 'Content-Type: application/json' \
  -d '{
    "appName": "my_agent",
    "userId": "u1",
    "sessionId": "<上一步返回的 id>",
    "newMessage": { "role": "user", "parts": [{ "text": "你好" }] },
    "streaming": true
  }'

响应是一串 SSE 事件,每个 data: 是一个智能体事件(模型增量、工具调用、最终回复等):

data: {"content":{"role":"model","parts":[{"text":"你"}]}, ...}
data: {"content":{"role":"model","parts":[{"text":"好"}]}, ...}

请求体字段:

字段类型说明
appNamestring智能体应用名
userIdstring用户 ID
sessionIdstring会话 ID
newMessageContent本轮用户消息:{ "role": "user", "parts": [{ "text": "..." }] }
streamingbool是否在模型层开启增量流式(默认 false

生产环境推荐用 CloudApp 通过 A2A 协议调用已部署的智能体,无需手写上述 HTTP 请求。

本页导航