Overview

Basic Constraints

The GPTBots API is designed to conform to the HTTP and REST specifications. Query requests use the GET method and submission requests use the POST method. Requests using incorrect HTTP methods will result in an error.

Unless otherwise noted, request parameter values should be encoded as: UTF-8, URL encoded.

Bot API Authentication

The GPTBots REST API uses HTTP Basic Authentication for authentication. The basic approach is to add an Authorization header:

Authorization: Bearer ${apiKey}

Getting an API Key

Select the target bot and click Bot Edit to enter the BOT Settings page.

In the Bot Settings page, select the Bot API option, and click the "Enable" button for the API service to enable the Bot API interface service.

Click the "API Key" button, then click the "+ Create Key" button to create an Authorization for API requests. Developers can create dedicated keys for different developers.