Official Documentation

lvlBase Developer Docs & API Reference

Everything you need to integrate, extend, and manage multi-tenant AI Operating Systems.

🚀 Quickstart Guide

lvlBase exposes a REST & Webhook architecture alongside client-side JavaScript SDK wrappers for School OS, Hospital OS, and Company OS.

1. Initialize API Client

// Initialize lvlBase SDK in Javascript
const lvl = new LvlBaseClient({
  apiKey: 'YOUR_API_KEY',
  tenantId: 'school_101',
  environment: 'production'
});

2. Query Real-Time Student GPS Location

const studentCoords = await lvl.school.getStudentLiveLocation('STU-1002');
console.log(studentCoords);
// Output: { lat: 28.6139, lng: 77.2090, distanceToSchool: "1.4 km", battery: "92%" }

⚡ Webhooks & Real-Time Events

Configure webhook endpoints in your Tenant Admin Panel to receive instant HTTP POST payloads whenever critical events occur (e.g. SOS alerts, queue overflows, payroll completion).

// Example Webhook Payload: Emergency SOS Triggered
{
  "event": "student.sos.activated",
  "timestamp": "2026-08-05T12:00:00Z",
  "tenantId": "school_101",
  "data": {
    "studentId": "STU-1002",
    "name": "Aarav Sharma",
    "class": "10-A",
    "landmark": "Block 4 Near Main Gate",
    "coords": { "lat": 28.6139, "lng": 77.2090 }
  }
}
                            