Introduction

📌 What is UDAI?

Unified Drone Airspace Interface (UDAI) is a digital system that enables the safe and efficient operation of unmanned aerial vehicles (UAVs) — commonly known as drones — within a defined airspace. This system coordinates drone traffic, manages Mission, enforces airspace rules, and provides real-time situational awareness for stakeholders such as pilots, organisations, and airspace authorities..

---

🎯 Core Objectives

• ✅ Ensure drone safety in low-altitude airspace

• 🚫 Prevent unauthorized zone violations

• 🧭 Enable real-time drone tracking

• 📋 Streamline mission planning and approvals

• 👥 Facilitate user role management within organisations

• 🔐 Promote accountability via pilot verification & logging

---

⚙️ Developer Guide & Standards

🔐 Security Overview

• Authentication: JWT bearer token on all secure endpoints

• Verification: Email & phone OTP, reset password, validation tokens

• Permissions: Role-based access control (Owner, Pilot, User)

• Logging: Audit trails and history for all critical events

⚙️ API Design Principles

• Fully RESTful & versioned — e.g., /api/v1/...

• Resource-oriented, clean nested routing

• Pagination, filtering, and sorting for all collections

• Errors returned in a consistent JSON format

🌐 Hostname & Base URL

Docs: Hostname, Base URL & Error Codes

Base URL: https://api.udai.live/v1/
Note: v1 represents the initial version of the API.

❗ Common Error Responses & Format

Docs: Error Codes & Schema

Standard Status Codes:

• 400 Bad Request

• 401 Unauthorized

• 403 Forbidden

• 404 Not Found etc.

All errors follow a consistent pattern:

{
  "error": "string",
  "message": "string",         
  "status_code": 400,          
  "timestamp": "2025-07-17T11:45:00Z", 
  "path": "/api/v1/auth/login" 
}

📦 Pagination

Docs: Global Standards

All list endpoints support:

• page: Current page number

• limit: Results per page

• total_pages, total_records: Included in pagination object

---

🧩 API Architecture

The UDAI system is strictly modular, governed by Centralized Access Control (RBAC/CBAC), and divided into five functional categories.

For full developer documentation, detailed REST endpoints, and schema definitions, see the API Reference or explore the Interactive OpenAPI Specification.

The Five Pillars:

1. Authentication APIs: Handles user registration, verification, authentication, organization management, and RBAC/CBAC policies.

2. Fleet APIs: Manages the registry of physical drones, payloads, drone models, and legal ownership transfers between organisations.

3. Mission APIs: The orchestration layer for creating missions and flight plans, and requesting spatial airspace permissions.

4. Telemetry APIs: Handles real-time flight session telemetry ingestion and live monitoring fan-out to authorized observers.

5. Airspace APIs: Manages 3D airspace restriction zones, zone memberships, and the core geospatial Constraint Engine.