API Reference

BotLaunch API

Build powerful integrations with the BotLaunch REST API. Full access to bots, users, messages, and more with comprehensive documentation and examples.

Base URL

https://api.botlaunch.io

Version

v1.0

Auth

JWT Bearer

Quick Start

Get up and running with the BotLaunch API in minutes.

1. Install or Test

# Install the BotLaunch SDK
npm install @botlaunch/sdk

# Or use the REST API directly
curl -X GET "https://api.botlaunch.io/api/health" \
  -H "Content-Type: application/json"

bash

2. Authenticate

// Authenticate and get an access token
const response = await fetch("https://api.botlaunch.io/api/auth/login", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    email: "your@email.com",
    password: "your-password"
  })
});

const { data } = await response.json();
console.log(data.accessToken);

javascript

3. Make API Calls

// Make authenticated API calls
const bots = await fetch("https://api.botlaunch.io/api/bots", {
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "x-organization-id": "YOUR_ORG_ID"
  }
});

const { data } = await bots.json();
console.log(data); // Array of your bots

javascript

API Endpoints

Explore the available API endpoints organized by resource type.

Authentication

Learn about JWT tokens, API keys, and secure authentication methods.

View Documentation

Bots

Create, configure, and manage your Telegram bots programmatically.

View Documentation

Users

Manage users, permissions, and organization members.

View Documentation

Messages

Send messages, handle callbacks, and manage conversations.

View Documentation

Webhooks

Configure webhooks to receive real-time events and notifications.

View Documentation

Response Format

All API responses follow a consistent JSON structure.

Success Response

{
  "data": {
    "id": "bot_123",
    "name": "My Bot",
    "status": "active"
  },
  "message": "Bot retrieved successfully"
}

json

Error Response

{
  "error": "Unauthorized",
  "statusCode": 401,
  "message": "Invalid or expired token"
}

json

Paginated Response

{
  "data": [
    { "id": "bot_1", "name": "Bot 1" },
    { "id": "bot_2", "name": "Bot 2" }
  ],
  "total": 25,
  "page": 1,
  "limit": 10
}

json

Rate Limiting

API requests are rate limited to ensure fair usage and platform stability.

Plan	Requests/Min	Requests/Day	Burst Limit
Free	60	1,000	10
Starter	300	10,000	50
Professional	1,000	50,000	100
Business	5,000	Unlimited	500
Enterprise	Custom	Unlimited	Custom

Rate Limit Headers

Check X-RateLimit-Remaining and X-RateLimit-Reset headers in API responses to monitor your usage.

Back to Docs Authentication