list_bots
List Bots
List all bots in a Botpress workspace. Returns bot names, IDs, deployment status, and timestamps. Supports pagination for workspaces with many bots.
list_bots
List all bots in a Botpress workspace. Returns bot names, IDs, deployment status, and timestamps. Supports pagination for workspaces with many bots.
manage_state
Get or set persistent state for a bot. State is a key-value store scoped to a conversation, user, bot, or workflow. Useful for maintaining context across interactions.
manage_files
List, retrieve, delete, or search files in a bot's file storage. Use **search** for semantic/RAG search across indexed knowledge base files. Use **upsert** to create or update file metadata (returns an upload URL for content upload).
list_bot_issues
List or retrieve issues reported for a bot. Issues help diagnose and track problems with bot behavior and conversation flows.
send_message
Send a message to a conversation via the Runtime API. Supports text, image, audio, video, file, location, card, carousel, choice, and dropdown message types. The **payload** must match the expected format for the given **messageType**.
manage_table_rows
Create, read, update, delete, upsert, or search rows in a Botpress table. Use **find** for filtered or semantic search queries. Use **upsert** for idempotent inserts using a key column.
manage_bot
Create, retrieve, update, or delete a Botpress bot. Use **action** to specify the operation. For updates, provide only the fields you want to change.
list_messages
List messages in a bot's conversations. Optionally filter by conversation ID. Returns message content, sender, timestamps, and direction (incoming/outgoing).
get_bot_analytics
Retrieve analytics data for a bot including conversation counts, message volumes, and user engagement metrics. Optionally filter by date range.
list_integrations
List available integrations in a Botpress workspace. Search by name, filter by visibility (public/private), or retrieve a specific integration by ID or name.
manage_table
Create, retrieve, update, delete, or list tables in a bot's structured data store. Tables are used to store custom data like user profiles, labels, or extracted content.
create_event
Send an event to a bot for asynchronous processing. Events trigger bot workflows and can be scoped to a conversation or user. Use this to push external data or signals into a bot.
manage_user
Create, retrieve, update, delete, or list bot users via the Runtime API. Users represent people interacting with a bot within a specific integration.
manage_conversation
Create, retrieve, or list conversations for a bot. Conversations represent exchanges between users and a bot within an integration channel. Use **get-or-create** to idempotently ensure a conversation exists.
get_bot_logs
Retrieve activity logs for a bot. Useful for debugging, monitoring bot behavior, and auditing conversation flows.
Build, deploy, and manage AI-powered chatbots and conversational agents. Create and configure bots, manage conversations and messages across channels (WhatsApp, Slack, Telegram), handle users and participants, and store structured data in tables. Send and receive messages in various formats (text, image, audio, video, carousel, card, dropdown). Manage knowledge base files, trigger bot events via webhooks, execute bot actions, and maintain persistent state across conversations. Administer workspaces, collaborators, integrations, analytics, logs, and issue tracking.
Common questions about connecting Botpress to AI agents with Metorial.