Terminal API Overview

The Terminal API is the central API handler for the entire Operations & Maintenance (O&M) OODA workflow. It provides endpoints for asset management, fault detection, diagnostics, maintenance scheduling, and accessing ML model results.

What is the OODA Loop?

The OODA (Observe-Orient-Decide-Act) loop is a decision-making framework that enables rapid response to operational issues:

Observe: Anomaly detection in < 5 minutes
Orient: AI diagnostics in < 10 minutes
Decide: Energy-at-Risk calculation in < 15 minutes
Act: Automated dispatch and continuous monitoring

Endpoints

OODA Workflow Endpoints

Asset Management: Create, list, and retrieve solar asset details
Fault Detection: Run fault detection on assets
AI Diagnostics: Execute AI diagnostics on detected faults
Maintenance Scheduling: Create and manage maintenance schedules
Bill of Materials: Generate bills of materials for maintenance
Work Orders: Create and manage work orders
Job Tracking: Subscribe to and manage job tracking

ML Integration Endpoints

Forecast Results: Retrieve stored ML forecast results
Interpolation Results: Retrieve gap-filling interpolation results
ML Model Registry: Access the catalog of available ML models
OODA Summaries: Retrieve ML-enhanced OODA summaries with severity and energy-at-risk

API Design Principles

The Terminal API follows standard RESTful conventions:

All requests use POST method with JSON body
Responses are returned in JSON format
Standard HTTP status codes indicate success or errors
Complete request/response schemas provided for each endpoint

Authentication

All Terminal API endpoints require authentication. See Authentication for details.

Base URL

https://api.asoba.co

Quick Start

To get started with the Terminal API:

Authenticate your requests
Add an asset to your inventory
Run fault detection on your assets
Retrieve forecast results for your sites