# API 参考


找到与你要做的事对应的那一行：它给出使用的接口、API Key 需要的权限，以及从哪一页开始。所有权限都在同一张表单里选择，见[创建和使用 API Key](/zh/api/api-auth)。

| 你要做的事 | 接口 | Key 权限 | 从这里开始 |
| --- | --- | --- | --- |
| 读取某项订阅已交付的记录 | HTTP 数据接口 `GET /v1/live/pull` | **Data**（数据） | [首次获取已授权数据](/zh/api/api-data) |
| 导出一个活动的全部交付记录 | `hb` CLI，版本需向组织管理员或 Humanbased 支持取得 | **Data** | [导出全部交付记录](/zh/api/cli#导出全部交付记录) |
| 用程序读取、创建或修改活动 | Campaign API，或 `hb` CLI | 读取用 `campaign:read`；创建和修改用 `campaign:author` | [Campaign API](/zh/api/campaign-api) |
| 用程序发布活动 | Campaign API 或 `hb` CLI，加上人在 Developer 门户的确认 | `campaign:launch`，并设有支出上限 | [发布活动](/zh/api/campaign-api#发布活动) |
| 把一次限定范围的读取交给外部智能体 | HTTP 数据接口，由智能体调用 | **Data**，范围缩小到一项订阅 | [通过智能体使用 Humanbased](/zh/api/agent-access) |
| 接入 MCP 客户端 | 组织提供的工具服务 | 该服务所调用接口的权限 | [MCP 可用范围](/zh/api/mcp) |

**Data** 授权与活动授权分开授予。读取交付记录的 Key 改不了活动；修改活动的 Key 要同时有 **Data**，才能读取订阅的记录。

工作进行中查阅的参考页：

- [读取交付记录：接口参考](/zh/api/api-fields)：数据接口每个参数和字段的含义，以及怎样做用量对账。
- [数据读取 API 错误处理](/zh/api/api-errors)：遇到某个状态或完全没有响应时，哪一步后续动作是安全的。
- [使用 Humanbased CLI](/zh/api/cli)：怎样取得版本、指向目标环境，并读懂退出码。

## 版本

每个路径都带有版本，例如 `/v1/live/pull` 或 `/api/v1/campaignapi/campaigns`。本文档覆盖 `/v1/live/*` 数据接口和 Campaign API。较早的 `/v1/data/*` 接口读取的是旧交付模型，不在本文档范围内；新的集成请使用 `/v1/live/*`。