Getting AI Agent Interface

Request Address: /api/bot/interface/{botId}

Request Method: GET

Request Header 👇

Name	Type	Description
Authorization	String	The API key created

Request Body Parameter 👇

Name	Type	IsRequired	Description
botId	int	Yes	The botId of agent

Response Parameter 👇

Name	Type	Description
id	int	id
version	int	version
botId	int	The botId of agent
userId	string	The OORT AI user id
secretKey	string	The api key info
CreatedTime	string	The create time of agent interface
updatedTime	string	The update time of agent interface
deletedTime	string	The delete time of agent interface
initialMessages	string	The initial message when open the agent
suggestedMessages	string	The suggested messages which often used
theme	string	The theme of agent
profilePicture	string	The profile picture of agent
displayName	string	The display name of agent
userMessageColor	string	The color of user message
chatIcon	string	The icon of agent
chatBubbleButtonColor	string	The color of agent bubble button
alignChatButton	string	The algin of agent button
initialMessagesAfter	int	The initial messages after of agent

Response Example 👇

{
    "code": 0,
    "msg": "success",
    "data": {
        "createdTime": "2023-07-26T05:50:41.814Z",
        "updatedTime": "2023-07-26T06:00:25.564Z",
        "deletedTime": null,
        "version": 3,
        "id": 183,
        "botId": "2QUeH4h7_Xz3uL8TL8O4j",
        "userId": "426772239258484736",
        "initialMessages": [
            "Hi! What can I help you with?"
        ],
        "suggestedMessages": [
            "LLM简单介绍",
            "常用LLM模型",
            "大语言模型的训练方式"
        ],
        "theme": "light",
        "profilePicture": null,
        "displayName": "Chatbot",
        "userMessageColor": "#3B81F6",
        "chatIcon": null,
        "chatBubbleButtonColor": "#000000",
        "alignChatButton": "right",
        "initialMessagesAfter": 3
    }
}