v1

latestOpenAPI 3.1.02026-07-1310868314.3 KB

Bot

Get Bot Information By Bot Id

Retrieves information about a bot.

get/api/bot/information

Query parameters

bot_idstring uuid required

Response

Successful Response

user_idstring uuid nullable

Optional user identifier associated with the bot.

bot_namestring required

Name of the bot.

case_studystring required

Case study of the bot.

is_visibilityboolean nullable

Flag indicating bot visibility.

domainstring[] nullable

List of domains associated with the bot.

collect_customer_infoobject nullable

Dictionary for collecting customer information.

rulesstring[] nullable

List of rules associated with the bot.

gpt_model_namestring nullable

Name of the GPT model used by the bot.

temperaturenumber nullable

Temperature setting for GPT model.

custom_promptstring nullable

Custom prompt for GPT model.

bot_tone_typeinteger nullable

Type of bot tone.

custom_error_messagestring nullable

Custom error message for the bot.

is_enable_citationboolean nullable

Flag indicating citation enablement.

is_activateboolean nullable

Flag indicating bot activation.

bot_languagestring nullable

Language used by the bot.

idstring uuid required

Unique identifier for the bot.

num_message_leftinteger nullable

Number of messages left for the bot.

created_atstring date-time nullable

Timestamp indicating when the bot was created.

updated_atstring date-time