概述
概述
Postman
Postman 是一款功能强大的 API 开发和测试工具。它能让您轻松创建、管理和测试 API。GPTBots 提供了 Postman 集合，方便您进行 API 测试。
GPTBots Postman 集合
基本约束
GPTBots API 被设计为符合 HTTP 和 REST 规范，查询请求使用 GET 方法，提交请求使用 POST 方法。如果一个请求不是相应的 HTTP 方法，将返回错误。
如无特殊说明，调用参数值应转码为：UTF-8， URL 编码。
鉴权方式
GPTBots REST API 采用 HTTP 基本认证，在 HTTP Header 里加 Authorization：
Authorization: Bearer ${apiKey}
Authorization: Bearer ${apiKey}
此代码块在浮窗中显示
API 启用
- 启用 API 服务，需要先在 GPTBots 后台，找到「Agent 集成」，选择"开发-API服务"，点击「启用」按钮即可启用API服务。
- 启用 API 服务后，点击「API」卡片进入 API 管理页面，点击「创建APIKey」按钮，完成创建 APIKey 既可用于调用 GPTBots 相关 API。
API 列表
GPTBots 平台为了满足开发者业务需求，提供了丰富的 API 接口，开发者可以根据自己的需求选择合适的 API 接口进行调用。API 接口分类如下：
| API分类 | 接口描述 |
|---|---|
| Conversation API | 通过该 API 与 Agent 进行交互对话。 |
| Workflow API | 通过该 API 与 workflow 进行请求/响应。 |
| Knowldege API | 通过该 API 管理 GPTBots 平台的知识库 |
| Database API | 通过该 API 管理 GPTBots 平台的数据库。 |
| Models API | 通过该 API 调用 GPTBots 平台的各类模型能力。 |
| User API | 通过该 API 设置用户信息、用户属性和联系方式等。 |
| Analytics API | 通过该 API 可查询积分和Tokens的使用数据。 |
| Account API | 通过该 API 可获取该账号下的 Agent、组织等信息 |
API 调用频率
GPTBots 平台对 API 调用频率有限制，不同分类的API的频率限制各不相同。如果超过该限制，将返回超频提示消息。具体的限制数值
- Free Plan ：所有类型的 API 默认限制为 3 次/分钟。
- 企业定制 Plan ：可以联系 GPTBots 商务人员，获取定制的 API 调用频率权益。