NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Sendbird AI Chatbot connects to a Nagent workspace with an API key. Once it is connected, agents can call 6 Sendbird AI Chatbot actions, such as "Create Bot", "Get Bot" and "List Bots". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Sendbird AI Chatbot, with input parameters and output schema.
SENDBIRD_AI_CHABOT_CREATE_BOTTool to create a new bot. Use when you need to add an AI or default bot to your Sendbird app.
Input parameters
Type of the bot
Unique ID for the bot, maximum 80 characters
Nickname for the bot, maximum 80 characters
Profile image URL for the bot
Whether the bot operates in privacy mode
Callback URL for the bot’s webhook events
Whether the bot marks messages as read automatically
Channel invitation handling options for the bot. 0 = disable auto accept, 1 = auto accept
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_AI_CHABOT_GET_BOTTool to retrieve information on a specific bot by its user ID. Use when you need to fetch bot details before performing subsequent operations.
Input parameters
The unique user ID of the bot to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_AI_CHABOT_LIST_BOTSTool to list all bots in the Sendbird application. Use when you need to fetch bot details with optional filters and pagination.
Input parameters
Number of results to return per page (1–100). Defaults to 10 if omitted.
Pagination token for a paginated result.
Filter results by a specific bot ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_AI_CHABOT_LIST_GROUP_CHANNELSTool to list group channels. Use when you need to fetch available group channels with filters and pagination.
Input parameters
Filter by channel URL.
Filter by exact channel name.
Number of results to return per page (1-100).
Pagination token for the next page.
Query type to combine member_user_ids: AND or OR.
Include channels with no messages.
Filter by super channel mode: all, super, or nonsuper.
Filter by a specific custom type.
Filter by public mode: all, public, or private.
Filter by specific channel URLs.
Filter by multiple custom types.
Filter channels created after this timestamp (ms since epoch).
Filter by distinct mode: all, distinct, or nondistinct.
Filter by partial channel name match.
Filter channels created before this timestamp (ms since epoch).
Filter by members' user IDs.
Filter by members' nickname.
Filter channels where exactly these user IDs are members.
Filter channels including any of these user IDs.
Filter by members' nickname prefix.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_AI_CHABOT_UNREGISTER_BOT_WEBHOOKTool to unregister the webhook URL for a bot. Use when you need to remove webhook configuration for a specific bot.
Input parameters
Unique ID of the bot whose webhook will be unregistered.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_AI_CHABOT_UPDATE_BOTTool to update information on an existing bot. Use when you need to change a bot's user ID, nickname, profile image URL, or toggle read-receipt or privacy settings after creation. Run after confirming the bot ID.
Input parameters
The unique ID of the bot to update
Specifies a new user ID for the bot
Specifies a new nickname for the bot
Specifies a new profile image URL for the bot
Determines bot privacy mode
Determines whether the bot marks messages as read
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 6 Sendbird AI Chatbot actions on Nagent, including "Create Bot", "Get Bot" and "List Bots". Create Bot: Create a new bot. Each action is listed on this page with its input parameters and its output.
Sendbird AI Chatbot connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Bot takes 2 required inputs: bot_userid and bot_nickname. It also takes 6 optional inputs: bot_type, bot_profile_url, is_privacy_mode, bot_callback_url, enable_mark_as_read and channel_invitation_preference. It returns data, error and successful.