Quickstart Guide for GuideLite

Welcome to GuideLite's Quickstart Guide, designed to help you prepare for your first API call with ease.

Step 1: Account Setup

Step 2: Procure API Key

1. From your dashboard on the GuideLite app, click on the account located on the left panel

2. Select "Profile" from the dropdown menu.

   

3. Navigate to the API Keys tab and click on "Generate API Key" to create your unique API key.

   
   
   
   
   
   

❗️

Keep your API key secure as you won't be able to view it again unless you delete it and create a new key.

Step 3: Initiate API

Authentication for GuideLite's API is done via HTTP Basic Auth. You need to include your API key in the header of your requests.

For instance, to create a new project, use the POST - Create new project endpoint. Here's an example of sending an API request using CURL:

curl --request POST \
     --url https://api.guidelite.ai/external-api/v1/assistant/create \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <YOUR-APIKEY>' \
     --header 'content-type: application/json' \
     --data 
'{
  "assistantName": "TestAssistant",
  "assistantPurpose": "Customer Support",
  "assistantDescription": "An Assistant that responds to customer queries.",
  "modelName": "GPT 3.5",
  "sourceText": "Advanced technology shapes future innovations and enhances global connectivity.",
  "questionAnswerList": [
    {
      "question": "How does blockchain technology enhance data security?",
      "answer": "Blockchain secures data through decentralized, immutable transaction records."
    }
  ]
}'

❗️

Please ensure the security of your API key to prevent unauthorized access and maintain the confidentiality of your projects.

Congratulations! With GuideLite's API at your fingertips, you're ready to build your own customized solutions.