GET
/
v0
/
chatbots
curl --request GET \
  --url https://sitegpt.ai/api/v0/chatbots \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Fetched all the chatbots successfully",
  "data": {
    "chatbots": [
      {
        "id": "361628903185318481",
        "title": "My First Bot",
        "description": "This is my first chat bot",
        "settings": {
          "userPrompt": "",
          "welcomeMessage": "",
          "systemPrompt": "",
          "promptId": null,
          "hideTooltip": true
        },
        "createdById": "360596271623307865",
        "createdByEmail": "saidheeraj.kumar04@gmail.com",
        "suggestions": [
          {
            "id": "6b3ae643-257f-4ede-a28c-6ef02ed2737a",
            "title": "What is this?",
            "description": "What is site gpt ?"
          }
        ],
        "nextSuggestions": [],
        "prompts": []
      },
      {
        "id": "365062873485935184",
        "title": "My Bot",
        "description": "This is a test chatbot",
        "settings": {
          "mode": "AGENT",
          "tooltip": "Want to know anything about the porduct?",
          "welcomeMessage": "Hello! How can I assist you today?",
          "placeholderText": "Ask me anything...",
          "brandColor": "#2563eb",
          "hideSources": false,
          "hideTooltip": false,
          "hideWatermark": false,
          "watermarkText": "Powered by SiteGPT",
          "watermarkIconSrcId": "",
          "watermarkLink": "https://sitegpt.ai",
          "distanceFromBottom": 16,
          "horizontalDistance": 16,
          "fontSize": 14,
          "iconSize": "SMALL",
          "iconPosition": "RIGHT",
          "height": 85,
          "ctaLink": "",
          "ctaText": "",
          "iconSrcId": "",
          "personIconSrcId": "",
          "brandTextColor": "#FFFFFF",
          "hideFeedbackButtons": false,
          "rtl": false,
          "agentIconSrcId": "",
          "bubbleIconSrcId": "",
          "localization": {
            "learnMore": "Learn more",
            "chatHome": {
              "home": "Home",
              "addDetails": "Add details",
              "startConversation": "Start a conversation",
              "starting": "Starting..."
            },
            "chatMessages": {
              "messages": "Messages",
              "noMessages": "No Messages",
              "loginToSeeHistory": "Verify your email to save your conversation history.",
              "historyShowsUpHere": "Your conversation history shows up here.",
              "verifyEmail": "Verify your email",
              "startConversation": "Start a conversation",
              "starting": "Starting..."
            },
            "chatMessage": {
              "botName": "Bot",
              "yourName": "You",
              "agentName": "Agent",
              "escalationHeading": "Are you sure you want to escalate the chat to human support?",
              "escalationSubHeading": "This conversation will be shared with the human support and they will get back to you as soon as they can.",
              "yesContinue": "Yes, continue",
              "cancel": "Cancel",
              "conversationEscalated": "👨‍💼 Conversation changed to human mode"
            },
            "chatAccount": {
              "account": "Account",
              "verifyEmail": "Verify your email",
              "loginToSeeHistory": "Verify your email to save your chat history.",
              "emailLabel": "Email",
              "nameLabel": "Name",
              "phoneLabel": "Phone Number",
              "sendingOtp": "Sending OTP...",
              "verifyOtp": "Verify OTP",
              "sentOtpToEmail": "We sent the OTP to your email address",
              "otp": "OTP",
              "verifyAndContinue": "Verify & Continue",
              "notReceivedOtpYet": "Didn't receive OTP yet?",
              "resend": "Resend",
              "editDetails": "Edit Details",
              "resetting": "Resetting...",
              "verifying": "Verifying...",
              "logout": "Logout",
              "loggingOut": "Logging out...",
              "verified": "Verified",
              "edit": "Edit",
              "update": "Update",
              "updating": "Updating..."
            }
          },
          "systemPrompt": "You are a funny AI assistant and you answer the user queries based on the website content. Include jokes in your answer.",
          "userPrompt": "You are an AI assistant who answers user questions based on the website content. Answer the questions in the same language as the language of the question.",
          "promptId": "042686d9-b695-4dc5-aa11-58706284d45e",
          "historyCount": 4,
          "temperature": 1,
          "topK": 3,
          "gptModel": "gpt-3.5-turbo",
          "collectUserDetails": "DO_NOT_COLLECT",
          "collectUserData": {
            "name": false,
            "phone": false
          },
          "creativity": "conservative",
          "webhookUrl": "https://example.com",
          "webhookToken": "abc123",
          "extraData": "",
          "metadata": {
            "key1": "value1"
          }
        },
        "createdById": "360596271623307865",
        "createdByEmail": "saidheeraj.kumar04@gmail.com",
        "suggestions": [
          {
            "id": "538aa9ca-ef69-4a1a-a6a2-ba1f62f05c43",
            "title": "Contact us",
            "description": "How to contact you?",
            "link": "https://sitegpt.ai/contact-us"
          },
          {
            "id": "40ffc3fe-9d74-439c-bfec-8b0d69a94836",
            "title": "Yo",
            "description": "Hey what's up?"
          }
        ],
        "nextSuggestions": [
          {
            "id": "dd6480d7-33da-4943-a5f5-24d7593ec62e",
            "title": "Elaborate",
            "link": "",
            "description": "Explain this in layman language",
            "isEscalationPrompt": false
          }
        ],
        "prompts": [
          {
            "id": "042686d9-b695-4dc5-aa11-58706284d45e",
            "title": "Random",
            "description": "Random prompt",
            "instructions": "You should provide random information",
            "temperature": 0.99
          }
        ]
      }
    ]
  }
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

delimeter
string
default: ,

Delimeter to identify multiple values in other parameters

metadataKeys
string

Array of keys to be searched in metadata (separated by delimeter)

metadataValues
string

Array of values to be searched against above metadata keys (separated by delimeter)

Response

200 - application/json
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

Was this page helpful?

Getting StartedCreate Chatbot