Skip to main content

Instances

An instance is a connection to a messaging channel — a WhatsApp number, a Discord bot, a Telegram bot, or a Slack workspace. Each instance has its own identity, session state, and message history.

Supported Channels

Instance Lifecycle

Creating an Instance

Connecting (WhatsApp)

WhatsApp instances require pairing via QR code or pairing code:

Managing Connections

Sync Operations

Sync imports contacts, groups, and message history from the channel:
For history backfill:

Instance Management

For advanced instance operations including profile, privacy, and group management, see the management CLI reference.

WhatsApp-Specific Features

omni instances delete and omni instances logout both invalidate the channel session — delete removes the row and history, logout keeps the row but clears credentials. Neither is recoverable; re-pairing requires going through QR/pair flow again.
Run omni instances whoami <id> right after pairing to confirm the connected phone/identity matches what you expect — pairing a wrong number is the most common silent setup failure.

See also

Management CLI

Full omni instances reference + WhatsApp pairing, sync, group management.

AI agent integration

Bind agents to instances via providers and routes.

Routes

Filter which messages reach the agent on each instance.