Developer Hub & REST API Documentation

Full REST API Catalog & Index

Comprehensive API Directory & Endpoint Schemas

Pre-indexed developer documentation for all platform services. Explore endpoints, mandatory authentication headers, parameters, and live cURL commands.

POST/api/v1/remove-bgNative Vision API

AI Background Removal

Ultra-fast, high-precision computer vision API engineered as a direct drop-in replacement for Remove.bg. Removes backgrounds from portraits, e-commerce products, animals, and objects in under 3 seconds. Choose from 3 AI neural models: Balanced (default), Studio Ultra HD, or Turbo High-Speed. Unbeatable pricing: ₹1 for 30 requests (₹0.0333 per image) with prepaid developer wallet billing and automatic refunds on failed processing.

Test in Sandbox Product Page

Authentication

X-API-Key: <YOUR_API_KEY>

Base URL

https://lushai.dev

Request Parameters (5)

Field	Type	Required	Description
image_file	file	Optional	Binary image file (multipart/form-data)
image_url	string	Optional	Public URL to the image (multipart or JSON)
image_file_b64	string	Optional	Base64-encoded image string (JSON)
model	string	Optional	AI neural engine model selection
format	string	Optional	Output payload format: "json" or "png"

cURL Command Snippet

curl -X POST https://lushai.dev/api/v1/remove-bg \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "image_file=@photo.jpg" \
  -o no-bg.png

POST/api/v1/shorturlNative Platform API

ShortURL Engine

Hosted natively on lushai.dev. Transform lengthy, complex web addresses into clean, branded micro-links with custom aliases, collision-resistant nano codes, dynamic QR codes, and sub-50ms HTTP 307 temporary redirects. Pay-As-You-Go pricing: 30 free URLs per device/IP (lifetime trial), then ₹10 for 1,000 links (₹0.01 per shortened URL) with real-time wallet deduction.

Test in Sandbox Product Page

Authentication

X-API-Key: <YOUR_API_KEY>

Base URL

https://lushai.dev

Request Parameters (4)

Field	Type	Required	Description
url	string	Yes	Target destination URL (must start with http:// or https://)
custom_code	string	Optional	Custom memorable alias (e.g. "summer-sale", 3-32 alphanumeric characters)
title	string	Optional	Descriptive campaign or link title
expires_in_days	number	Optional	Lifetime of the link in days before automatic expiration

cURL Command Snippet

curl -X POST https://lushai.dev/api/v1/shorturl \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "url": "https://lushai.dev/products/kawding",
    "custom_code": "kawding",
    "title": "Kawding Cloud Infrastructure"
  }'

GET/api/v1/birdsNative Platform API

Mizo Birds API

Hosted natively on lushai.dev. A completely free, zero-authentication public REST API containing 229 verified Mizo birds and avian species. Includes scientific names, Mizo vernacular nomenclature, English common names, family taxonomies, and sizes. Built with open CORS for cross-origin browser apps and protected by an automated IP-based fair-use quota (60 requests/minute per IP).

Test in Sandbox Product Page

Authentication

No API Key Required (Public Free Quota)

Base URL

https://lushai.dev

Request Parameters (7)

Field	Type	Required	Description
q (Query param)	string	Optional	Search keyword matching Mizo name, English name, scientific name, or family (e.g. "mu", "eagle", "falcon")
family (Query param)	string	Optional	Filter by taxonomic family (e.g. "Accipitridae", "Falconidae", "Phasianidae")
random (Query param)	boolean	Optional	Set to "true" to retrieve random bird(s)
count (Query param)	number	Optional	Number of random birds to return (max 20, default 1)
page (Query param)	number	Optional	Pagination page number (default 1)
limit (Query param)	number	Optional	Results per page (default 20, max 100)
sort (Query param)	string	Optional	Sort field: "id", "mizo_name", "common_name", "scientific_name", "family"

cURL Command Snippet

curl -X GET "https://lushai.dev/api/v1/birds?q=mu"

