Public
Documentation Settings

BoostGPT API

Start by creating a project in BoostGPT, which will provide you with a dedicated workspace for each of your applications. Within each project, you can create and train multiple chatbots. You will need an Openai key to be able to create a project.

To begin, create your initial project and copy its ID. Go to the project settings to copy your project ID or go here: https://app.boostgpt.co/settings. Use your project ID in your requests when interacting with our API.

Authentication

To authenticate requests in the BoostGPT API, you will need to use a specific key. This key can be obtained from the "API Key Page" and must be passed in the request headers. Once you have done so, follow the endpoint processes as required. If you don't have an api key, get it from https://app.boostgpt.co/account/api-keys

Request Headers
AuthorizationBearer YOUR-API-KEY

Errors

All successful responses are returned with HTTP Status code 204. In case of failure, API returns a JSON error response with the parameters that contain the failure reason.

Bot

Create and manage all your AI bots

Sources

Train your AI bot with your data

POSThttps://api.boostgpt.co/v1/bot/source/create

https://api.boostgpt.co/v1/bot/source/create

Adds a new data source to your bot

Request body
project_idStringRequired
bot_idStringRequired
tagsArrayOptional

Segment the training data using only tags that contain uppercase and lowercase letters (A-Z, a-z), numeric digits (0-9), underscores (_), hyphens (-), and hash symbols (#). Exclude any tags with other characters
typeStringRequire any of : text, file, webpage, website
sourceString/ArrayRequire your text content or an accessible link to your file, webpage, or website

The source can be an array of link(s) you want your bot to learn when you set the "type" to webpage or file.
HEADERS
Authorization

Bearer 8a79d8c2-e018-11ed-b5a3-33d8a09a24e3

Bodyraw (json)
json
{
    "project_id": "13c8cc4a-ddef-11ed-b5a3-33d8a09a24e3",
    "bot_id": "8e9124a2-e0a3-11ed-b5a3-33d8a09a24e3",
    "tags": [],
    "type": "text",
    "source": "YOUR SOURCE DATA"
}
Example Request
curl
curl --location 'https://api.boostgpt.co/v1/bot/source/create' \
--header 'Authorization: Bearer 8a79d8c2-e018-11ed-b5a3-33d8a09a24e3' \
--data '{
    "project_id": "13c8cc4a-ddef-11ed-b5a3-33d8a09a24e3",
    "bot_id": "8e9124a2-e0a3-11ed-b5a3-33d8a09a24e3",
    "tags": [],
    "type": "text",
    "source": "YOUR SOURCE DATA"
}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers