Conversational Ai

Chatbotkit

Learn how to use Chatbotkit with Composio

Overview

SLUG: CHATBOTKIT

Description

ChatBotKit is a platform that enables developers to build and manage AI-powered chatbots, offering comprehensive APIs and SDKs for seamless integration into applications.

Authentication Details

generic_api_key
stringRequired

Connecting to Chatbotkit

Create an auth config

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

1

Select App

Navigate to the Chatbotkit toolkit page and click “Setup Integration”.

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

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Chatbotkit toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["CHATBOTKIT"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Complete Conversation

Description

Tool to send a message to a conversation and receive the bot’s reply. use after retrieving or initiating a conversation id.

Action Parameters

accept
string
conversation_id
stringRequired
text
stringRequired

Action Response

data
objectRequired
error
string
success
booleanRequired
successful
booleanRequired

Tool Name: Create Integration

Description

Tool to create a new integration. use when you need to set up a support channel integration for a bot after collecting the integration details.

Action Parameters

botId
stringRequired
description
string
email
stringRequired
meta
object
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Skillset

Description

Tool to create a new skillset. use when you need to group multiple skills into a single reusable unit.

Action Parameters

data
object
description
string
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Bots

Description

Tool to retrieve a paginated list of all bots. use when you need to browse or manage multiple bots, and iterate pages via cursor.

Action Parameters

cursor
string
limit
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Conversations

Description

Tool to retrieve a paginated list of conversations. use when you need to page through conversation history.

Action Parameters

accept
string
cursor
string
order
string
take
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List conversation messages

Description

Tool to list messages in a conversation with pagination. use after obtaining a conversation id to fetch messages page by page.

Action Parameters

conversationId
stringRequired
cursor
string
order
string
take
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Datasets

Description

Tool to list datasets. use when you need to browse or paginate through available datasets.

Action Parameters

limit
integer
page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Integrations

Description

Tool to retrieve a list of trigger integrations. use when you need to browse or manage configured trigger integrations and iterate pages via cursor.

Action Parameters

cursor
string
order
string
take
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Partners

Description

Tool to retrieve a list of all partner accounts associated with the main account. use when you need to view or manage all sub-accounts under your partner umbrella.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Skillsets

Description

Tool to retrieve a list of all skillsets available in the system. use when you need to enumerate existing skillsets.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Tokens

Description

Tool to retrieve a list of all api tokens. use when you need to audit or manage existing tokens.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired