πŸƒβ€β™€οΈ Set of instructions designed to help users get started with customGPT quickly and easily.

πŸ‘

TL;DR: Don't like reading documentation? Jump straight into our cookbooks on github.

This quickstart guide aims to facilitate the process of getting started with customGPT, including the steps of generating an account, acquiring an API key, and making the first API call.


Step 1: Generate an account

To use the customGPT website, you'll need to sign up for an account.

  1. Open the customGPT website for signing up by clicking here
  2. Click on the "Create an Account" button.
  1. Enter your Name, Email address, and Password to create your account.

πŸ™Š

Shh-pas-sword

It is important to keep your password private and not share it with anyone.

  1. Click on the "Sign Up" button.

Now you are ready to create your first project βœ…


Step 2: Acquiring the API key

  1. Select "My Profile" option from the dropdown menu that appears when you click on the circle in the top right corner of the project dashboard.
  1. Choose the "API" option.
  1. Click the "Change API Key" button to generate a new API Key.
  1. Select the "Change API key" button.
  1. The API key is successfully generated. You can use it to make the API call.

🚧

Warning

Please ensure to keep your API key secure and confidential to prevent unauthorized access and potential security breaches.


Step 3: Making the first API call

Authentication to the API is performed via HTTP Basic Auth. To authenticate with CustomGPT API endpoints, you must provide the API Key in the header, as shown below.

'authorization: Bearer Your_API_KEY' 

For example, you will use the POST - Create new project endpoint to create a new project. In this scenario, you can send an API request by adding your API Key in the Authentication header as shown below:

curl --request POST \
     --url http://127.0.0.1:8000/api/v1/projects \
     --header 'accept: application/json' \
     --header 'authorization: Bearer Your_API_KEY' \
     --header 'content-type: application/json' \
     --data '
{
  "project_name": "projectname",
  "sitemap_path": "https://example.com/sitemap.xml"
}
'