Api¶

Your bot's direct line to Telegram — every sendMessage, editMessageText, and answerCallbackQuery the Bot API offers, without building HTTP requests yourself.

Type Api. and you're talking to Telegram. Chat IDs, tokens, and routing? Already handled.

What is Api?¶

Api is how your bot talks to Telegram. Every method maps to something in the Telegram Bot API — sendMessage, editMessageText, answerCallbackQuery, and hundreds of others.

Api is already there inside every command. No import, no setup.

How to use it¶

Drop this in any command's Logic field:

Api.sendMessage({ text: "Hey." })

That sends to whoever triggered the command — the platform fills in the chat automatically.

Pass a single object with the parameters Telegram expects:

Api.sendPhoto({
  photo: "https://example.com/photo.jpg",
  caption: "Here's the file you asked for.",
  parse_mode: "Markdown"
})

Most methods target the current chat — the conversation where the command fired. Pass chat_id only when you intentionally need a different destination, and only if your bot actually has access there.

Api or Bot?¶

Rough rule: if you're shaping what the user sees in Telegram, you're probably in Api territory. If you're deciding what your bot does next, look at Bot first.

Once you've seen both, the Bot vs Api guide goes deeper with side-by-side examples.

Command context (user, chat, message, …) comes from Global Variables — available in every command alongside Bot and Api.

Try it — copy-paste examples¶

Start simple. Each example only introduces what it needs.

Send a message¶

Api.sendMessage({ text: "Processing your request..." })

Edit the message you just sent¶

Some calls return a response you can chain:

let sent = await Api.sendMessage({ text: "Processing..." })
await sent.editText("Done.")

Answer a callback button¶

When a user taps an inline button:

Api.answerCallbackQuery({ text: "Got it!" })

Call any Telegram method¶

If a method exists in Telegram's docs but not yet as Api.methodName, use the generic caller:

Api.call("methodName", { /* params */ })

Validate another bot's token¶

Store tokens in dashboard ENV settings, then read via process.env:

let me = await Api.getMe({ bot_token: process.env.OTHER_BOT_TOKEN })

if (me.ok) {
  Bot.inspect(`Other bot: @${me.result.username}`)
}

ENV setup: process.env · Full list: Bot Admin Methods

Optional bot_token parameter¶

A set of bot-admin methods accept an optional bot_token field. When omitted, the call uses the current bot's token. When provided, the call runs against that token instead — useful for multi-bot setups, token validation, or managing another bot you own.

See Bot Admin Methods for the full list of methods that support bot_token.

Callbacks with on_run¶

Some calls support on_run, which hands off to another command when Telegram responds. Handy when you want to keep the current command short.

Bot API 10.1 support¶

The platform tracks Telegram's latest API. Highlights from Bot API 10.1:

Parameter shapes match the official Bot API reference. They're passed through to Telegram as-is.

Error behavior worth knowing¶

Call a method that doesn't exist — Api.hitMe() — and the platform throws. Your ! error handler catches it.

Send a message to a blocked user or pass a bad parameter, and Telegram returns an error. That usually doesn't crash the command; it shows up in your bot's error logs. Use await and check res.ok when failure would change what you do next. See Tips and Limitations.

What's in this section¶

Start with Sending Messages if you've never called Api before.