Get Bot Information
Last updated:2023-11-02

Get Bot Information

Get Bot basic information.

Request Method

GET

Request URL

https://api.gptbots.ai/v1/bot/detail

Request Authentication

See Overview for authentication details.

Request

Request Example

curl -X GET 'https://api.gptbots.ai/v1/bot/detail' \ -H 'Authorization: Bearer your_apikey' \ -H 'Content-Type: application/json'
          curl -X GET 'https://api.gptbots.ai/v1/bot/detail' \
  -H 'Authorization: Bearer your_apikey' \
  -H 'Content-Type: application/json'

        
This code block in the floating window

Request Headers

Field Type Description
Authorization Bearer ${token} Use Authorization: Bearer ${token} for authentication. Get the key from the API Keys page as token.
Content-Type application/json Data type, set to application/json.

Request Body

None.

Response

Response Example

{ "bot_id": "645dd86606931c4a9e0ffb1e", "name": "Conversational App", "logo": "https://res.theengagelab.com/ailab/images/default_avatar.png", "bot_type": "QuestionAnswer", "welcome_message": "Welcome message when user first uses the bot", "introduction": "Introduction of the bot", "tags": "Tags of the bot", "identity_prompt": "Identity prompt of the bot", "ai_model": "ChatGPT", "ai_model_version": "3.5", "creativity_level": 0.3, "doc_correlation": 0.2, "irrelevant_questions": true, "question_limit": 100, "long_term_memory": true }
          {
  "bot_id": "645dd86606931c4a9e0ffb1e",
  "name": "Conversational App",
  "logo": "https://res.theengagelab.com/ailab/images/default_avatar.png",
  "bot_type": "QuestionAnswer",
  "welcome_message": "Welcome message when user first uses the bot",
  "introduction": "Introduction of the bot",
  "tags": "Tags of the bot",
  "identity_prompt": "Identity prompt of the bot",
  "ai_model": "ChatGPT",
  "ai_model_version": "3.5", 
  "creativity_level": 0.3,
  "doc_correlation": 0.2,
  "irrelevant_questions": true,
  "question_limit": 100,
  "long_term_memory": true
}

        
This code block in the floating window

Success Response

Field Type Description
bot_id string Bot ID.
name string Bot name.
logo string Bot avatar.
bot_type string Bot type, value: QuestionAnswer, Flow.
welcome_message string Welcome message when user first uses the bot.
introduction string Introduction of the bot.
tags array Tags of the bot.
identity_prompt string Identity prompt of the bot.
ai_model string AI model, value: ChatGPT.
ai_model_version string AI model version.
creativity_level float Creativity level, value: 0-1.
doc_correlation float Document correlation, value: 0-1.
irrelevant_questions boolean Whether to answer questions irrelevant to dataset. Value: true, false.
question_limit int Limit on Token length of user questions.
long_term_memory boolean Whether long term memory is enabled.

Failure Response

Field Type Description
code int Error code.
message string Error details.

Error Codes

Code Message
40127 Developer authentication failed
20059 Bot deleted