Skip to main content

API Reference & Swagger

This section explains how to access the full Homsai API reference through Swagger UI and how to use it together with the “wiki” documentation.

Overview​

The detailed technical reference for all endpoints (methods, parameters, request/response schemas) is exposed via Swagger UI:

Swagger UI allows you to:

  • explore all endpoints grouped by “tags” (Auth, Plants, Devices, Sensors, etc.);
  • see path, query parameters, request body and response schema in detail;
  • try out calls directly from the browser using a valid JWT token.

How to use Swagger UI​

  1. Open in your browser:
    https://v2.api.homsai.app/swagger-ui/index.html#/
  2. Authenticate (if required) by providing your JWT accessToken in the “Authorize” dialog.
  3. Browse the endpoint groups (tags) in the sidebar:
    • Auth
    • Plants
    • Devices
    • Sensors
    • Sensor Types / Device Types
    • Load Signatures
    • Data Types Collects
    • Vendors
    • Energy Metrics & Forecasts
  4. For each endpoint you can:
    • expand the details;
    • read parameters and DTO schemas;
    • use “Try it out” to execute a test call.

Swagger is the authoritative source for the exact contract details (JSON schemas), while the wiki pages explain how and when to use the endpoints in real use cases.