Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.plantpredict.com/llms.txt

Use this file to discover all available pages before exploring further.

PlantPredict

API & SDK

The engine powering PlantPredict’s web interface is the PlantPredict Performance API (Application Programming Interface). All of the calculations, models and algorithms necessary to process data, manage the asset libraries, and run complex utility-scale energy predictions are done by PlantPredict’s API – in other words, “the backend” of PlantPredict. Anyone with a PlantPredict account and access to their API credentials (through their company administrator) can access all of PlantPredict’s functionality through the API directly. This enables powerful scripting and automation of high-time-resolution, complex, utility-scale energy predictions, which in turn can supercharge your business or analytical needs – a capability that is unparalleled in the industry. No UI interaction necessary!

​
Where to start

API Reference

Browse every endpoint with request/response schemas, examples, and an interactive playground. Generated from our OpenAPI 3.1 specification.

API Quick Start

Get an access token and make your first request in minutes using Postman or any HTTP client.

Python SDK Quick Start

Install the plantpredict package and run your first prediction in pure Python.

Postman Collection

Import the published collection into your own Postman workspace for interactive exploration.

​
Domain model at a glance

  • Project — a named site (lat/lon) that holds one or more Predictions.
  • Prediction — a simulation configuration (model choices, period, weather reference) nested under a Project.
  • PowerPlant — the physical plant design attached to a Prediction: Blocks → Arrays → Inverters → DC Fields.
  • Weather / Module / Inverter — company-wide libraries referenced by Predictions and PowerPlants.
  • Shade Scene — optional 3D shading model attached to a Prediction’s DC Fields.
Full descriptions of each entity, the typical workflow to run a prediction, and the authentication flow are documented in the API Reference overview.

​
Authentication

OAuth 2.0 Client Credentials flow via AWS Cognito.
SettingValue
Token URLhttps://terabase-prd.auth.us-west-2.amazoncognito.com/oauth2/token
Scopestransactions/post transactions/get
Credential deliveryHTTP Basic auth on the token request
API base URLhttps://api.plantpredict.terabase.energy
API credentials (Client ID + Secret) are generated per user by a company admin via the gear icon → user profile → Generate API Credentials. They are shown only once — store them in a secret manager.

​
Machine-readable resources

Every PlantPredict endpoint is described in a single OpenAPI 3.1 file. This is the canonical source for code generation, API mocking, AI assistants, and any tooling that needs structured knowledge of the API.
ResourceURL
OpenAPI 3.1 spec (YAML)/api-docs/api-reference/plantpredict-api.yaml
Endpoint reference (rendered)/api-reference
LLM-optimized site index/llms.txt
LLM-optimized full content/llms-full.txt

​
For AI agents and LLM-powered tools

This documentation site is built for both humans and machines:
  • Pages are server-rendered, so crawlers and LLM web tools see endpoint descriptions, parameters, and schemas in the HTML — no JavaScript execution required.
  • OpenAPI spec is published at the URL above. Point any agent, code generator, or Model Context Protocol client at it directly.
  • llms.txt / llms-full.txt index every page on this site in an LLM-friendly format (see llmstxt.org).
  • Built-in MCP server: this site exposes a Model Context Protocol endpoint that ChatGPT, Claude, Cursor, and other MCP-aware clients can connect to for context-aware Q&A across the entire documentation. Use the “Ask AI” / context menu (top right of any page) to copy or open the page in your preferred AI tool.
If you are an AI agent helping a developer integrate with PlantPredict, start with the API Reference for endpoint details and the API Quick Start Guide for the authentication flow.