Retrieve the Open Graph data for a citation

project_id

citation_id

Retrieve all conversations associated with a project

The ID of the project to get the conversations for

page

The order to sort the results in given direction. Defaults to desc

order

The orderBy to sort the results by given field. Defaults to id

orderBy

Filter the results by the user that created the conversation. Defaults to all

userFilter

name

session_id

Retrieve all messages sent within a conversation of a project

The ID of the project to get the messages for

The session ID of the converstaions to get the messages for

Defaults to desc. The order to sort the results by

Retrieve messages that have been sent in a conversation

Send a message to a conversation within a project

Whether to stream the response or not, if stream the responses will be sent as data-only server-sent events as they become available, with the stream terminated by a status: 'finish' message. Example Python code.

stream

Defaults to en. The language to use for the prompt

lang

external_id

Chatbot model to use for the conversation

Custom persona to use for the conversation

Defaults to default. By default, we ask ChatGPT to use only your content in its response (recommended). If you wish ChatGPT to improvise and use its own knowledgebase as well, you can set this to 'openai_content'.

Retrieve a list of all pages associated with a project

The duration of the projects to list. Defaults to 90 days.

duration

The order of the projects to list. Defaults to desc.

page_id

Delete a certain page that belongs to a certain project

Reindex a certain page that belongs to a certain project

The id of a project in which page is stored

The id of a page in which metadata will be updated

The description of the page used in citations

Retrieve the plugin details associated with a project

Create a new plugin for a specific project

The id of a project in which plugin will be stored

Whether the project plugin is active or not

Update the plugin configuration for a specific project

Retrieve the project settings for a specific project

Update the project settings for a specific project

This is the avatar that is shown in the bot response. You can make it a profile picture or your company logo.

This is the background image shown in the bot conversations widget. You can change it to a company logo or background image.

This is the model used by the chatbot. You can choose a different model to suit your needs.

By default, the chatbot messages like 'Ask Me Anything' are in English. You can customize this to your preferred language. Please note: This setting does not control what language ChatGPT responds in. That is controlled by the user's question. So a user asking in Portuguese, will most likely get a response from ChatGPT in Portuguese.

This is the message shown when the bot has encountered a problem or error. You can customize this message based on your tone, personality or language.

Color of the chatbot toolbar in hex format

This is the message shown to indicate where the response came from. You can customize this message based on your business or language.

This is the message shown for the Sources label. You can customize this message based on your business or language.

Defaults to user. Control how citations are shown. By default, the user can initiate to see the citations. You can choose to have it 'Auto Shown' or 'Auto Hide' 

This is the default prompt shown to the user. You can customize this for your company or client.

Defaults to true. Each chatbot response shows an option for the user to see the sources/citations from your content from which the response was generated.

Should we check messages from guests with Recaptcha when your chatbot is publicly available (i.e. shared or embedded).

You can instruct ChatGPT to end every response with some text like asking 'Please email us for further support' (Not recommended for most use cases)

These are example questions shown to guide the bot users. You can create customized questions to suit your company or client needs.

This is the message shown when the bot is thinking and waiting to answer. You can customize this message based on your tone, personality or language.

Defaults to true. Show animated loading indicator while waiting for a response from the chatbot.

Enable selling of chatbot for monetization

This is the message shown when the bot cannot answer. You can customize it to a message asking the user to contact customer support or leave their email / phone.

Customize your chatbot behavior by adjusting the system parameter to control its personality traits and role.

Controls what branding is shown at the bottom of the chatbot.

By default, we ask ChatGPT to use only your content in its response (recommended). If you wish ChatGPT to improvise and use its own knowledgebase as well, you can select 'My Content + ChatGPT' 

The order of the projects to list. Defaults to desc

The width of the embed code. Defaults to 100%

width

The height of the embed code. Defaults to auto

height

Create a new project by importing data either from a sitemap or an uploaded file

Create a copy of project by replicating project info, settings, sitemap sources and uploaded files

Provide summary of various metrics of users interactions with the application

filters

Provide summary of overall query metrics across all conversations

Provide summary of overall conversation metrics

The ID of the project to get conversations for

Filters to return conversations metrics for

Provide graph-ready analysis data of various metrics

The ID of the project to get analysis for

Filters to return graph-ready analysis data for

Defaults to weekly. Interval to return graph-ready analysis data inbetween

interval

Retrieve a list of all sources associated with a given project

Create a new data source for a given project

Update a data source settings to change additional settings

source_id

Defaults to true. Add new pages to project automatically during refresh project source

Defaults to never. The project source data refresh frequency

Defaults to true. Whether the project source should execute JavaScript

Defaults to never. Refresh existing page during refresh project source

Defaults to Custom schedule for advanced data frequency

Defaults to true. Remove pages from project automatically during refresh project source

Retrieve the profile information of the current user

CustomGPT.ai

Pre-configured, Predictable, Single Interface, Ready-to-use, Opinionated & Managed API Explorer & Server. Bring your API credentials, configure and access your 3rd party APIs. Using LowCodeAPI securely manage all integrations in one place.