The Botpress connector lets your AI agent act in each user's Botpress account. Each user connects their own Botpress access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 58 tools.
- Tools
- 58
- What they doRead · write · destructive
- 31 · 19 · 831 read19 write8 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Botpress connection
In AgentKit > Connections, create a Botpress connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'botpress'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Botpress:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'botpress_account_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "botpress"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Botpress:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="botpress_account_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Botpress credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolbotpress_account_getGet the Botpress account that owns the personal access token.Read-onlyGet Account
Get the Botpress account that owns the personal access token. Returns account. Use this to confirm the connection.
Inputs
This tool takes no inputs.
botpress_bot_analytics_getGet a bot's usage analytics (users, sessions, messages, LLM calls) for a date range.Read-onlyGet Bot Analytics
Get a bot's usage analytics (users, sessions, messages, LLM calls) for a date range. Returns records. Get the bot ID from botpress_bots_list.
Inputs
end_datestringrequired- End date/time (inclusive) Example: 2026-01-31T23:59:59Z
idstringrequired- Bot ID. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
start_datestringrequired- Start date/time (inclusive) Example: 2026-01-01T00:00:00Z
workspace_idstringrequired- ID of the Botpress workspace, sent in the x-workspace-id header. Get it from botpress_workspaces_list. Example: wkspace_01HZX5K9ABCDEF1234567890
botpress_bot_getGet one bot's definition, integrations, status and settings.Read-onlyGet Bot
Get one bot's definition, integrations, status and settings. Returns bot. Get the bot ID from botpress_bots_list.
Inputs
idstringrequired- Bot ID. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
workspace_idstringrequired- ID of the Botpress workspace, sent in the x-workspace-id header. Get it from botpress_workspaces_list. Example: wkspace_01HZX5K9ABCDEF1234567890
botpress_bot_issue_getGet one bot issue with its category, count and last occurrence.Read-onlyGet Bot Issue
Get one bot issue with its category, count and last occurrence. Returns issue. Get the issue ID from botpress_bot_issues_list.
Inputs
idstringrequired- Bot ID. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
issue_idstringrequired- Issue ID. Example: iss_01HZX5K9ABCDEF
workspace_idstringrequired- ID of the Botpress workspace, sent in the x-workspace-id header. Get it from botpress_workspaces_list. Example: wkspace_01HZX5K9ABCDEF1234567890
botpress_bot_issues_listList the runtime issues (errors) recorded for a bot.Read-onlyList Bot Issues
List the runtime issues (errors) recorded for a bot. Returns issues, meta. Use botpress_bot_issue_get for one issue. Get the bot ID from botpress_bots_list.
Inputs
idstringrequired- Bot ID. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
workspace_idstringrequired- ID of the Botpress workspace, sent in the x-workspace-id header. Get it from botpress_workspaces_list. Example: wkspace_01HZX5K9ABCDEF1234567890
next_tokenstring- Provide the meta.nextToken value provided in the last API response to retrieve the next page of results. Example: eyJsYXN0SWQiOiJhYmMifQ
page_sizeinteger- Number of items to return per page (default 20, max 100) Example: 20
botpress_bot_logs_getGet a bot's logs for a time range, filterable by level, user, workflow, conversation or text.Read-onlyGet Bot Logs
Get a bot's logs for a time range, filterable by level, user, workflow, conversation or text. Returns logs, nextToken. Use this to debug a bot. Get the bot ID from botpress_bots_list.
Inputs
idstringrequired- Bot ID. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
time_startstringrequired- Beginning of the time range to get logs from. Example: 2026-01-15T00:00:00Z
workspace_idstringrequired- ID of the Botpress workspace, sent in the x-workspace-id header. Get it from botpress_workspaces_list. Example: wkspace_01HZX5K9ABCDEF1234567890
conversation_idstring- Filter by conversation ID. Example: conv_01HZX5K9ABCDEF1234567890
levelstring- Filter by log level. Example: error
message_containsstring- Filter logs where the message contains this substring. Example: timeout
next_tokenstring- Token to get the next page of logs. Example: eyJsYXN0SWQiOiJhYmMifQ
time_endstring- End of the time range to get logs from. Example: 2026-01-15T23:59:59Z
user_idstring- Filter by user ID. Example: user_01HZX5K9ABCDEF1234567890
workflow_idstring- Filter by workflow ID. Example: wf_01HZX5K9ABCDEFGHJKMNPQRSTV
botpress_bots_listList the bots in a workspace, production or dev, optionally by installed integrations.Read-onlyList Bots
List the bots in a workspace, production or dev, optionally by installed integrations. Returns bots, meta. Use this to get bot IDs for the conversation, table and file tools.
Inputs
workspace_idstringrequired- ID of the Botpress workspace, sent in the x-workspace-id header. Get it from botpress_workspaces_list. Example: wkspace_01HZX5K9ABCDEF1234567890
devboolean- If true, only dev bots are returned. Otherwise, only production bots are returned. Example: true
integration_namesarray- Filter bots that have ALL of these integrations installed (by definition name) Example: ["value"]
next_tokenstring- Provide the meta.nextToken value provided in the last API response to retrieve the next page of results. Example: eyJsYXN0SWQiOiJhYmMifQ
page_sizeinteger- Number of items to return per page (default 20, max 100) Example: 20
plugin_namesarray- Filter bots that have ALL of these plugins installed (by definition name) Example: ["value"]
sort_directionstring- Sort results in this direction. One of: asc, desc. Example: ascone of
ascdesc sort_fieldstring- Sort results by this field. One of: createdAt, updatedAt. Example: createdAtone of
createdAtupdatedAt
botpress_conversation_getGet one conversation with its channel, integration and tags.Read-onlyGet Conversation
Get one conversation with its channel, integration and tags. Returns conversation. Get the conversation ID from botpress_conversations_list.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- Conversation id. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
botpress_conversations_listList a bot's conversations, newest first, optionally by participant, integration, channel, date or message count.Read-onlyList Conversations
List a bot's conversations, newest first, optionally by participant, integration, channel, date or message count. Returns conversations, meta. Use botpress_messages_list to read a conversation.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
after_datestring- Date in ISO 8601 string with UTC timezone after which the conversation was created (inclusive) Example: 2026-01-01T00:00:00Z
before_datestring- Date in ISO 8601 string with UTC timezone before which the conversation was created (inclusive) Example: 2026-01-31T23:59:59Z
channelstring- Filter by integration channel name. Example: channel
integration_namestring- Filter by integration name. Example: telegram
max_message_countinteger- Filter conversations with a message count less than or equal to this value (inclusive) Example: 10
min_message_countinteger- Filter conversations with a message count greater than or equal to this value (inclusive) Example: 10
next_tokenstring- Provide the meta.nextToken value provided in the last API response to retrieve the next page of results. Example: eyJsYXN0SWQiOiJhYmMifQ
page_sizeinteger- Number of items to return per page (default 20, max 100) Example: 20
participant_idsarray- Filter by participant ids. Example: ["user_01HZX5K9ABCDEF1234567890"]
sort_directionstring- Sort results in this direction. One of: asc, desc. Example: ascone of
ascdesc sort_fieldstring- Sort results by this field. One of: createdAt, updatedAt. Example: createdAtone of
createdAtupdatedAt
botpress_event_getGet one event with its type, payload and status.Read-onlyGet Event
Get one event with its type, payload and status. Returns event. Get the ID from botpress_events_list.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- Event id. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
botpress_events_listList events recorded for a bot, optionally by type, conversation, user, workflow or message.Read-onlyList Events
List events recorded for a bot, optionally by type, conversation, user, workflow or message. Returns events, meta. Use botpress_event_get for one event.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
conversation_idstring- Filter by conversation id. Example: conv_01HZX5K9ABCDEF1234567890
message_idstring- Filter by message id. Example: msg_01HZX5K9ABCDEF1234567890
next_tokenstring- Provide the meta.nextToken value provided in the last API response to retrieve the next page of results. Example: eyJsYXN0SWQiOiJhYmMifQ
page_sizeinteger- Number of items to return per page (default 20, max 100) Example: 20
statusstring- Filter by status. Allowed values: pending, ignored, processed, failed, scheduled, canceled, delegated. Example: pendingone of
pendingignoredprocessedfailedscheduledcanceleddelegated typestring- Filter by event type. Example: text
user_idstring- Filter by user id. Example: user_01HZX5K9ABCDEF1234567890
workflow_idstring- Filter by workflow id. Example: wf_01HZX5K9ABCDEFGHJKMNPQRSTV
botpress_file_getGet one file's metadata, size, status and download URL.Read-onlyGet File
Get one file's metadata, size, status and download URL. Returns file. Get the ID from botpress_files_list.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- File ID or Key. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
botpress_files_listList a bot's files (knowledge base documents and assets), optionally by IDs or indexing state.Read-onlyList Files
List a bot's files (knowledge base documents and assets), optionally by IDs or indexing state. Returns files, meta. Use botpress_files_search to search inside indexed files.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idsarray- Filter files by IDs. Example: ["file_01HZX5K9ABCDEF"]
indexedboolean- Filter files by indexing state. Example: true
next_tokenstring- Provide the meta.nextToken value provided in the last API response to retrieve the next page of results. Example: eyJsYXN0SWQiOiJhYmMifQ
page_sizeinteger- Number of items to return per page (default 20, max 100) Example: 20
sort_directionstring- Sort results in this direction. One of: asc, desc. Example: ascone of
ascdesc sort_fieldstring- Sort results by this field. One of: key, size, createdAt, updatedAt, status. Example: keyone of
keysizecreatedAtupdatedAtstatus
botpress_files_searchSearch the bot's indexed files in natural language and return the matching text passages.Read-onlySearch Files
Search the bot's indexed files in natural language and return the matching text passages. Returns passages. Use this for retrieval over the knowledge base.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
querystringrequired- Query expressed in natural language to retrieve matching text passages within all indexed files in the bot using semantical search. Example: refund policy
consolidateboolean- Consolidate the results by merging matching passages from the same file into a single passage per file. The consolidated passage will include the matching passages ordered by their original position in the file (rather than by relevance score) and include hierarchical context such as the title/subtitle to which they belong. Example: true
context_depthinteger- The number of neighbor passages to prepend and append as surrounding context to the content of each returned passage (default: 1, minimum: 0, maximum: 10). Example: 10
include_breadcrumbboolean- Prepend a breadcrumb to each passage, containing the title and subtitle(s) the passage belongs to in the file. This option is ignored when the consolidate option is set to true. Example: true
limitinteger- The maximum number of passages to return. Example: 20
with_contextboolean- Include the surrounding context with each passage in the context property of each passage. Not supported when consolidate is set to true. Example: true
botpress_hub_integration_getGet one public Hub integration with its actions, events and channels.Read-onlyGet Hub Integration
Get one public Hub integration with its actions, events and channels. Returns integration. Get the ID from botpress_hub_integrations_list.
Inputs
idstringrequired- Integration Version ID. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
botpress_hub_integrations_listList or search the public integrations in the Botpress Hub.Read-onlyList Hub Integrations
List or search the public integrations in the Botpress Hub. Returns integrations, meta. Use this to find integration names and versions.
Inputs
directionstring- Sort direction (asc or desc) One of: asc, desc. Example: ascone of
ascdesc installed_by_bot_idstring- Bot ID. Required when filtering for installed integrations. Example: 12345
interface_idstring- Filter integrations by implemented interface ID. Example: 12345
interface_namestring- Filter integrations by implemented interface name (strict match) Example: Example name
limitnumber- Maximum number of results to return per page. Example: 20
namestring- Integration Name. Example: LeadsTable
next_tokenstring- Provide the meta.nextToken value provided in the last API response to retrieve the next page of results. Example: eyJsYXN0SWQiOiJhYmMifQ
page_sizeinteger- Number of items to return per page (default 20, max 100) Example: 20
searchstring- Search integrations by name, description, actions, and interfaces. Responses include a matchedOn field indicating which fields matched the search. Example: hubspot
sort_bystring- Sort integrations by field. One of: popularity, name, createdAt, updatedAt, installCount. Example: popularityone of
popularitynamecreatedAtupdatedAtinstallCount verification_statusstring- Filter integrations by verification status. One of: unapproved, pending, approved, rejected. Example: unapprovedone of
unapprovedpendingapprovedrejected versionstring- Integration version. Either a semver version or tag "latest". Example: latest
botpress_message_getGet one message with its payload, type, user and tags.Read-onlyGet Message
Get one message with its payload, type, user and tags. Returns message. Get the ID from botpress_messages_list.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- Id of the Message. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
botpress_messages_listList messages, newest first, optionally for one conversation and date range.Read-onlyList Messages
List messages, newest first, optionally for one conversation and date range. Returns messages, meta. Pass conversation_id to read one conversation.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
after_datestring- Date in ISO 8601 string with UTC timezone after which the message was created (inclusive) Example: 2026-01-01T00:00:00Z
before_datestring- Date in ISO 8601 string with UTC timezone before which the message was created (inclusive) Example: 2026-01-31T23:59:59Z
conversation_idstring- Conversation id. Example: conv_01HZX5K9ABCDEF1234567890
next_tokenstring- Provide the meta.nextToken value provided in the last API response to retrieve the next page of results. Example: eyJsYXN0SWQiOiJhYmMifQ
page_sizeinteger- Number of items to return per page (default 20, max 100) Example: 20
botpress_participants_listList the users taking part in a conversation.Read-onlyList Participants
List the users taking part in a conversation. Returns participants, meta. Get the conversation ID from botpress_conversations_list.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- Conversation id. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
next_tokenstring- Provide the meta.nextToken value provided in the last API response to retrieve the next page of results. Example: eyJsYXN0SWQiOiJhYmMifQ
page_sizeinteger- Number of items to return per page (default 20, max 100) Example: 20
botpress_row_getGet one table row by its numeric ID.Read-onlyGet Row
Get one table row by its numeric ID. Returns row. Get the table name or ID from botpress_tables_list.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idintegerrequired- Identifier of the row within the table. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
tablestringrequired- The table's name or unique identifier for targeting specific table operations. Example: LeadsTable
botpress_rows_findFind table rows with a MongoDB-style filter, text search, column selection, sorting, grouping and paging.Read-onlyFind Rows
Find table rows with a MongoDB-style filter, text search, column selection, sorting, grouping and paging. Returns rows, hasMore, offset, limit, warnings. Use this to query a table. Get the table name or ID from botpress_tables_list.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
tablestringrequired- The table's name or unique identifier for targeting specific table operations. Example: LeadsTable
filterobject- Provide a mongodb-like filter to apply to the query. Example: \{ "name": \{ "$eq": "John" \} \}.
groupobject- Group the rows by a specific column and apply aggregations to them. Allowed values: key, avg, max, min, sum, count. Example: \{ "someId": "key", "orders": ["sum", "avg"] \}.
limitinteger- Limit for pagination, specifying the maximum number of rows to return. Example: 20
offsetinteger- Offset for pagination, specifying where to start returning rows from. Example: 0
order_bystring- Specifies the column by which to order the results. By default it is ordered by id. Build-in columns: id, createdAt, updatedAt. Example: createdAt
order_directionstring- Specifies the direction of sorting, either ascending or descending. One of: asc, desc. Example: ascone of
ascdesc searchstring- Search term to apply to the row search. When using this parameter, some rows which doesn't match the search term will be returned, use the similarity field to know how much the row matches the search term. Example: hubspot
selectarray- Specify which columns to return in the response. Supports both top-level columns (e.g., "name") and nested attributes using dot notation (e.g., "attributes.price"). System columns (id, createdAt, updatedAt, etc.) are always included. If omitted, all columns are returned. Example: ["email", "score"]
botpress_state_getGet a named state object for a conversation, user, bot, integration or workflow.Read-onlyGet State
Get a named state object for a conversation, user, bot, integration or workflow. Returns state, meta. State names are declared in the bot definition.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- Id of the State which will be either the botId, the userId or the conversationId. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
namestringrequired- Name of the State which is declared inside the bot definition. Example: LeadsTable
typestringrequired- Represents the resource type that the state is related to. One of: conversation, user, bot, integration, workflow. Example: textone of
conversationuserbotintegrationworkflow
botpress_table_getGet one table with its schema and row count.Read-onlyGet Table
Get one table with its schema and row count. Returns table, rows, stale, indexing. Get the table name or ID from botpress_tables_list.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
tablestringrequired- The table's name or unique identifier for targeting specific table operations. Example: LeadsTable
botpress_tables_listList the tables of a bot.Read-onlyList Tables
List the tables of a bot. Returns tables. Use this to find a table name for the row tools.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
botpress_user_getGet one end user with name, picture and tags.Read-onlyGet User
Get one end user with name, picture and tags. Returns user. Get the ID from botpress_users_list.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- User ID. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
botpress_users_listList the end users who talked to a bot, optionally for one conversation.Read-onlyList Users
List the end users who talked to a bot, optionally for one conversation. Returns users, meta. Use botpress_user_get for one user.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
after_datestring- Date in ISO 8601 string with UTC timezone after which the user was created or updated (inclusive) Example: 2026-01-01T00:00:00Z
before_datestring- Date in ISO 8601 string with UTC timezone before which the user was created or updated (inclusive) Example: 2026-01-31T23:59:59Z
conversation_idstring- Filter by conversation id. This will return all users that have participated in the conversation. Example: conv_01HZX5K9ABCDEF1234567890
next_tokenstring- Provide the meta.nextToken value provided in the last API response to retrieve the next page of results. Example: eyJsYXN0SWQiOiJhYmMifQ
page_sizeinteger- Number of items to return per page (default 20, max 100) Example: 20
range_fieldstring- Field used for range filtering. Allowed values are "updatedAt" or "createdAt". Defaults to "createdAt" if omitted. Example: updatedAtone of
updatedAtcreatedAt sort_directionstring- Sort results in this direction. One of: asc, desc. Example: ascone of
ascdesc sort_fieldstring- Sort results by this field. One of: updatedAt, createdAt. Example: updatedAtone of
updatedAtcreatedAt
botpress_workspace_audit_records_listList a workspace's audit records, newest first.Read-onlyList Audit Records
List a workspace's audit records, newest first. Returns records, meta. Get the ID from botpress_workspaces_list.
Inputs
idstringrequired- Workspace ID. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
next_tokenstring- Provide the meta.nextToken value provided in the last API response to retrieve the next page of results. Example: eyJsYXN0SWQiOiJhYmMifQ
page_sizeinteger- Number of items to return per page (default 20, max 100) Example: 20
botpress_workspace_getGet one workspace with its plan, owner and limits.Read-onlyGet Workspace
Get one workspace with its plan, owner and limits. Returns id, name, ownerId, createdAt, updatedAt, botCount, billingVersion, plan, blocked, spendingLimit. Get the ID from botpress_workspaces_list.
Inputs
idstringrequired- Workspace ID. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
botpress_workspace_members_listList the members of a workspace with their roles.Read-onlyList Workspace Members
List the members of a workspace with their roles. Returns members, meta. Use this to see who has access.
Inputs
workspace_idstringrequired- ID of the Botpress workspace, sent in the x-workspace-id header. Get it from botpress_workspaces_list. Example: wkspace_01HZX5K9ABCDEF1234567890
next_tokenstring- Provide the meta.nextToken value provided in the last API response to retrieve the next page of results. Example: eyJsYXN0SWQiOiJhYmMifQ
page_sizeinteger- Number of items to return per page (default 20, max 100) Example: 20
botpress_workspaces_listList the workspaces the account belongs to.Read-onlyList Workspaces
List the workspaces the account belongs to. Returns workspaces, meta. Use this to get the workspace ID other admin tools need.
Inputs
handlestring- Workspace handle. Example: example
next_tokenstring- Provide the meta.nextToken value provided in the last API response to retrieve the next page of results. Example: eyJsYXN0SWQiOiJhYmMifQ
page_sizeinteger- Number of items to return per page (default 20, max 100) Example: 20
botpress_action_callCall an action of an integration installed on the bot, for example telegram:sendMessage, with its input object.WriteCall Action
Call an action of an integration installed on the bot, for example telegram:sendMessage, with its input object. Returns output, meta. Use botpress_hub_integration_get to see an integration's actions and input schema.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
inputobjectrequired- Input of the action. Example: {"conversationId": "conv_01HZX5K9ABCDEF1234567890"}
typestringrequired- Type of the action. Example: text
botpress_bot_createCreate an empty bot in a workspace with a name, description and tags.WriteCreate Bot
Create an empty bot in a workspace with a name, description and tags. Returns bot. Build its flows in Botpress Studio afterwards.
Inputs
workspace_idstringrequired- ID of the Botpress workspace, sent in the x-workspace-id header. Get it from botpress_workspaces_list. Example: wkspace_01HZX5K9ABCDEF1234567890
descriptionstring- Optional description for the bot. Example: Support bot for the help center
namestring- Optional name for the bot, if not provided will be auto-generated. Example: LeadsTable
tagsobject- Optional attributes of the Bot. Example: {"source": "api"}
botpress_bot_updateRename a bot or change its description, tags, blocked or always-alive flags.WriteUpdate Bot
Rename a bot or change its description, tags, blocked or always-alive flags. Returns bot. Get the bot ID from botpress_bots_list.
- Idempotent
Inputs
idstringrequired- Bot ID. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
workspace_idstringrequired- ID of the Botpress workspace, sent in the x-workspace-id header. Get it from botpress_workspaces_list. Example: wkspace_01HZX5K9ABCDEF1234567890
always_aliveboolean- Indicates if the Bot should be in always alive mode. Example: true
blockedboolean- Blocked. Example: true
descriptionstring- Optional description for the bot. Example: Support bot for the help center
namestring- Optional name for the bot, if not provided will be auto-generated. Example: LeadsTable
tagsobject- Optional attributes of the Bot. Set to null or empty string to remove. Example: {"source": "api"}
botpress_conversation_createCreate a conversation on a channel with the tags its integration requires.WriteCreate Conversation
Create a conversation on a channel with the tags its integration requires. Returns conversation. Most integrations create conversations through their own actions; see botpress_action_call.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
channelstringrequired- Channel name. Example: channel
tagsobjectrequired- Tags for the Conversation. Example: {"source": "api"}
propertiesobject- EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Example: {"plan": "pro"}
botpress_conversation_updateUpdate a conversation's tags or shared properties.WriteUpdate Conversation
Update a conversation's tags or shared properties. Returns conversation. Get the conversation ID from botpress_conversations_list.
- Idempotent
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- Conversation id. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
propertiesobject- EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them. Example: {"plan": "pro"}
tagsobject- Tags for the Conversation. Set to null or empty string to remove. Example: {"source": "api"}
botpress_event_createSend a custom event to a bot, now or scheduled, optionally linked to a conversation, user, workflow or message.WriteCreate Event
Send a custom event to a bot, now or scheduled, optionally linked to a conversation, user, workflow or message. Returns event. The event type must be one the bot or an installed integration defines.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
payloadobjectrequired- Payload is the content of the event defined by the integration installed on your bot or one of the default events created by our API. Example: {"text": "Hello from the API"}
typestringrequired- Type of the Event. Example: text
conversation_idstring- ID of the Conversation to link the event to. Example: conv_01HZX5K9ABCDEF1234567890
message_idstring- ID of the Message to link the event to. Example: msg_01HZX5K9ABCDEF1234567890
scheduleobject- Schedule the Event to be sent at a specific time. Either dateTime or delay must be provided. Example: {"delay": 60000}
user_idstring- ID of the User to link the event to. Example: user_01HZX5K9ABCDEF1234567890
workflow_idstring- ID of the Workflow to link the event to. Example: wf_01HZX5K9ABCDEFGHJKMNPQRSTV
botpress_file_updateUpdate a file's tags, access policies or expiry without changing its content.WriteUpdate File Metadata
Update a file's tags, access policies or expiry without changing its content. Returns file. Get the ID from botpress_files_list.
- Idempotent
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- File ID or Key. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
access_policiesarray- New access policies to set for the file. Omit to keep existing policies intact. Example: ["integrations"]
expires_atstring- Expiry timestamp in ISO 8601 format with UTC timezone. After expiry, the File will be deleted. Must be in the future. Cannot be more than 90 days from now. The value up to minutes is considered. Seconds and milliseconds are ignored. Omit to keep the existing expiry intact. Set to null to remove the expiry. Example: 2026-12-31T00:00:00Z
tagsobject- The file tags to update as an object of key-value pairs with string (text) values. Omit to keep existing tags intact. Any existing tags not included will be preserved. New tags will be added. To delete a tag, set its value to null. Example: {"source": "api"}
botpress_message_createPost a message into a conversation as a user, with a payload such as text, image, choice or card and the tags the integration requires.WriteCreate Message
Post a message into a conversation as a user, with a payload such as text, image, choice or card and the tags the integration requires. Returns message. Get the conversation and user IDs from botpress_conversations_list and botpress_users_list.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
conversation_idstringrequired- ID of the Conversation. Example: conv_01HZX5K9ABCDEF1234567890
payloadobjectrequired- Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location. Example: {"text": "Hello from the API"}
tagsobjectrequired- Set of Tags that you can attach to a Message. The set of Tags available on a Message is restricted by the list of Tags defined previously by the Bot. Individual keys can be unset by posting an empty value to them. Example: {"source": "api"}
typestringrequired- Type of the Message represents the resource type that the message is related to. Example: text
user_idstringrequired- ID of the User. Example: user_01HZX5K9ABCDEF1234567890
originstring- Origin. One of: synthetic. Example: syntheticone of
synthetic scheduleobject- Schedule the Message to be sent at a specific time. Either dateTime or delay must be provided. Example: {"delay": 60000}
botpress_message_updateUpdate a message's payload or tags.WriteUpdate Message
Update a message's payload or tags. Its type cannot change. Returns message. Get the ID from botpress_messages_list.
- Idempotent
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- Message id. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
payloadobject- Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location. Example: {"text": "Hello from the API"}
tagsobject- Set of Tags that you can attach to a Message. The set of Tags available on a Message is restricted by the list of Tags defined previously by the Bot. Set to null or empty string to remove. Example: {"source": "api"}
botpress_participant_addAdd a user to a conversation.WriteAdd Participant
Add a user to a conversation. Returns participant. Get the user ID from botpress_users_list.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- Conversation id. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
user_idstringrequired- User id. Example: user_01HZX5K9ABCDEF1234567890
botpress_rows_createInsert one or more rows into a table.WriteCreate Rows
Insert one or more rows into a table. Returns rows, warnings, errors. Use botpress_rows_upsert to insert or update by key. Get the table name or ID from botpress_tables_list.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
rowsarrayrequired- Rows. Example: [{"email": "jane@example.com", "score": 42}]
tablestringrequired- The table's name or unique identifier for targeting specific table operations. Example: LeadsTable
wait_computedboolean- Ensure computed columns are fully processed before returning the result. This is applicable only when the number of rows involved is fewer than 1. Example: true
botpress_rows_updateUpdate rows by ID.WriteUpdate Rows
Update rows by ID. Each row object carries its id plus the columns to change. Returns rows, warnings, errors. Get row IDs from botpress_rows_find.
- Idempotent
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
rowsarrayrequired- Rows with updated data, identified by ID. Example: [{"id": 1, "score": 50}]
tablestringrequired- The table's name or unique identifier for targeting specific table operations. Example: LeadsTable
wait_computedboolean- Ensure computed columns are fully processed before returning the result. This is applicable only when the number of rows involved is fewer than 1. Example: true
botpress_rows_upsertInsert rows, or update existing ones that match on a key column.WriteUpsert Rows
Insert rows, or update existing ones that match on a key column. Returns inserted, updated, warnings, errors. Get the table name or ID from botpress_tables_list.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
rowsarrayrequired- Rows. Example: [{"email": "jane@example.com", "score": 42}]
tablestringrequired- The table's name or unique identifier for targeting specific table operations. Example: LeadsTable
key_columnstring- Determines if a row is inserted or updated. Defaults to "id". Example: email
wait_computedboolean- Ensure computed columns are fully processed before returning the result. This is applicable only when the number of rows involved is fewer than 1. Example: true
botpress_state_setReplace a named state object with a new payload, optionally expiring after idle time.WriteSet State
Replace a named state object with a new payload, optionally expiring after idle time. Returns state. Use botpress_state_get to read it first.
- Idempotent
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- Id of the State which will be either the botId, the userId or the conversationId. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
namestringrequired- Name of the State which is declared inside the bot definition. Example: LeadsTable
payloadobjectrequired- Payload is the content of the state defined by your bot. Example: {"text": "Hello from the API"}
typestringrequired- Represents the resource type that the state is related to. One of: conversation, user, bot, integration, workflow. Example: textone of
conversationuserbotintegrationworkflow expirynumber- Expiry of the State in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire. Example: 3600000
botpress_table_column_renameRename a column in a table.WriteRename Table Column
Rename a column in a table. Returns table. Get the table name or ID from botpress_tables_list.
- Idempotent
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
namestringrequired- The existing name of the column. Example: LeadsTable
new_namestringrequired- The new name to assign to the column. Example: email_address
tablestringrequired- The table's name or unique identifier for targeting specific table operations. Example: LeadsTable
botpress_table_createCreate a table from a JSON schema of columns (up to 20), with optional key column and tags.WriteCreate Table
Create a table from a JSON schema of columns (up to 20), with optional key column and tags. Returns table. Use botpress_rows_create to add rows.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
namestringrequired- Required. This name is used to identify your table. Example: LeadsTable
schemaobjectrequired- Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed. Example: {"type": "object", "properties": {"email": {"type": "string"}, "score": {"type": "number"}}}
factornumber- The 'factor' multiplies the row's data storage limit by 4KB and its quota count. It can only be increased (not decreased) after table creation via updateTable. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1. Example: 1
frozenboolean- A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations. Example: true
is_compute_enabledboolean- Indicates if the table is enabled for computation. Example: true
key_columnstring- Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed. Example: email
tagsobject- Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs. Example: {"source": "api"}
botpress_table_updateRename a table or change its schema, key column, frozen flag or tags.WriteUpdate Table
Rename a table or change its schema, key column, frozen flag or tags. Returns table, staleColumns, job. Get the table name or ID from botpress_tables_list.
- Idempotent
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
tablestringrequired- The table's name or unique identifier for targeting specific table operations. Example: LeadsTable
factornumber- The 'factor' multiplies the row's data storage limit by 4KB and its quota count. It can only be increased, not decreased. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. Example: 10
frozenboolean- A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations. Example: true
is_compute_enabledboolean- Indicates if the table is enabled for computation. Example: true
key_columnstring- Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed. Example: email
namestring- Required. This name is used to identify your table. Example: LeadsTable
schemaobject- Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed. Example: {"type": "object", "properties": {"email": {"type": "string"}, "score": {"type": "number"}}}
tagsobject- Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs. Example: {"source": "api"}
botpress_user_createCreate an end user with the tags its integration requires, plus a name and picture.WriteCreate User
Create an end user with the tags its integration requires, plus a name and picture. Returns user. Use botpress_user_update to change one.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
tagsobjectrequired- Tags for the User. Example: {"source": "api"}
namestring- Name of the user. Example: LeadsTable
picture_urlstring- URI of the user picture. Example: https://example.com/avatar.png
propertiesobject- EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Example: {"plan": "pro"}
botpress_user_updateUpdate an end user's name, picture, tags or shared properties.WriteUpdate User
Update an end user's name, picture, tags or shared properties. Returns user. Get the ID from botpress_users_list.
- Idempotent
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- User ID. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
namestring- Name of the user. Example: LeadsTable
picture_urlstring- URI of the user picture. Example: https://example.com/avatar.png
propertiesobject- EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them. Example: {"plan": "pro"}
tagsobject- Tags for the User. Set to null or empty string to remove. Example: {"source": "api"}
botpress_bot_deleteDelete a bot and its data.DestructiveDelete Bot
Delete a bot and its data. Get the bot ID from botpress_bots_list.
- Idempotent
Inputs
idstringrequired- Bot ID. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
workspace_idstringrequired- ID of the Botpress workspace, sent in the x-workspace-id header. Get it from botpress_workspaces_list. Example: wkspace_01HZX5K9ABCDEF1234567890
botpress_conversation_deleteDelete a conversation and its messages.DestructiveDelete Conversation
Delete a conversation and its messages. Get the conversation ID from botpress_conversations_list.
- Idempotent
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- Conversation id. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
botpress_file_deleteDelete a file.DestructiveDelete File
Delete a file. Get the ID from botpress_files_list.
- Idempotent
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- File ID or Key. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
botpress_message_deleteDelete a message.DestructiveDelete Message
Delete a message. Get the ID from botpress_messages_list.
- Idempotent
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- Message id. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
botpress_participant_removeRemove a user from a conversation.DestructiveRemove Participant
Remove a user from a conversation. Get the conversation ID from botpress_conversations_list.
- Idempotent
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- Conversation id. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
user_idstringrequired- User id. Example: user_01HZX5K9ABCDEF1234567890
botpress_rows_deleteDelete rows by ID, by filter, or all rows of a table.DestructiveDelete Rows
Delete rows by ID, by filter, or all rows of a table. Returns deletedRows, job. Deleting by filter runs in the background. Get the table name or ID from botpress_tables_list.
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
tablestringrequired- The table's name or unique identifier for targeting specific table operations. Example: LeadsTable
delete_all_rowsboolean- Flag to delete all rows. Use with caution as this action is irreversible. Example: true
filterobject- Filter to apply when deleting rows. Deletion with a filter is performed asynchronously in batches and returns a job object to track progress. Example: \{ "createdAt": \{ "$lt": "2026-01-01" \} \}.
idsarray- IDs. Example: [1, 2]
botpress_table_deleteDelete a table and all its rows.DestructiveDelete Table
Delete a table and all its rows. Get the table name or ID from botpress_tables_list.
- Idempotent
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
tablestringrequired- The table's name or unique identifier for targeting specific table operations. Example: LeadsTable
botpress_user_deleteDelete an end user.DestructiveDelete User
Delete an end user. Get the ID from botpress_users_list.
- Idempotent
Inputs
bot_idstringrequired- ID of the Botpress bot to act on, sent in the x-bot-id header. Get it from botpress_bots_list or the bot's URL in Botpress Studio. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
idstringrequired- User ID. Example: 8f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
No tools match.