SiteGPT Docs

API Reference

Create Your Chatbot Now

Support

Want to ensure that SiteGPT is the perfect fit? Take a [live demo]() to see for yourself!

Live Demo

Take a Live Demo of SiteGPT

An overview of what to expect from this guide. Click on the section you want to go to for quick-access!

What this guide contains

An in-depth look at the AI-powered chatbot tool, SiteGPT, designed for website integration.

What is SiteGPT

Introduction to SiteGPT

Our Use-cases

SiteGPT's use-cases

These help you control the chatbot behaviour including sticking to its knowledge base.

Prompts/Personas

Prompts & Personas

You can query real-time data and execute tasks directly from within the chatbot using Functions.

Functions

Allows you to override AI responses for key questions or topics like “what is the pricing for the enterprise plan?”

Questions and Answers

Add Quick Prompts

A guide on setting up your SiteGPT chatbot.

Setup

Setting up SiteGPT

Create New Chatbot

Creating a New Chatbot

Training on your Data

Training your Chatbot on your Data

Integrating with your Website

Integrating your SiteGPT Chatbot with your Website

Retraining your AI Chatbot

Retraining and Updating your AI Chatbot

An in-depth guide on how to use $sitegpt to control the SiteGPT chatbot from your javascript code.

$sitegpt Methods

Your profile on SiteGPT is the account you use to make chatbots, and this is where you can access it.

Profile

Chatbots

This is where you can view your current plan, billing details and edit your payment settings.

Billing

Plans & Billing

You can also monitor your account usage, view your current plan and edit payment settings from here.

Usage

You can check out the latest updates and posts here.

Changelog

When you click on your chatbot from your profile, it launches the dashboard. This gives you a deep dive into your selected chatbot.

Chatboard Dashboard

Chatbot Dashboard

You can check the entire chat history of your chatbot from here.

Chat History

Once your chatbot starts lead generation, it will show up here.

Leads

The training material is referred to as *Content* to OpenAI. Hence, please reference it in your prompts.

Add Content to SiteGPT

Adding Content to your Chatbot

You can customize the appearance, prompts, personas, chat modes and more from the `Customizations` section on the right-hand menu.

Customize your Chatbot

Customizing your Chatbot

You can access the advanced functionalities and settings under the `Advanced` header on the right-side menu.

Advanced

You can change general and advanced settings from here.

Settings

You can delete a particular chatbot if you wish to. Follow these steps to learn how.

Delete Chatbot

Delete your SiteGPT Chatbot

Using Functions

How do Functions work?

Overview

Elevate Your Website Experience with SiteGPT

Learn the basics of making requests to SiteGPT API.

Getting Started

Getting Started with SiteGPT API

Fetch All Chatbots

Create Chatbot

Fetch Chatbot

Update Chatbot Appearance

Modify (Add/Update) custom content of the chatbot

Modify Chatbot Custom Content

Fetch all the follow up prompts of a particular chatbot

Fetch All Follow Up Prompts

Add a new follow-up prompt to a particular chatbot

Add Follow Up Prompt

Fetch Follow Up Prompt

Delete Follow Up Prompt

Update Follow Up Prompt

Add or Update the chatbot icons (Bot Icon, Person Icon, Agent Icon, Watermark Icon, Chat Bubble Icon)

Update Chatbot Icons

Delete Chatbot Icons

Fetch all the internal links of a source URL

Fetch Links

Add Links to Chatbot

Send message to a particular thread or start a new thread

Send Message

Update message that belongs to a particular thread. You can only add reaction to the message for now.

Update Message

Fetch All Chatbot Personas

Add Chatbot Persona

Fetch Chatbot Persona

Update Chatbot Persona

Delete Chatbot Persona

Assign Persona to Chatbot

Fetch All Chatbot Prompts

Add Chatbot Prompt

Fetch Chatbot Prompt

Update Chatbot Prompt

Delete Chatbot Prompt

Assign Prompt to Chatbot

Fetch all quick prompts of a particular chatbot

Fetch All Quick Prompts

Add a new Quick Prompt to a particular chatbot.

Add Quick Prompt

Fetch Quick Prompt

Delete Quick Prompt

Update Quick Prompt

Update Chatbot Settings - Advanced

Update Chatbot Settings - Chat Mode

Update Chatbot Settings - General

Update localization settings of the chatbot

Update Chatbot Settings - Localization

Update Chatbot Settings - User Data

Create Thread

Fetch All Threads

Fetch Thread

Update thread of the chatbot.
The following thread properties can be updated.
1. Mode
2. Webhook url
3. Webhook token
4. Chat User details

Update Thread

Escalate a particular thread/conversation

Escalate Conversation

Fetch Whitelabel Brands

Fetch Whitelabel Brand

Add a new user to your whitelabel brand.

Pre-requisities: 
1. You have to be a whitelabel customer in SiteGPT.
2. You need to create and configure your own brand in SiteGPT dashboard.

Add Whitelabel User

Fetch an user of your whitelabel brand.

Pre-requisities: 
1. You have to be a whitelabel customer in SiteGPT.
2. You need to create and configure your own brand in SiteGPT dashboard.

Fetch Whitelabel User

Update user of your whitelabel brand.

Pre-requisities: 
1. You have to be a whitelabel customer in SiteGPT.
2. You need to create and configure your own brand in SiteGPT dashboard.

Update Whitelabel User

Generate API key for a user of your whitelabel brand.

Pre-requisities: 
1. You have to be a whitelabel customer in SiteGPT.
2. You need to create and configure your own brand in SiteGPT dashboard.

Getting Started

Features you can't miss

Setting up SiteGPT

Chatbot SDK

Navigating your Account

Navigating your Chatbot

Get Started

Take a Live Demo of SiteGPT