GramIO API Reference

TypeScript API reference auto-generated from the .d.ts files of all GramIO packages. Browse classes, interfaces, type aliases, and their full signatures.

Tip: Looking for Telegram Bot API types and method parameters? See the Telegram API Reference which documents the official Bot API from a Telegram perspective.

Core Packages

Package	Description
gramio	Main Bot class and core re-exports
@gramio/contexts	All context classes (MessageContext, CallbackQueryContext, etc.) — most important for bot development
@gramio/keyboards	Keyboard, InlineKeyboard, RemoveKeyboard, ForceReply builders
@gramio/files	MediaUpload, MediaInput — file upload helpers
@gramio/format	format, bold, italic, code, and other text formatting utilities
@gramio/callback-data	CallbackData — type-safe callback data builder
@gramio/composer	Composer — standalone middleware composer

Plugin Packages

Package	Description
@gramio/scenes	Scene-based conversation flows
@gramio/session	Session storage plugin
@gramio/storage	Storage adapter interface
@gramio/i18n	Internationalization plugin
@gramio/autoload	Auto-load handlers from files
@gramio/auto-retry	Automatic retry on Telegram API errors
@gramio/prompt	Prompt for user input within handlers
@gramio/init-data	Telegram Mini App init data validation

Most-Used Classes

Quick links to the most frequently referenced types:

• MessageContext — handler context for incoming messages
• InlineKeyboard — inline keyboard builder
• Keyboard — reply keyboard builder
• Bot — main bot class
• format — tagged template literal for formatting

Generation

These pages are auto-generated by TypeDoc with typedoc-plugin-markdown and typedoc-vitepress-theme.

Run locally:

bun run gen:typedoc