Updating AI Agent Settings

Request Address: /api/bot/settings

Request Method: PUT

Request Header 👇

Name	Type	Description
Authorization	String	The API key created

Request Body Parameter 👇

Name	Type	IsRequired	Description
botId	int	yes	The botId which you want to update
name	string	no	The name of agent
characters	int	no	The characters of agent which has been used for training
temperature	int	no	The temperature of agent
isCollectCustomerEmail	boolean	no	The customer email address
isPublic	boolean	no	Is public agent
visibility	string	no	The visibility value of agent
domains	array	no	The domains of agent
apiKey	string	no	apikey
messagesLimit	int	no	The messages limit of agent
everySeconds	int	no	The time duration of seconds
limitMessage	string	no	The prompt for exceeding the maximum value

Name	Type	IsRequired	Description
id	int	Yes	The id of API key for which you want to update

Response Parameter 👇

Name	Type	Description
id	int	id
version	int	version
name	string	The name of agent
userId	string	The OORT AI user id
secretKey	string	The api key info
CreatedTime	string	The create time of api key
updatedTime	string	The update time of api key
deletedTime	string	The delete time of api key
characters	int	The characters of agent which has been used for training
temperature	int	The temperature of agent
isCollectCustomerEmail	boolean
isPublic	boolean	Is public agent
visibility	string	The visibility value of agent
domains	array	The domains of agent
apiKey	string	The api key of agent
messagesLimit	int	The messages limit of agent
everySeconds	int	The time duration of seconds
limitMessage	string	The prompt for exceeding the maximum value
tableName	string	The table name of agent
status	int	The status of agent

Response Example 👇

{
    "code": 0,
    "msg": "success",
    "data": {
        "createdTime": "2023-07-26T05:50:41.814Z",
        "updatedTime": "2023-08-08T09:45:01.139Z",
        "deletedTime": null,
        "version": 3,
        "id": 185,
        "userId": "426772239258484736",
        "botId": "2QUeH4h7_Xz3uL8TL8O4j",
        "characters": 23241,
        "name": "oortBot",
        "temperature": 0,
        "isCollectCustomerEmail": true,
        "isPublic": true,
        "visibility": "Public",
        "domains": [
            "domain1.com",
            "domain2.com"
        ],
        "apiKey": "1",
        "messagesLimit": 20,
        "everySeconds": 240,
        "limitMessage": "Too many messages in a row",
        "tableName": "bot57",
        "defaultPrompt": "Your name is \"AI Assistant\".You will provide me with answers from the following content.If the answer is not included, say exactly \"Hmm, I am not sure.\" and stop after that.Refuse to answer any question not about the info. Never break character.If you don't know the answer, just say \"Hmm, I am not sure.\". Don't try to make up an answer.Please make sure that each of your answers is presented in a step-by-step format using Markdown."
    }
}