API

This section of our Docs explains how to interact with our 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.

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
Authorization	Bearer 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.

Rate limiting

All requests to BoostGPT, except for engaging the chatbot (i.e. the "bot/chat" endpoint), are rate limited.

API Reference

Take a dive into our API reference to discover the ins and outs of interacting with our API.

Intelligent Chatbot API, tailored to your dataBoostGPT API

Official Libraries

These libraries serve as reliable resources to facilitate your integration process and streamline your experience with our service.

Official Libraries

Playground

Looking to experiment with BoostGPT without writing any code? We've got an easy-to-use playground for you!

Playground