The standard way to develop a chatbot on Botpress Cloud is to use the Studio (opens in a new tab). It is a low-code platform; that is, the Studio allows you to create chatbots by writing little code, or even none at all.
To please developers, Botpress Cloud also allows you to develop chatbots with code only. This set of features is called the developer side of Botpress Cloud or the developer experience (DX).
In addition to allowing the development of Chatbots, the developer experience also allows the creation of Integrations. Integrations are applications that allow Chatbots to communicate with external services as well as share/reuse certain features. The only way to develop integrations is to do it with code.
The developer experience is composed of the following parts:
- the public HTTP API (opens in a new tab)
- the TypeScript HTTP Client (opens in a new tab)
- the TypeScript SDK (opens in a new tab)
- the CLI (opens in a new tab)
The public HTTP API of Botpress Cloud is already documented here (opens in a new tab).
To create a Chatbot or an Integration, you must call the create-bot (opens in a new tab) or create-integration (opens in a new tab) route of the API. The HTTP body of the request contains a
The SDK is an npm package that is used and executed with the code of the Bot or Integration. It facilitates development by providing functions and classes that frame your development. It is theoretically possible to develop a Bot or an Integration without using the SDK, but this is strongly discouraged.
The CLI wears several hats. It allows you to interact with the public HTTP API of Botpress Cloud and to develop/deploy Bots and Integrations. Just like the SDK, it is theoretically possible to do without it but this is strongly discouraged.
Since the public HTTP API of Botpress Cloud is already documented and the TypeScript HTTP Client only exposes it in an npm package, the next sections of this document will focus on the SDK and the CLI.