Get TeleBotHost API health and status. Returns version, health status, and active environment. No authentication required.

Get a user's public profile (fullname, username, location, bio, avatar). No authentication required.

List a user's published bots (bot templates + community store listings). Each item includes listing_type to distinguish them. No authentication required.

Get full details for one published bot by its Telegram username. Includes description, README, commands, and env placeholders. No authentication required.

Get only the description and README markdown for a published bot. No authentication required.

Browse shareable bot blueprints (listing_type: bot_template). No authentication required.

Get one shareable bot template by ID, including description, README, commands, and env placeholders. No authentication required.

Get the public description and README markdown for a template bot. No authentication required.

Browse the community bot store (public). Same data as the authenticated store list but requires no login. No authentication required.

Get one community store listing by its store meta ID. No authentication required.

List all bots belonging to the authenticated user, with statistics. Requires API key.

Register a new bot under your account. Requires sk_* (write) key. Subject to plan-based creation rate limits (e.g. 1 request per 5 min on FREE).

Soft-delete one or more bots (moved to 10-day backup during which they can be recovered). Requires sk_* key.

List all soft-deleted bots in your 10-day backup window.

Restore a soft-deleted bot from backup. The bot is recovered with status 0 (disabled) for safety.

Permanently delete a soft-deleted bot and all associated logs, users, and session records from backup. Irreversible.

Pin or unpin one or more bots. Requires sk_* key.

Get detailed profile of a specific bot by ID.

Update bot configuration (name, token, pin, status). Requires sk_* key.

Generate a temporary JWT token and download URL for exporting a bot configuration as ZIP (bot.yaml, .env, commands/). The URL is time-limited. Use download_bot with the returned token to fetch the actual ZIP.

Download a bot configuration ZIP package (bot.yaml, .env, commands/) using a temporary JWT token from export_bot. Returns the ZIP as base64-encoded binary. Save the base64 field to a file and decode it to get the ZIP. No API key required (uses JWT).

Import a bot from a ZIP package. The ZIP must contain bot.yaml, .env, and commands/ directory (same structure as exported by export_bot/download_bot). Provide the ZIP as base64-encoded string. Requires sk_* key. Subject to plan-based creation rate limits (e.g. 1 request per 5 min on FREE).

Clone an owned bot or a public template bot under your account. Subject to cloning rate limits (1/sec, 5/min, 20/hr). Requires sk_* key.

Clone a bot as a child bot. Child bots dynamically inherit environment variables and commands/folders from the parent without copying. Requires sk_* key. Subject to cloning rate limits.

List all child bots registered under the specified parent bot.

Transfer a bot to another user (by email or user ID). The bot is actually cloned into the target's account with blank credentials and reset env vars; the original is preserved.

Reset bot logs, sessions, and flag all bot users as just-created. Requires sk_* key.

Toggle the is_template flag for a bot. Templates can be shared publicly and cloned by others.

Get the description and README markdown for a bot (owner-only).

Update bot description and README markdown. Only allowed if the bot is marked as a template. Description max 500 chars, README max 50000 chars.

Get sync and async storage size and key metrics for a bot and its users.

List bot storage keys (without values) for sync and async storage.

Permanently delete all sync and async props for the bot and its user props. Irreversible. Requires sk_* key.

Migrate sync Bot.setProp data to async db.xx storage. Supports dry-run preview. Options: scope (bot|user|both), dryRun, overwrite, deleteSource.

Start a broadcast job that sends a message to all bot subscribers matching the given filters. ⚠️ This sends real Telegram messages to many users — use with caution.

Get real-time progress metrics and status of a broadcast job.

Stop an actively processing broadcast job immediately.

Modify the message body for pending batches of an active broadcast mid-run.

Delete a completed or stopped broadcast tracking record and clean Redis keys.

List all broadcasts queued or run for a specific bot. Optional status filter.

List all commands and command folders registered for a bot.

Create a new bot command. Subject to creation rate limits (10/sec, 30/min, 200/hr) and bot capacity cap (1000 commands, 10MB total).

Delete one or more commands from a bot in a single batch operation.

List all soft-deleted commands for a bot (recoverable for 7 days).

Restore a soft-deleted command by its deletion record ID back into the bot's active commands.

List bots in the community store, sorted by popularity (install count). Authenticated endpoint.

Install a community store bot into your account. Environment values are cleared and must be configured after install. Subject to store install rate limits (1/sec, 5/min, 20/hr). Requires sk_* key.

Check your current rate-limit quota (daily, per-minute, monthly). Makes a lightweight GET /bot call and returns the X-RateLimit-* headers from the response.