--- title: "Fetch Chatbot" method: GET path: "/v0/chatbots/{chatbotId}" tags: ["Chatbot"] --- # Fetch Chatbot `GET /v0/chatbots/{chatbotId}` ## Request - Base URL: `https://sitegpt.ai/api` - URL: `https://sitegpt.ai/api/v0/chatbots/{chatbotId}` - Auth: HTTP bearer Fetch a particular chatbot ## Path parameters - `chatbotId` string, required ## Response `200` OK - object: Success Response - `success` boolean: Indicates whether this is success response or error response - `message` string: Overall message regarding the operation performed - `data` object: Data returned from the server - `chatbot` Chatbot: Chatbot - `id` string: Id of the chatbot - `title` string: Title of the chatbot - `description` string: Description of the chatbot - `createdById` string: Id of the user that created this chatbot - `createdByEmail` string: Email of the user that created this chatbot - `customContent` string, nullable: Custom content of the chatbot - `suggestions` QuickPrompt[]: Quick prompts of the chatbot - `id` string: Id of the conversation-starter - `title` string: Title of the conversation-starter. This is the text that is shown as button in the chatbot. - `link` string, nullable: Link of the conversation starter. If this link is not null, then when you click on the conversation starter in the chatbot, this link will be opened instead of sending a message to the chatbot. - `description` string: Description of the conversation-starter. This is the message that will be sent to the chatbot when you click on the conversation-starter inside the chatbot. - `prompts` ChatbotPrompt[]: List of prompts set by the user - `id` string: Id of the prompt - `title` string: Title of the prompt - `description` string: Short description of the prompt - `instructions` string: Actual instructions of the prompt. These will be sent to Open AI. - `temperature` number: Decides creativity level of the chatbot response. 0 is more focused and 1 is more creative/random. - `nextSuggestions` FollowUpPrompt[]: Follow-up prompts of the chatbot - `id` string: Id of the follow-up prompt. - `title` string: Title of the follow-up-prompt. This is the text that is shown as button in the chatbot. - `link` string, nullable: Link of the follow-up prompt. If this link is not null, then when you click on the follow-up prompt in the chatbot, this link will be opened instead of sending a message to the chatbot. - `description` string: Description of the follow-up-prompt. This is the message that will be sent to the chatbot when you click on the follow-up-prompt inside the chatbot. - `isEscalationPrompt` boolean: Indicates whether the follow-up prompt is escalation prompt or not. - `settings` ChatbotSettings: Settings of the chatbot - `tooltip` string, nullable: This tooltip will be shown on the top of chatbot icon. If not set, welcome message will be shown as tooltip - `welcomeMessage` string, nullable: The first message that the users will see in the chatbot - `placeholderText` string, nullable: Placeholder text that users see before they type their question in the chat - `brandColor` string, nullable: Primary color of the chatbot - `brandTextColor` string, nullable: Primary text color of the chatbot - `hideSources` boolean, nullable: Indicates whether to display sources or not in the chatbot - `hideTooltip` boolean, nullable: Indicates whether to hide tooltip or not in the chatbot - `hideFeedbackButtons` boolean, nullable: Indicates whether to hide feedback buttons (for each reply) or not in the chatbot - `rtl` boolean, nullable: Indicates whether to display the text in the chatbot right to left or opposite - `watermarkText` string, nullable: Text to be shown as the watermark in the chatbot - `autoOpenChatWindowInDesktop` 'ALWAYS_OPEN_WITH_DELAY' | 'DONT_OPEN', nullable: Option to handle behaviour auto open chat window in desktop - `autoOpenChatWindowDelayInDesktop` integer, nullable: Delay after which the chat window will shown in desktop when autoOpenChatWindowInDesktop is set to AUTO_OPEN_WITH_DELAY - `autoOpenChatWindowInMobile` 'ALWAYS_OPEN_WITH_DELAY' | 'DONT_OPEN', nullable: Option to handle behaviour auto open chat window in mobile - `autoOpenChatWindowDelayInMobile` integer, nullable: Delay after which the chat window will shown in mobile when autoOpenChatWindowInMobile is set to AUTO_OPEN_WITH_DELAY - `hideWatermark` boolean, nullable: Indicates whether the watermark is shown in the chatbot or not - `watermarkLink` string, nullable: Url of the watermark to be shown in the chatbot - `distanceFromBottom` integer, nullable: Distance from bottom (in px) where the chatbot icon should be shown - `horizontalDistance` integer, nullable: Horizantal distance (in px) where the chatbot icon should be shown - `fontSize` integer, nullable: Font size of the text shown in chatbot (in px) - `iconSize` 'SMALL' | 'MEDIUM' | 'LARGE' | 'XL' | '2XL' | '3XL' | '4XL' | '5XL': Possible options foe icon size of the chatbot - `iconPosition` 'LEFT' | 'RIGHT': Possible options for icon position of the chatbot - `height` number, nullable: Height of the chatbot - `ctaText` string, nullable: Call to Action text - `ctaLink` string, nullable: Call to Action Link - `localization` ChatbotLocalizationSettings: Localization settings of the chatbot - `locale` string, nullable: Language of the text the widget writes itself (relative timestamps such as "just now"). A BCP-47 tag from the supported list, for example `da`, `de`, `ja`, `pt`; omit or send null for English (en-US). - `learnMore` string, nullable: Localization option for `Learn more` option - `chatHome` ChatbotLocalizationChatHome: Localization settings for home screen in the chatbot - `home` string: Text to be replaced for `Home` in home screen - `addDetails` string: Text to be replaced for `Add details` in home screen - `startConversation` string: Text to be replaced for `Start a conversation` in home screen - `starting` string: Text to be replaced for `Starting...` in home screen - `chatMessages` ChatbotLocalizationChatMessages: Localization settings for messages screen in the chatbot - `messages` string: Text to be replaced for `Messages` in messages screen - `noMessages` string: Text to be replaced for `No Messages` in messages screen - `loginToSeeHistory` string: Text to be replaced for `Verify your email to save your conversation history.` in messages screen - `historyShowsUpHere` string: Text to be replaced for `Your conversation history shows up here.` in messages screen - `verifyEmail` string: Text to be replaced for `Verify your email` in messages screen - `startConversation` string: Text to be replaced for `Start a conversation` in messages screen - `starting` string: Text to be replaced for `Starting...` in messages screen - `chatMessage` ChatbotLocalizationChatMessage: Localization settings for individual conversations in the chatbot - `botName` string: Text to be replaced for `Bot` in individual conversations - `yourName` string: Text to be replaced for `You` in individual conversations - `agentName` string: Text to be replaced for `Agent` in individual conversations - `escalationHeading` string: Text to be replaced for `Are you sure you want to escalate the chat to human support?` in individual conversations - `escalationSubHeading` string: Text to be replaced for `This conversation will be shared with the human support and they will get back to you as soon as they can.` in individual conversations - `yesContinue` string: Text to be replaced for `Yes, continue` in individual conversations - `cancel` string: Text to be replaced for `Cancel` in individual conversations - `conversationEscalated` string: Text to be replaced for `👨‍💼 Conversation changed to human mode` in individual conversations - `chatAccount` ChatbotLocalizationChatAccount: Localization settings for account screen in the chatbot - `account` string: Text to be replaced for `Account` in account screen - `verifyEmail` string: Text to be replaced for `Verify your email` in account screen - `loginToSeeHistory` string: Text to be replaced for `Verify your email to save your chat history` in account screen - `emailLabel` string: Text to be replaced for `Email` in account screen - `nameLabel` string: Text to be replaced for `Name` in account screen - `phoneLabel` string: Text to be replaced for `Phone Number` in account screen - `submit` string: Text to be replaced for `Submit` in account screen - `sendingOtp` string: Text to be replaced for `Sending OTP...` in account screen - `verifyOtp` string: Text to be replaced for `Verify OTP` in account screen - `sentOtpToEmail` string: Text to be replaced for `We sent the OTP to your email address` in account screen - `otp` string: Text to be replaced for `OTP` in account screen - `verifyAndContinue` string: Text to be replaced for `Verify & Continue` in account screen - `notReceivedOtpYet` string: Text to be replaced for `Didn't receive OTP yet?` in account screen - `resend` string: Text to be replaced for `Resend` in account screen - `editDetails` string: Text to be replaced for `Edit Details` in account screen - `resetting` string: Text to be replaced for `Resetting...` in account screen - `verifying` string: Text to be replaced for `Verifying...` in account screen - `logout` string: Text to be replaced for `Logout` in account screen - `loggingOut` string: Text to be replaced for `Logging out...` in account screen - `verified` string: Text to be replaced for `Verified` in account screen - `edit` string: Text to be replaced for `Edit` in account screen - `update` string: Text to be replaced for `Update` in account screen - `updating` string: Text to be replaced for `Updating...` in account screen - `maxWidth` number: Max width of the chatbot - `iconSrcId` string, nullable: Url reference of the Bot icon - `personIconSrcId` string, nullable: Url reference of the User/person icon - `agentIconSrcId` string, nullable: Url reference of the Agent icon - `watermarkIconSrcId` string, nullable: Url reference of the Watermark icon - `bubbleIconSrcId` string, nullable: Url reference of the Chat Buuble icon - `systemPrompt` string, nullable: Use this to change the tone of your chatbot and also give any additional instructions - `userPrompt` string, nullable: Use this to change the instructions you give to your chatbot in the user prompt - `promptId` string, nullable: Selected promptId that will be used as prompt to generate Open AI response - `disableSmartFollowUpPrompts` boolean, nullable: Option to disable smart followup questions generated by SiteGPT. - `smartFollowUpPromptsCount` integer, nullable: Number of smart follow up questions to be shown when enabled. - `disableLeadNotifications` boolean, nullable: Option to disable email notifications for new lead captures. - `historyCount` integer, nullable: Number of history messages to be considered when answering the question - `temperature` number, nullable: Creativity meter of the chatbot. This is valid only when creativity of the chatbot is custom - `topK` number, nullable: Number of relevant chunks to be fetched for answering the question - `gptModel` 'gpt-3.5-turbo' | 'gpt-4': All available GPT models - `creativity` 'restricted' | 'conservative' | 'creative' | 'custom': Options of the creativity for the chatbot - `webhookUrl` string, nullable: All messages are sent to this global webhook url if webhook url is not configured at thread level - `webhookToken` string, nullable: This is the global webhook token that is sent in header in the calls made to the above webhook url for all messages if token is not configured at thread level - `mode` 'AI' | 'AGENT': Mode of the chat - `collectUserDetails` 'MANDATORY' | 'OPTIONAL' | 'DO_NOT_COLLECT': Options whether to collect user details or not - `collectUserData` object: This object has information what all user data needs to be collected - `name` boolean: Indicates whether to collect user name or not - `phone` boolean: Indicates whether to collect user phone number or not - `extraData` string, nullable: Any extra data you want to add to your chatbot. - `metadata` object, nullable: Any metadata (key-value pairs) that you can assign to the chatbot. Key should be string and Value could be anything. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `405`: Method Not Allowed - `500`: Internal Server Error --- [API](https://skmtc.dev/sitegpt/apis/sitegpt-api-collection.md) · [All operations](https://skmtc.dev/sitegpt/apis/sitegpt-api-collection/llms.txt) · [OpenAPI document](https://skmtc.dev/sitegpt/apis/sitegpt-api-collection/revisions/aec0de1a00af?raw)