Telebase Docs

Onboarding & Setup Guide

Follow this 5-step checklist to configure your first serverless database, establish Telegram secure permanent storage, and generate authentication credentials.

Watch Setup Video

Document Summary

What it does

Explains step-by-step how to set up projects, configure Telegram bots, link private storage channels, retrieve API keys, and perform initial SQL table configuration.

When to use it

During first-time deployment of a new Telebase environment or connecting a new local development build.

Example

Create bot via @BotFather, retrieve private channel ID (usually starts with -100), configure API endpoints, and execute test post commands.

1

Create a New Project

Projects isolate your database tables, index, settings, and file assets. To create a new namespace:

  • Click the + New Project button inside the sidebar or dashboard.
  • Give your project a descriptive name (e.g. my-prod-db).
2

Configure Telegram Bot & Channel

Telebase uploads database state and file chunks as encrypted documents to a private Telegram channel.

A. Create a Bot
  1. Message @BotFather on Telegram.
  2. Send /newbot and follow the instructions.
  3. Copy the generated HTTP API Bot Token.
B. Create a Channel
  1. Create a new Telegram Channel (Private).
  2. Add your Bot as an Administrator.
  3. Grant full posting, deleting, and message-pinning privileges.
  4. Obtain your Channel/Chat ID (usually starts with -100).
Connecting to Project settings:Navigate to Project settings inside the dashboard, enter the Channel ID and Bot Token, then save settings. Telebase will automatically attempt to establish connection.
3

Obtain your API Key

All requests to the Telebase engine require verification via an API Key.

A unique API key is automatically generated when your project is created. In your Project overview panel, locate the API Key section and securely copy it. Add this to your header variables in every client request:

Headers
{
  "x-api-key": "YOUR_PROJECT_API_KEY"
}
4

Create your First Table

Tables dictate how your structured data is cached and stored. Telebase compiles schemas locally, synchronizes them with Telegram in chunks, and serves them.

  • Under the Tables panel, click + Create Table.
  • Set the table name (e.g. users).
  • Define fields (e.g., username as string, age as number).
  • Save the table configuration.
5

Upload your First File

You can upload files of any size directly. Telebase compresses, encrypts, and chunks them in memory.

Inside the dashboard, navigate to the Files section and drop a file into the drag-and-drop container. It will generate an asset UUID. Alternatively, upload files programmatically via code:

API Upload Example
const formData = new FormData();
formData.append("file", fileInput.files[0]);

const response = await fetch("https://telebase.pages.dev/api/data/upload", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_PROJECT_API_KEY"
  },
  body: formData
});

const data = await response.json();
console.log("File UUID:", data.file.uuid);

Congratulations!

Your Telebase environment is now initialized and ready to handle serverless SQL and NoSQL operations.

Explore CRUD APIs