Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/TelegramOrg/Telegram-web-k/llms.txt

Use this file to discover all available pages before exploring further.

Telegram Web K is the official Telegram web client available at web.telegram.org/k. Built with TypeScript and SolidJS, it implements the MTProto v2 protocol directly in the browser — delivering the complete Telegram experience including voice calls, video messages, stickers, file transfers up to 4 GB, and Telegram Premium features — all without installing a native app.

Quick Start

Set up and run Telegram Web K locally in a few minutes

Configuration

API credentials, environment variables, and build options

Deployment

Deploy locally, with Docker, or to a production web server

Architecture

Understand the multi-worker architecture and key subsystems

​
What is Telegram Web K?

Telegram Web K (“K” for the Kotlin-inspired codebase style) is a ground-up rewrite of the original Webogram client. It runs entirely in the browser using:
  • MTProto v2 — Telegram’s binary protocol, implemented in TypeScript with a dedicated crypto Web Worker
  • Shared Web Worker — A single network connection shared across all browser tabs, keeping data in sync without redundant API calls
  • Service Worker — Background caching, push notifications, and large file streaming
  • SolidJS — Fine-grained reactive UI rendering for high-performance updates
  • rlottie (WASM) — Animated stickers rendered natively in the browser via WebAssembly

​
Key features

Messaging

Text formatting, replies, threads, scheduled messages, reactions, and message effects

Media & Files

Photos, videos, voice messages, files up to 4 GB, and Lottie-animated stickers

Calls

One-on-one voice and video calls, group calls, and RTMP live stream viewing

Privacy & Security

Secret chats, passcode lock, self-destructing messages, and privacy settings

​
Get started

1

Install dependencies

Clone the repository and install with pnpm:
git clone https://github.com/TelegramOrg/Telegram-web-k.git
cd Telegram-web-k
pnpm install
2

Configure API credentials

Copy the example environment file and add your Telegram API credentials from my.telegram.org:
cp .env.local.example .env.local
# Edit .env.local with your VITE_API_ID and VITE_API_HASH
3

Start the dev server

pnpm start
Open http://localhost:8080 in your browser and sign in with your Telegram account.
Telegram Web K requires a Telegram API ID and hash. Get yours free at my.telegram.org — registration takes under a minute.

Build docs developers (and LLMs) love

Get started for freeTalk to us