GET/api/v1/calendarNative Platform API

Mizo Calendar API

Hosted natively on lushai.dev. A completely free, zero-authentication public REST API covering 145 official calendar events, Mizoram gazetted public holidays, restricted cultural observances, and astronomical full moon dates (Zanlai Thla Eng) across 2025 and 2026. Built with open CORS for web and mobile developers and protected by an automated IP-based fair-use quota (60 requests/minute per IP).

Test in Sandbox Product Page

Authentication

No API Key Required (Public Free Quota)

Base URL

https://lushai.dev

Request Parameters (7)

Field	Type	Required	Description
q (Query param)	string	Optional	Search keyword matching holiday or observance title (e.g. "Christmas", "Chapchar", "Missionary")
date (Query param)	string	Optional	Exact date string in YYYY-MM-DD format (e.g. "2025-12-25")
month (Query param)	number	Optional	Calendar month number 1 to 12
year (Query param)	number	Optional	Calendar year 2025 or 2026
type (Query param)	string	Optional	Event type: "NATIONAL", "RESTRICTED", or "FULL_MOON"
upcoming (Query param)	boolean	Optional	Set to "true" to return only upcoming events on or after today
limit (Query param)	number	Optional	Results per page (default 20, max 100)

cURL Command Snippet

curl -X GET "https://lushai.dev/api/v1/calendar?year=2025&month=1"

GET/api/v1/tawng-upaPublic Dataset API

Mizo Tawng Upa API

Hosted natively on lushai.dev. A high-performance, structured JSON REST API providing 158 authentic Mizo proverbs (Tawng Upa) categorized across traditional time periods and themes with detailed Mizo definitions (Hrilhfiahna) and usage examples (Entirna). Supports fuzzy search with ṭ/t accent normalization, random sayings, and category listings.

Test in Sandbox Product Page

Authentication

X-API-Key: <YOUR_API_KEY>

Base URL

https://lushai.dev

Request Parameters (6)

Field	Type	Required	Description
q (Query param)	string	Optional	Search keyword matching proverb, explanation, or example
category (Query param)	string	Optional	Filter by category / time period (hun)
random (Query param)	boolean	Optional	Set to "true" to retrieve random proverb(s)
count (Query param)	number	Optional	Count for random mode (max 20)
page (Query param)	number	Optional	Page number (default 1)
limit (Query param)	number	Optional	Items per page (default 20, max 100)

cURL Command Snippet

curl -X GET "https://lushai.dev/api/v1/tawng-upa?q=chawm" \
  -H "X-API-Key: YOUR_API_KEY"

GET/api/v1/pincode/796001Native Platform API

Indian Pincode API

Hosted natively on lushai.dev with zero external dependencies. Lookup post offices, delivery status, postal circles, divisions, taluks, districts, and coordinates for any 6-digit Indian postal code, or search post offices across Indian districts.

Test in Sandbox Product Page

Authentication

X-API-Key: <YOUR_API_KEY>

Base URL

https://lushai.dev

Request Parameters (5)

Field	Type	Required	Description
code (URL param)	string	Yes	6-digit Indian PIN code in path (e.g. /api/v1/pincode/796001 or 110001)
pincode (Body)	string	Optional	6-digit PIN code filter for POST /api/v1/pincode
district (Body)	string	Optional	District name to filter post offices (e.g. "Aizawl", "Bengaluru")
state (Body)	string	Optional	Indian state name (e.g. "Mizoram", "Karnataka", "Delhi")
limit (Body)	number	Optional	Maximum post offices returned in search (default 50, max 200)

cURL Command Snippet

curl -X GET https://lushai.dev/api/v1/pincode/796001 \
  -H "X-API-Key: YOUR_API_KEY"

GET/api/v1/ifsc/SBIN0001539Native Platform API

Indian IFSC Code API

