跳转到正文
Docs
下载 Markdown
文章目录

API 参考

按要做的事选择接口,确认 Key 需要的权限,再从对应页面开始。

下载 Markdown

找到与你要做的事对应的那一行:它给出使用的接口、API Key 需要的权限,以及从哪一页开始。所有权限都在同一张表单里选择,见创建和使用 API Key。

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

Data 授权与活动Developer 组织的一组数据工作及其相关设置授权分开授予。读取交付记录的 Key 改不了活动;修改活动的 Key 要同时有 Data,才能读取订阅的记录。

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

版本

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