Botpress

Learn how to use Botpress with Composio

Overview

SLUG: BOTPRESS

Description

Botpress is an open-source platform for building, deploying, and managing chatbots.

Authentication Details

bearer_token
stringRequired

Connecting to Botpress

Create an auth config

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

1

Select App

Navigate to the Botpress 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
5botpress_auth_config_id = "ac_YOUR_BOTPRESS_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 Botpress 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, botpress_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 Botpress 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=["BOTPRESS"])
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: Delete File

Description

Tool to delete a file by its id or key. use after confirming the file exists.

Action Parameters

botId
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Account

Description

Tool to get details of the authenticated account. use after confirming valid credentials.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: LIST_BOT_ISSUES

Description

Tool to list issues associated with a specific bot. use when you need to discover errors or configuration problems tied to a bot, optionally paginating through results.

Action Parameters

id
stringRequired
nextToken
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: LIST_CONVERSATIONS

Description

Tool to list all conversations. use when you need to retrieve and page through chat threads.

Action Parameters

botId
stringRequired
channel
string
integrationName
string
nextToken
string
participantIds
array
sortDirection
string
sortField
string
tags
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: LIST_FILE_TAGS

Description

Tool to list all tags used across all bot files. use when you need to retrieve or display file tag metadata; supports pagination via nexttoken.

Action Parameters

botId
stringRequired
nextToken
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: LIST_FILE_TAG_VALUES

Description

Tool to list all values for a given file tag across all files. use after determining the tag name; supports pagination via nexttoken.

Action Parameters

botId
stringRequired
nextToken
string
tag
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: LIST_PUBLIC_WORKSPACES

Description

Tool to retrieve a list of public workspaces. use when browsing publicly available workspaces before selection.

Action Parameters

nextToken
string
search
string
workspaceIds
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: LIST_WORKSPACES

Description

Tool to retrieve a list of workspaces. use when you need to list and page through your botpress workspaces, optionally filtering by handle.

Action Parameters

handle
string
nextToken
string

Action Response

data
objectRequired
error
string
successful
booleanRequired