> ## Documentation Index
> Fetch the complete documentation index at: https://praison.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Bot OS Protocol • AI Agent SDK

> BotOSProtocol: Protocol for BotOS — multi-platform bot orchestrator.

# BotOSProtocol

> Defined in the [**protocols**](https://praison.ai/docs/sdk/reference/praisonaiagents/modules/protocols.md) module.

AI Agent

Protocol for BotOS — multi-platform bot orchestrator.

BotOS manages multiple Bot instances across different messaging
platforms (Telegram, Discord, Slack, WhatsApp, etc.) with a single
unified lifecycle.

Hierarchy::

BotOS  (multi-platform orchestrator)
└── Bot  (single platform)
└── Agent / AgentTeam / AgentFlow  (AI brain)

Implementations live in the `praisonai-bot` package (`praisonai_bot.bots`).

## Methods

> [card] [is\_running()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/BotOSProtocol-is_running.md)
>
> Whether the orchestrator is currently running.

> [card] [start()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/BotOSProtocol-start.md)
>
> Start all registered bots concurrently.

> [card] [stop()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/BotOSProtocol-stop.md)
>
> Gracefully stop all running bots.

> [card] [add\_bot()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/BotOSProtocol-add_bot.md)
>
> Register a Bot instance for orchestration.

> [card] [list\_bots()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/BotOSProtocol-list_bots.md)
>
> List platform names of all registered bots.

> [card] [remove\_bot()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/BotOSProtocol-remove_bot.md)
>
> Remove a registered bot by platform name.

> [card] [get\_bot()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/BotOSProtocol-get_bot.md)
>
> Get a registered bot by platform name.

## Source

> [card] [View on GitHub](https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-agents/praisonaiagents/bots/protocols.py#L1527)
>
> `praisonaiagents/bots/protocols.py` at line 1527


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.