> ## Documentation Index
> Fetch the complete documentation index at: https://docs.veadk.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# API 概览

HTTP API 参考按服务分为 Agent API Server 和 Harness Runtime。先选择实际部署的服务，再查看对应接口的参数、响应和调用示例

| 服务 | 适用场景 | 参考 |
| - | - | - |
| Agent API Server | 调用已加载的智能体，管理应用、会话、制品和记忆；开发服务另提供评测与调试接口 | [Agent API Server 接口](https://docs.veadk.xyz/productions/api-reference/preview/zh/agent-api-server/overview.md) |
| Harness Runtime | 调用 Harness，在请求中配置模型、工具和技能等执行选项，管理会话，以及管理已启用的定时任务 | [Harness Runtime 接口](https://docs.veadk.xyz/productions/api-reference/preview/zh/harness-runtime/overview.md) |

两类服务可能使用相同路径，但请求字段、默认行为和认证条件需以对应服务的接口说明为准。每个接口页分别展示路径、查询、请求头和请求体参数，以及响应结构与示例

## 准备调用

1. 确认服务类型。使用 `adk api_server` 或 `veadk web` 时查看 Agent API Server；使用 `agentkit harness deploy` 部署时查看 Harness Runtime
2. 按对应服务概述确认版本、访问地址和认证条件。本地示例地址指向开发服务，调用云端服务时需替换为部署结果中的地址
3. 确认应用、用户和会话标识。需要已有会话的接口，应先创建会话再执行调用；具体顺序见对应服务概述

模型 API Key 用于模型调用，不能直接作为应用服务的访问凭证。网关、Runtime API Key 或用户登录令牌应按实际部署方式提供

## 发送请求

> [!WARNING]
>
> 在线调试面板会发送真实请求。创建、更新、删除、运行智能体和评测会作用于当前选定的服务；先核对服务地址和资源标识。运行智能体及云端资源可能产生费用，删除或替换操作会修改实际数据

接口页提供 cURL、Python 和 JavaScript 示例，以及请求参数与响应结构。填写当前部署地址和所需认证信息后发送请求；在线调试还需满足目标服务的网络连通性和跨域配置

## 判断调用结果

* 普通 HTTP 接口：按接口页检查响应状态码和响应体，确认返回内容对应预期的应用或资源
* 流式接口：返回 `text/event-stream`，需持续读取事件。cURL 示例中的 `-N` 关闭输出缓冲；不要把事件流当作一次性 JSON 响应
* Harness 调用：还需检查响应或流中的错误信息，HTTP 200 本身不代表智能体执行成功。具体行为见[Harness Runtime 概述](https://docs.veadk.xyz/productions/api-reference/preview/zh/harness-runtime/overview.md)

在线调试面板不保证逐事件显示流式结果，需要观察实时事件时使用对应接口的流式调用示例


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.