PUT
/
api
/
bot

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Schema for updating a bot.

bot_name
string
required

Name of the bot.

Maximum length: 50
case_study
string
required

Case study of the bot.

Maximum length: 50
id
string
required

Unique identifier for the bot.

bot_language
string | null

Language used by the bot.

bot_tone_type
integer | null

Type of bot tone.

collect_customer_info
object | null

Dictionary for collecting customer information.

custom_error_message
string | null

Custom error message for the bot.

custom_prompt
string | null

Custom prompt for GPT model.

domain
string[] | null

List of domains associated with the bot.

gpt_model_name
string | null

Name of the GPT model used by the bot.

is_activate
boolean | null

Flag indicating bot activation.

is_enable_citation
boolean | null
default:
false

Flag indicating citation enablement.

is_visibility
boolean | null

Flag indicating bot visibility.

rules
string[] | null

List of rules associated with the bot.

temperature
number | null

Temperature setting for GPT model.

user_id
string | null

Optional user identifier associated with the bot.

Response

200 - application/json

Bot Schema.

bot_name
string
required

Name of the bot.

Maximum length: 50
case_study
string
required

Case study of the bot.

Maximum length: 50
id
string
required

Unique identifier for the bot.

bot_language
string | null

Language used by the bot.

bot_tone_type
integer | null

Type of bot tone.

collect_customer_info
object | null

Dictionary for collecting customer information.

created_at
string | null

Timestamp indicating when the bot was created.

custom_error_message
string | null

Custom error message for the bot.

custom_prompt
string | null

Custom prompt for GPT model.

domain
string[] | null

List of domains associated with the bot.

gpt_model_name
string | null

Name of the GPT model used by the bot.

is_activate
boolean | null

Flag indicating bot activation.

is_enable_citation
boolean | null
default:
false

Flag indicating citation enablement.

is_visibility
boolean | null

Flag indicating bot visibility.

num_message_left
integer | null

Number of messages left for the bot.

rules
string[] | null

List of rules associated with the bot.

temperature
number | null

Temperature setting for GPT model.

updated_at
string
default:
2024-01-19T17:53:51.643870
user_id
string | null

Optional user identifier associated with the bot.