Overview
Postman
Postman is a powerful tool for API development and testing. It allows you to create, manage, and test APIs with ease. GPTBots provides Postman collections for easy API testing.
GPTBots Postman Collections
Basic Constraints
The GPTBots API is designed to comply with HTTP and REST specifications. Query requests use the GET method, while submission requests use the POST method. An error will be returned if a request does not use the appropriate HTTP method.
Unless otherwise specified, parameter values should be encoded in UTF-8 with URL encoding.
Authentication
GPTBots REST API uses HTTP Basic Authentication. Add the following Authorization header:
Authorization: Bearer {apiKey}
API Activation
- To enable the API service, go to the GPTBots dashboard, navigate to "Agent Integration", select "Development-API Service", and click the "Enable" button to activate the API service.
- After enabling the API service, click on the "API" card to enter the API management page. Click the "Create APIKey" button to generate an APIKey that can be used to call GPTBots APIs.
API List
GPTBots platform provides a comprehensive set of API interfaces to meet developers' business needs. Developers can choose suitable APIs based on their requirements. The API categories are as follows:
| API Category | Description |
|---|---|
| Conversation API | Interact and converse with Agents through this API. |
| Workflow API | Send requests and receive responses from workflows through this API. |
| Knowledge API | Manage knowledge bases on the GPTBots platform through this API. |
| Database API | Manage databases on the GPTBots platform through this API. |
| Models API | Access various model capabilities of the GPTBots platform through this API. |
| User API | Configure user information, attributes, and contact details through this API. |
| Analytics API | Query usage data for credits and tokens through this API. |
| Account API | Retrieve information about Agents, organizations, etc. under the account through this API. |
API Rate Limits
The GPTBots platform implements rate limits for API calls, with different limits for different API categories. Exceeding these limits will result in a rate limit exceeded message. The specific limits are:
- Free Plan: All API types are limited to 3 requests per minute by default.
- Enterprise Custom Plan: Contact GPTBots business representatives to obtain customized API rate limit privileges.