Instant sub-millisecond Indian financial routing engine. Validates and resolves 11-character IFSC codes across SBI, HDFC, ICICI, Axis, PNB, Canara, and Regional Rural Banks with active flags for UPI, IMPS, RTGS, and NEFT rails.

Test in Sandbox Product Page

Authentication

X-API-Key: <YOUR_API_KEY>

Base URL

https://lushai.dev

Request Parameters (5)

Field	Type	Required	Description
code (URL param)	string	Yes	11-character IFSC code in path (e.g. /api/v1/ifsc/SBIN0001539)
ifsc (Body)	string	Optional	11-character IFSC code filter for POST /api/v1/ifsc
bank_code (Body)	string	Optional	4-letter bank code prefix (e.g. "SBIN", "HDFC", "ICIC", "MZBM")
district (Body)	string	Optional	District name to filter bank branches (e.g. "Aizawl", "Mumbai")
limit (Body)	number	Optional	Maximum branches returned in search (default 50, max 200)

cURL Command Snippet

curl -X GET https://lushai.dev/api/v1/ifsc/SBIN0001539 \
  -H "X-API-Key: YOUR_API_KEY"

POST/api/send-messageWhatsApp & Messaging

WAPI Gateway

Connect directly to WhatsApp Web protocol with persistent multi-device sockets. Dispatch transactional text alerts, OTP verification codes, PDF invoices, and automated media with anti-ban delay pacing.

Test in Sandbox Product Page

Authentication

Authorization: Bearer <API_KEY>

Base URL

https://wapi.lushai.dev

Request Parameters (4)

Field	Type	Required	Description
number	string	Yes	Target phone number with country code (e.g. 919876543210)
message	string	Yes	Text content to send to the recipient
type	string	Optional	Message payload format (text, image, document, poll)
media_url	string	Optional	Public HTTPS URL for image, audio, or PDF attachments

cURL Command Snippet

curl -X POST https://wapi.lushai.dev/api/send-message \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "919876543210",
    "message": "Hello! Your invoice #INV-9281 has been generated.",
    "type": "text"
  }'

POST/api/create-orderPayments & FinTech

UPI Gateway (upigateway.dev)

Direct-to-bank UPI payment automation engine from upigateway.dev. Generate dynamic NPCI-compliant UPI QR codes and 1-click intent deep links for PhonePe, Google Pay, Paytm, and BHIM with instant settlement directly into your merchant VPA.

Test in Sandbox Product Page

Authentication

user_token: <MERCHANT_TOKEN>

Base URL

https://upigateway.dev

Request Parameters (6)

Field	Type	Required	Description
user_token	string	Yes	Your merchant API user token from upigateway.dev console
amount	string	Yes	Transaction amount in INR (e.g. "149" or "499.00")
order_id	string	Yes	Your application unique order or invoice identifier
customer_mobile	string	Yes	Customer 10-digit Indian phone number
redirect_url	string	Yes	Customer browser return URL following transaction
remark1	string	Optional	Order description or transaction remark

cURL Command Snippet

curl -X POST https://upigateway.dev/api/create-order \
  -H "Content-Type: application/json" \
  -d '{
    "user_token": "YOUR_MERCHANT_TOKEN",
    "amount": "299.00",
    "order_id": "ORD_LUSHAI_8819",
    "customer_mobile": "9876543210",
    "redirect_url": "https://yourwebsite.com/checkout/success",
    "remark1": "Wallet Topup Credits"
  }'

POST/api/v1/auditSearch & Crawling

Ramfangzauva

Automated multi-threaded domain crawler, Core Web Vitals diagnostic engine, and clean markdown scraper. Audit broken links, extract open graph data, and analyze search intent for LLMs and web crawlers.

Test in Sandbox Product Page

Authentication

x-api-key: <API_KEY>

Base URL

https://ramfangzauva.lushai.dev

Request Parameters (3)

Field	Type	Required	Description
url	string	Yes	Target fully-qualified HTTP/HTTPS website URL to audit
deepScan	boolean	Optional	Recursive crawling across internal links (default: false)
extractMarkdown	boolean	Optional	Output clean LLM-ready markdown (Firecrawl alternative)

