OpenAPI Specification

The Tessellate Renewables API is fully documented using the OpenAPI 3.1 specification.

Interactive Documentation

Explore the API interactively using Swagger UI:

https://api.tessellaterenewables.com/docs

OpenAPI Spec URL

Download or fetch the OpenAPI specification:

https://api.tessellaterenewables.com/openapi.json

Using the Spec

Generate Client Libraries

Use the OpenAPI spec to generate client libraries in any language:

# Install OpenAPI Generator
npm install @openapitools/openapi-generator-cli -g

# Generate Python client
openapi-generator-cli generate \
  -i https://api.tessellaterenewables.com/openapi.json \
  -g python \
  -o ./tessellate-python-client

# Generate TypeScript client
openapi-generator-cli generate \
  -i https://api.tessellaterenewables.com/openapi.json \
  -g typescript-fetch \
  -o ./tessellate-ts-client

# Generate Go client
openapi-generator-cli generate \
  -i https://api.tessellaterenewables.com/openapi.json \
  -g go \
  -o ./tessellate-go-client

Import to Postman

1. Open Postman
2. Click Import
3. Select Link
4. Paste: https://api.tessellaterenewables.com/openapi.json
5. Click Import

Import to Insomnia

1. Open Insomnia
2. Click Create → Import from URL
3. Paste: https://api.tessellaterenewables.com/openapi.json

API Endpoints Overview

Authentication

Method	Endpoint	Description
POST	/auth/register	Register new user
POST	/auth/login	Login with credentials
POST	/auth/refresh	Refresh access token
POST	/auth/logout	Logout (invalidate tokens)

Solar

Method	Endpoint	Description
GET	/solar/health	Service health check
POST	/solar/resource	Get solar irradiance data
POST	/solar/predict	ML power prediction
POST	/solar/optimization/quick	Quick optimization
POST	/solar/optimization/run	Full optimization job
GET	/solar/optimization/{job_id}	Get job results
POST	/solar/optimization/multi	Multi-objective optimization
POST	/solar/assess	Site assessment
POST	/solar/report	Generate PDF report
GET	/solar/report/download/{filename}	Download report

Wind

Method	Endpoint	Description
GET	/wind/health	Service health check
POST	/wind/resource	Get wind resource data
POST	/wind/optimization/run	Wind farm optimization

Schema Definitions

Key schema definitions from the OpenAPI spec:

Site

Site:
  type: object
  required:
    - latitude
    - longitude
    - capacity_kw
  properties:
    latitude:
      type: number
      minimum: -90
      maximum: 90
    longitude:
      type: number
      minimum: -180
      maximum: 180
    capacity_kw:
      type: number
      minimum: 1
    land_area_ha:
      type: number
      minimum: 0

OptimalParameters

OptimalParameters:
  type: object
  properties:
    tilt:
      type: number
      description: Panel tilt angle in degrees
    azimuth:
      type: number
      description: Panel azimuth angle in degrees
    dc_ac_ratio:
      type: number
      description: DC to AC capacity ratio
    gcr:
      type: number
      description: Ground coverage ratio

EnergyMetrics

EnergyMetrics:
  type: object
  properties:
    annual_energy_mwh:
      type: number
    capacity_factor:
      type: number
    specific_yield:
      type: number
    performance_ratio:
      type: number

Versioning

The API uses URL versioning (when applicable):

• Current version: v1 (default, no prefix needed)
• Future versions: /v2/solar/...

Breaking changes will be announced with deprecation notices.