Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/botpress/botpress/llms.txt

Use this file to discover all available pages before exploring further.

Build AI agents and chatbots at lightning speed

Botpress is the open-source platform for building next-generation chatbots and AI agents powered by GPT, Claude, and other LLMs. Get your bot from idea to production in minutes with our TypeScript SDK and 67+ pre-built integrations.

Get startedExplore SDKView on GitHub

Quick start

Get your first bot running in under 5 minutes

1

Install the Botpress CLI

Install the CLI globally using your preferred package manager:
npm install -g @botpress/cli
2

Initialize a new bot project

Create a new bot from a template:
bp init
The CLI will prompt you to choose between creating a bot, integration, or plugin. Select bot to get started.
3

Run your bot in development mode

Start the development server to test your bot locally:
bp dev
Your bot is now running locally with hot-reload enabled. Any changes you make to the code will automatically update.
4

Deploy to Botpress Cloud

When you’re ready to deploy, authenticate and push your bot to the cloud:
bp login
bp deploy
You’ll need a free Botpress Cloud account. Sign up at app.botpress.cloud if you haven’t already.

Explore by topic

Jump into the documentation that matters most to you

Core concepts

Understand the architecture and fundamental concepts behind Botpress

Build bots

Learn how to create and configure bots using the SDK

Create integrations

Build custom integrations to connect your bots with external services

CLI reference

Complete reference for all Botpress CLI commands

SDK reference

Explore the TypeScript SDK API documentation

Integrations hub

Browse 67+ pre-built integrations for Slack, Discord, OpenAI, and more

Key features

Everything you need to build production-ready AI agents

LLM-powered

Native support for GPT-4, Claude, and other language models with streaming responses and function calling

TypeScript SDK

Fully type-safe SDK with auto-completion, built-in validation, and comprehensive API coverage

67+ integrations

Pre-built integrations for Slack, Discord, WhatsApp, OpenAI, Anthropic, and many more platforms

Cloud-native

Deploy to Botpress Cloud with one command, or self-host using Docker and Kubernetes

Ready to build your first bot?

Follow our quickstart guide to create and deploy a working chatbot in under 5 minutes, or explore the SDK documentation to learn about advanced features.

Start buildingJoin Discord community