Fetch Chatbots

get

Retrieves a list of chatbots associated with the authenticated user.

Authorizations
x-api-keystringRequired
Responses
chevron-right
200

Successful response

application/json
_idstring · objectidOptional

Unique identifier for the chatbot

namestringRequired

Name of the chatbot

user_idstring · objectidRequired

ID of the user who owns this chatbot

chatbot_idstringRequired

Unique identifier for the chatbot (different from _id)

source_urlstringOptional

URL of the website used to train the chatbot

visibilitystring · enumOptional

Visibility setting for the chatbot

Default: publicPossible values:
created_atstring · date-timeOptional

Timestamp of when the chatbot was created

allowed_domainsstring[]Optional

List of domains where the chatbot is allowed to be used

ip_limitinteger · nullableOptional

Limit on the number of IP addresses that can access the chatbot

ip_limit_timeframeinteger · nullableOptional

Timeframe (in seconds) for the IP limit

ip_limit_messagestring · nullableOptional

Message to display when IP limit is reached

modelTypestringOptional

Type of AI model used for the chatbot

num_of_charactersintegerOptional

Number of characters in the chatbot's training data

last_trained_atstring · date-timeOptional

Timestamp of when the chatbot was last trained

statusstring · enumOptional

Current status of the chatbot

Default: pendingPossible values:
tempnumberOptional

Temperature setting for the chatbot's responses

Default: 0
only_allow_on_added_domainsbooleanOptional

Whether to restrict the chatbot to only allowed domains

Default: false
custom_domainsstring[]Optional

List of custom domains where the chatbot can be used

__vintegerOptional

Version key

stylesobjectOptional

Custom styles for the chatbot interface

get
/integrations/chatbots

Last updated