Create an AI chatbot
Creates a new AI chatbot within an application. Currently, you can create up to 10 AI chatbots. For further information, contact sales.
HTTP request
Request body
The following table lists the properties of an HTTP request that this action supports.
Properties
Required | Type | Description |
---|---|---|
bot_userid | string | Specifies the unique ID of a bot. The length is limited to 80 characters. |
bot_nickname | string | Specifies the bot's nickname. The length is limited to 80 characters. |
bot_profile_url | string | Specifies the URL of a bot's profile image. The length is limited to 2,048 characters. |
bot_type | string | Specifies the bot's type to categorize bots. The length is limited to 128 characters. |
bot_callback_url | string | Specifies the server URL of where a bot is located to receive all events, requests, and data forwarded from an application. For security reasons, it is highly recommended that you use an SSL server. The length is limited to 1,024 characters. |
is_privacy_mode | boolean | Determines whether to forward all or specific messages to the bot in channels where the bot is a member. If set to |
Optional | Type | Description |
---|---|---|
enable_mark_as_read | boolean | Determines whether to mark a bot's message as read upon sending it. (Default: |
show_member | boolean | Determines whether to include information about the members of each channel in a callback response. (Default: |
channel_invitation_preference | int | Determines whether a bot automatically joins a channel when invited or joins a channel after manually accepting an invitation using the API. If set to |
ai | nested object | Specifies attributes of an AI bot. If specified, the bot functions as an AI bot, which can generate responses automatically and independently of the client's server-side operations. |
ai.backend | string | Specifies the system that powers the AI bot. Acceptable value is |
ai.system_message | array of strings | Specifies a message used to help set the behavior of a ChatGPT bot. (Default: |
ai.temperature | number | Specifies the temperature of a ChatGPT bot which controls the randomness or creativity in the generated responses. A higher temperature value will result in more diverse and unpredictable responses, while a lower temperature value will produce more conservative and predictable responses. Acceptable values range from |
ai.max_tokens | integer | Specifies the maximum number of tokens to generate in the response by ChatGPT bots. One token generates roughly four characters for normal English text. Acceptable values range from |
ai.top_p | number | Specifies a value that determines the diversity of response generated by ChatGPT bots via nucleus sampling. Higher values can lead to a variety of responses, but less reliable answers.(Default: |
ai.presence_penalty | number | Specifies a value between |
ai.frequency_penalty | number | Specifies a value between |
Response
If successful, this action returns a bot resource in the response body.
In the case of an error, an error object is returned. A detailed list of error codes is available here.