# HVAC Builder API

**Canonical:** https://apis.io/apis/hvacbuilder-app/hvacbuilder-app-api/  
**Provider:** HVAC Builder — https://apis.io/providers/hvacbuilder-app/  
**Documentation:** https://hvacbuilder.app/reference

HVAC Builder API is one of 2 APIs that [HVAC Builder](https://apis.io/providers/hvacbuilder-app/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

HVAC Builder API as documented publicly: 36 operations. Contract generated from the documentation by API Evangelist (2026-11-12); not the provider's own document.

## Operations (36)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/catalog` | Download the whole catalog document (gzipped); signed‑in and metered, costing tokens per request. |
| GET | `/api/catalog/compressors` | Retrieve all compressors with full coefficient sets; signed‑in and metered, costing tokens. |
| GET | `/api/catalog/compressors/{id}` | Get a compressor with its coefficient sets, steps and envelope; free for any signed‑in account. |
| GET | `/api/catalog/index` | List every catalog kind in full except compressors and published curves. |
| GET | `/api/catalog/items/{id}` | Retrieve one catalog item of any kind, with curves for signed‑in accounts. |
| GET | `/api/catalog/refrigerants` | GET /api/catalog/refrigerants |
| GET | `/api/health` | Health status of the service |
| POST | `/api/layout` | The graph laid out in rows the way the examples are |
| GET | `/api/me` | Identity, limits, capability flags, and token balance for the caller. |
| GET | `/api/presets` | The published supplier systems, the examples among them |
| GET | `/api/presets/{id}/solution` | A published system's design point, public and uncharged |
| POST | `/api/rate/ieer` | Rate a machine (IEER) using a graph and optional boundary and component settings. |
| POST | `/api/report` | POST /api/report – the spec report as HTML, PDF, or schedule CSV |
| POST | `/api/report/building` | POST /api/report/building – the building report for a finished job ({jobId}) |
| POST | `/api/report/chart` | POST /api/report/chart – the psychrometric chart tab's own drawing ({svg, source?, pressureKpa?, legend?}) printed in the report shell |
| POST | `/api/rfq` | POST /api/rfq |
| POST | `/api/rfq/match` | Preview the suppliers a design matches |
| POST | `/api/rfq/match-accessories` | POST /api/rfq/match-accessories |
| GET | `/api/simulate` | GET /api/simulate – list your runs with status rows |
| POST | `/api/simulate` | POST /api/simulate – a system against a weather year, with or without a control; returns a job id |
| POST | `/api/simulate/building` | POST /api/simulate/building – exactly one of buildingId (stored) or building (inline {name, zones, systems}) |
| DELETE | `/api/simulate/{id}` | DELETE /api/simulate/{id} – delete a finished run or cancel a run in progress |
| GET | `/api/simulate/{id}` | GET /api/simulate/{id} – polls a simulation job |
| POST | `/api/solve` | Solve a graph at a design point. |
| POST | `/api/systems` | POST /api/systems |
| GET | `/api/taxonomy` | GET /api/taxonomy |
| GET | `/api/weather` | List weather libraries (years) owned by the account or shared city years. |
| GET | `/api/weather/cities` | Retrieve the list of TMY cities and one city's PVGIS year by cityId. |
| POST | `/api/weather/generate` | POST /api/weather/generate – a labelled synthetic year; an hourly CSV, {name, altitudeM?, mapping, csv} |
| POST | `/api/weather/import` | Import weather CSV mapped by column names. |
| POST | `/api/weather/tmy` | POST /api/weather/tmy – the TMY cities, and one city's PVGIS year by {cityId} |
| DELETE | `/api/weather/{id}` | DELETE /api/weather/{id} – delete a dataset of your own |
| GET | `/api/weather/{id}/preview` | GET /api/weather/{id}/preview – a dataset's listing row and its first hours ( ?limit= , a month at most) |
| DELETE | `/api/workspace` | The caller's workspace and what it holds |
| GET | `/api/workspace` | The caller's workspace and what it holds |
| POST | `/api/workspace/invite` | A new invite link, for the owner or a manager |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/hvacbuilder-app/openapi/_ae-authored/hvacbuilder-app-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/hvacbuilder-app/json-schema/hvacbuilder-app-post-api-rate-ieer-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/hvacbuilder-app/json-schema/hvacbuilder-app-post-api-report-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/hvacbuilder-app/json-schema/hvacbuilder-app-post-api-rate-ieer-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/hvacbuilder-app/json-schema/hvacbuilder-app-post-api-weather-generate-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/hvacbuilder-app/json-schema/hvacbuilder-app-post-api-report-chart-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/hvacbuilder-app/json-schema/hvacbuilder-app-get-api-me-response-schema.json

## Other HVAC Builder APIs (1)

- [HVAC Builder API](https://apis.io/apis/hvacbuilder-app/hvac-builder-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/hvacbuilder-app/hvacbuilder-app-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/hvacbuilder-app/.