In this update, we are preparing for new features by cleaning up endpoints, deprecating fields, and loosening validations.
Migrating Floor Area Validations
We have removed upper-limit validations on
request.building_form.above_floor_area
and request.building_form.below_floor_area
, migrating these checks to warnings instead. If a user inputs floor areas that exceed the previously validated limits, message_0024
and/or message_0025
will appear in response.api_messages
. This allows users more flexibility while still raising awareness of the possible limitations of our model.- message_0024:Very large above-grade per-floor area detected. The underlying structural estimation model may not accurately describe buildings with this per-floor area.
- message_0025:Very large below-grade per-floor area detected. The underlying structural estimation model may not accurately describe buildings with this per-floor area.
REMOVED reduced_building_area Parameter
The
request.building_form.reduced_building_area
field has been deprecated. This field allowed for comparisons of buildings with different areas, which could lead to inconsistent evaluations by comparing unlike buildings. To create such comparisons, we recommend sending separate payloads with the desired floor areas instead.REMOVED Endpoints
The
/api/summary
and /api/timeseries
endpoints have been deprecated as part of our effort to consolidate our API. Users can still generate equivalent data through any of the /api/calculate
endpoints; /api/summary
corresponds to response.summary
within the response, while response.timeseries
replicates the data previously available in /api/timeseries
.Updates to Existing Endpoints
In the
/api/carbon-intensities
endpoint, we have updated example responses and introduced a new materials
object within the CarbonIntensitiesResponse
. This addition consolidates all material-based carbon intensities into a single category, as a material may appear in multiple parts of the building (e.g., SteelStruct
is used in both the structural bill of materials and glazing assemblies).The
structure
object is now planned for deprecation in a future release, as the materials
object provides a more comprehensive representation. Additionally, the materials
object now includes carbon intensities for WindowGasket
and Aluminum
, materials used in glazing assemblies.