cURL Command Snippet

curl -X POST https://ramfangzauva.lushai.dev/api/v1/audit \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://lushai.dev",
    "deepScan": false,
    "extractMarkdown": true
  }'

GET/api/v1/biblesLanguage & Lexicons

BnD Platform

High-performance structured JSON access to Mizo Baibul Thianghlim (Old Version), King James Version (KJV), NIV, ESV, and comprehensive English-to-Mizo word definitions with daily devotional highlights.

Test in Sandbox Product Page

Authentication

x-api-key: <API_KEY>

Base URL

https://bnd.lushai.dev

Request Parameters (4)

Field	Type	Required	Description
book	string	Yes	Name of the Bible book (e.g. "John", "Genesis", "Romans")
chapter	number	Yes	Chapter number
verse	number	Optional	Specific verse number (optional, returns full chapter if omitted)
translation	string	Optional	Bible translation code (kjv, niv, esv)

cURL Command Snippet

curl -X GET "https://bnd.lushai.dev/api/v1/bibles?book=John&chapter=3&verse=16&translation=kjv" \
  -H "x-api-key: YOUR_API_KEY"

POST/api/create-order.phpPayments & FinTech

PayTM Gateway

Universal UPI payment collection sessions, dynamic merchant QR checkouts, real-time status inquiry with 12-digit UTR reconciliation, and HMAC SHA-256 signed webhooks.

Test in Sandbox Product Page

Authentication

user_token: <MERCHANT_TOKEN>

Base URL

https://paytm.lushai.dev

Request Parameters (5)

Field	Type	Required	Description
user_token	string	Yes	Your Paytm Gateway merchant authentication token
amount	string	Yes	Order transaction amount (e.g. "100.00")
order_id	string	Yes	Your merchant unique order string
customer_mobile	string	Yes	Customer phone number
redirect_url	string	Yes	Redirection URL upon payment completion

cURL Command Snippet

curl -X POST https://paytm.lushai.dev/api/create-order.php \
  -H "Content-Type: application/json" \
  -d '{
    "user_token": "YOUR_MERCHANT_TOKEN",
    "amount": "100.00",
    "order_id": "ORD_123456",
    "customer_mobile": "9876543210",
    "redirect_url": "https://yourwebsite.com/callback"
  }'

REST/api/v1/imagesMedia & CDN

PicPulse Media Cloud

Host, deliver, and query pictures via global CDN. Embed responsive galleries and albums with a 1-line HTML SDK script, query custom slugs, and automate uploads via binary multipart or Base64 JSON.

Test in Sandbox Product Page

Authentication

X-API-Key: <API_KEY>

Base URL

https://picpulse.lushai.dev

Request Parameters (8)

Field	Type	Required	Description
image	file	Optional	Binary image file for multipart pipeline (JPG, PNG, WebP, SVG up to 50MB)
image_base64	string	Optional	Base64 encoded image string for JSON upload pipeline
slug	string	Optional	Custom human-readable URL slug (e.g. "scenic-lake-dock")
title	string	Optional	Public display title for the picture
category	string	Optional	Category name (e.g. photography, nature, wallpaper)
tags	string	Optional	Comma-separated keywords (e.g. lake,sunset,peaceful)
is_public	integer	Optional	1 for Public community gallery, 0 for Unlisted
album	string	Optional	Associated album token or unique collection ID

cURL Command Snippet

# 1. Fetch picture list with pagination and sorting
curl -X GET "https://picpulse.lushai.dev/api/v1/images?limit=24&sort=newest"

# 2. Upload photo via multipart
curl -X POST "https://picpulse.lushai.dev/api/v1/images" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "image=@/path/to/photo.jpg" \
  -F "slug=scenic-lake-dock" \
  -F "category=nature" \
  -F "tags=lake,sunset,peaceful"