SiteGPT
    SiteGPT
    • 入门
    • 获取所有聊天机器人
      GET
    • 创建聊天机器人
      POST
    • 获取聊天机器人
      GET
    • 删除聊天机器人
      DELETE
    • 更新聊天机器人外观
      PATCH
    • 修改聊天机器人自定义内容
      POST
    • 获取所有后续提示
      GET
    • 添加跟进提示
      POST
    • 获取后续提示
      GET
    • 删除后续提示
      DELETE
    • 更新跟进提示
      PATCH
    • 更新聊天机器人图标
      POST
    • 删除聊天机器人图标
      DELETE
    • 获取链接
      GET
    • 添加聊天机器人链接
      POST
    • 发信息
      POST
    • 更新消息
      PATCH
    • 添加聊天机器人提示
      POST
    • 删除聊天机器人提示
      DELETE
    • 更新聊天机器人提示
      PATCH
    • 获取所有快速提示
      GET
    • 添加快速提示
      POST
    • 获取快速提示
      GET
    • 删除快速提示
      DELETE
    • 更新快速提示
      PATCH
    • 更新聊天机器人设置 - 高级
      PATCH
    • 更新聊天机器人设置 - 聊天模式
      PATCH
    • 更新聊天机器人设置 - 常规
      PATCH
    • 更新聊天机器人设置 - 本地化
      PATCH
    • 更新聊天机器人设置 - 用户数据
      PATCH
    • 获取所有线程
      GET
    • 获取线程
      GET
    • 更新主题
      PATCH
    • 升级对话
      POST
    • 获取白标品牌
      GET
    • 获取白标品牌
      GET
    • 添加白标用户
      POST
    • 更新白标用户
      PATCH

      获取聊天机器人

      开发环境
      开发环境
      GET
      /api/v0/chatbots/{chatbotId}
      请求示例请求示例
      Shell
      JavaScript
      Java
      Swift
      curl --location --request GET 'http://dev-cn.your-api-server.com/api/v0/chatbots/' \
      --header 'Authorization: Bearer <token>'
      响应示例响应示例
      200 - 成功示例
      {
        "success": true,
        "message": "Fetched the chatbot successfully",
        "data": {
          "chatbot": {
            "id": "365062873485935184",
            "title": "My Bot",
            "description": "This is a test chatbot",
            "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.9
              },
              {
                "id": "78ac8ecd-d889-4700-8c8c-162c92731ff9",
                "title": "Factual",
                "description": "Factual Prompt",
                "instructions": "You should provide only facts",
                "temperature": 0.1
              }
            ],
            "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": "78ac8ecd-d889-4700-8c8c-162c92731ff9",
              "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"
              }
            },
            "customContent": null
          }
        }
      }

      请求参数

      Path 参数
      chatbotId
      string 
      必需
      聊天机器人的 ID
      Header 参数
      Authorization
      string 
      必需
      示例值:
      Bearer <token>

      返回响应

      🟢200成功
      application/json
      Body
      success
      boolean 
      必需
      指示这是成功响应还是错误响应
      message
      string 
      必需
      有关所执行操作的总体消息
      data
      object 
      从服务器返回的数据
      必需
      chatbot
      object 
      聊天机器人
      必需
      🟠400请求有误
      🟠401没有权限
      🟠403禁止访问
      🟠405请求有误
      🔴500服务器错误
      修改于 2024-03-28 06:48:20
      上一页
      创建聊天机器人
      下一页
      删除聊天机器人
      Built with