Skip to content

REST API 参考

本页提供了 ADK 网络服务器提供的 REST API 的参考。 有关在实践中使用 ADK REST API 的详细信息，请参阅使用 ADK API 服务器。

提示

你可以通过浏览运行中的 ADK Web 服务器上的 /docs 位置来查看更新后的 API 参考，例如在：http://localhost:8000/docs

端点

/run

此端点执行智能体运行。它接受包含运行详细信息的 JSON 负载，并返回运行期间生成的事件列表。

请求体

请求体应该是一个具有以下字段的 JSON 对象：

  • app_name（字符串，必需）：要运行的智能体名称。
  • user_id（字符串，必需）：用户 ID。
  • session_id（字符串，必需）：会话 ID。
  • new_message（Content，必需）：发送给智能体的新消息。有关更多详细信息，请参阅 Content 部分。
  • streaming（布尔值，可选）：是否使用流式传输。默认为 false。
  • state_delta（对象，可选）：在运行前应用的状态增量。

响应体

响应体是 Event 对象的 JSON 数组。

/run_sse

此端点使用服务器发送事件（SSE）执行智能体运行以进行流式响应。它接受与 /run 端点相同的 JSON 负载。

请求体

请求体与 /run 端点相同。

响应体

响应是服务器发送事件的流。每个事件都是一个表示 Event 的 JSON 对象。

对象

Content 对象

Content 对象表示消息的内容。它具有以下结构：

{
  "parts": [
    {
      "text": "..."
    }
  ],
  "role": "..."
}
  • parts：部分列表。每个部分可以是文本或函数调用。
  • role：消息作者的角色（例如，"user"、"model"）。

Event 对象

Event 对象表示智能体运行期间发生的事件。它具有复杂的结构，包含许多可选字段。最重要的字段是：

  • id：事件的 ID。
  • timestamp：事件的时间戳。
  • author：事件的作者。
  • content：事件的内容。