# umbot

> A TypeScript framework for multi-platform chat bots and voice skills:
> Alice, Marusia, Sber SmartApp, Telegram, VK, MAX, Viber — one code base.
> The guides are machine-translated from Russian; the API reference is in Russian.
> Current version: 3.1.

Documentation: https://www.maxim-m.ru/docs/umbot/en/ | GitHub: https://github.com/max36895/umbot | npm: https://www.npmjs.com/package/umbot

## Guides

- [The umbot CLI for creating voice skills and chatbots](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/cli/README): A CLI utility for quickly creating and configuring projects based on the…
- [Full umbot performance test results](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/BENCHMARKS): All tests were run on a clean installation without network calls, external APIs or…
- [umbot FAQ](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/FAQ): Answers to frequent questions about the multi-platform umbot framework — choosing an…
- [umbot — a guide to building voice skills and chatbots](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/GUIDE): About this guide The guide takes you from installation to a working bot: how the…
- [Database adapters (DB adapters)](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/adapter/dbAdapter): The umbot framework does not know whether you use SQL, NoSQL or the file system.
- [Specification: external database adapters for umbot](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/adapter/external-db-adapter-spec): Status: a specification for the community / contributors.
- [Creating a platform adapter (Platform Adapter)](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/adapter/platformAdapter): A platform adapter is the bridge between the raw JSON/XML request of an external…
- [Extension architecture: plugins and adapters](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/adapter/readme): umbot has no strict separation between "adapters" and "plugins" at the core level.
- [umbot API reference](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/api-reference): This reference describes the main public classes, methods and interfaces of the umbot…
- [Configuration and security](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/configuration): To store tokens and other sensitive data securely, you can use two approaches:.
- [Deploying to production](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/deployment): Once a voice skill or chatbot is written and tested locally, you need to deploy it to…
- [Quick start: your first voice skill or chatbot with umbot](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/getting-started): This guide shows how to quickly build a multi-platform application for voice skills…
- [Customizing the HTTP layer](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/http-client): You can replace the built-in fetch with any compatible HTTP client via…
- [The flow.json format of the umbot visual editor](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/json-format): The full specification of the flow.json JSON format (an export from Umbot Flow ) for…
- [Middleware in umbot: handling a request before commands](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/middleware): umbot supports telegraf - and vk-io -style middleware — functions that are called…
- [Migrating from umbot 2.x to 3.0](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/migration-2x-to-3x): Version 3.0.0 is a major update focused on modularity, flexibility and modern…
- [Performance: what to expect and when to worry](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/performance-and-guarantees): umbot is designed with high performance and predictable response times in mind.
- [Platform contract check: official documentation umbot](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/platform-contract-comparison): Check date: 2026-08-29 .
- [Platform integration](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/platform-integration): The umbot framework provides a single API for building voice skills and chatbots on…
- [umbot recipes: ready-made solutions for common tasks](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/recipes): Short complete examples for frequent tasks: an echo skill, registration, a game with…
- [Testing your project](https://www.maxim-m.ru/docs/umbot/en/v-3.1/guides/testing): Go to the developer console and open the testing tab.

## API

- [Bot](https://www.maxim-m.ru/docs/umbot/en/v-3.1/classes/Bot): the entry point: registering platforms, commands, lifecycle
- [BotController](https://www.maxim-m.ru/docs/umbot/en/v-3.1/classes/BotController): the base controller class with the business logic
- [IAppConfig](https://www.maxim-m.ru/docs/umbot/en/v-3.1/interfaces/IAppConfig): the application configuration interface
- [IPlatformAdapter](https://www.maxim-m.ru/docs/umbot/en/v-3.1/interfaces/IPlatformAdapter): the platform adapter contract
- [Preload](https://www.maxim-m.ru/docs/umbot/en/v-3.1/classes/preload.Preload): preloading platform media files
- [Card](https://www.maxim-m.ru/docs/umbot/en/v-3.1/classes/Card): cards and galleries for all platforms
- [Buttons](https://www.maxim-m.ru/docs/umbot/en/v-3.1/classes/Buttons): buttons: plain, inline, with a payload
- [umbot API — class and interface reference by version](https://www.maxim-m.ru/docs/umbot/en/modules)
- [umbot framework documentation (home)](https://www.maxim-m.ru/docs/umbot/en/)