Sendbird ai chabot

Learn how to use Sendbird ai chabot with Composio

Overview

SLUG: SENDBIRD_AI_CHABOT

Description

Sendbird’s AI Chatbot enables businesses to integrate intelligent, automated conversational agents into their applications, enhancing customer engagement and support.

Authentication Details

subdomain
stringRequired
generic_api_key
stringRequired

Connecting to Sendbird ai chabot

Create an auth config

Use the dashboard to create an auth config for the Sendbird ai chabot toolkit. This allows you to connect multiple Sendbird ai chabot accounts to Composio for agents to use.

1

Select App

Navigate to [Sendbird ai chabot](https://platform.composio.dev?next_page=/marketplace/Sendbird ai chabot).

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Sendbird ai chabot Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4sendbird_ai_chabot_auth_config_id = "ac_YOUR_SENDBIRD_AI_CHABOT_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Sendbird ai chabot for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, sendbird_ai_chabot_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Sendbird ai chabot toolkit’s playground](https://app.composio.dev/app/Sendbird ai chabot)

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Create Bot

Description

Tool to create a new bot. Use when you need to add an AI or default bot to your Sendbird app.

Action Parameters

bot_callback_url
bot_nickname
stringRequired
bot_profile_url
bot_type
Defaults to AI
bot_userid
stringRequired
channel_invitation_preference
enable_mark_as_read
is_privacy_mode

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Bot

Description

Tool to retrieve information on a specific bot by its user ID. Use when you need to fetch bot details before performing subsequent operations.

Action Parameters

bot_user_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Bots

Description

Tool to list all bots in the Sendbird application. Use when you need to fetch bot details with optional filters and pagination.

Action Parameters

bot_id
limit
token

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Group Channels

Description

Tool to list group channels. Use when you need to fetch available group channels with filters and pagination.

Action Parameters

channel_urls
created_after
created_before
custom_type
custom_types
distinct_mode
limit
member_user_ids
members_exactly_in
members_include_in
members_nickname
members_nickname_prefix
name
name_contains
public_mode
query_type
show_empty
super_mode
token
url

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Unregister Bot Webhook

Description

Tool to unregister the webhook URL for a bot. Use when you need to remove webhook configuration for a specific bot.

Action Parameters

bot_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Bot

Description

Tool 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.

Action Parameters

bot_id
stringRequired
bot_nickname
bot_profile_url
bot_userid
enable_mark_as_read
is_privacy_mode

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Bot Webhook

Description

Tool to update the webhook URL of an existing bot. Use when you need to change or enable/disable a bot's webhook after creation.

Action Parameters

bot_id
stringRequired
enable_webhook
webhook_url
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired