Autopilot v1-preview4

This document lists updates that are new in v1-preview4 of Autopilot from v1-preview3.

This version of Autopilot is available at:

https://preview.api.climatiq.io/autopilot/v1-preview4/

See the reference documentation for detailed API requests and responses.

Migrating from v1-preview3 to v1-preview4

Notable changes

• Private emission factors are now available through autopilot. To enable this feature, please contact the sales team (opens in a new tab).
• The domain parameter has been renamed to model for clarity. With maufacturing model being deprecated, the model parameter is now optional and will default to the all-purpose general model, which has improved matching quality and provides comprehensive coverage across all industries and use cases.
• Inflation adjustments can be optionally enabled for spend-based estimations in Estimate and One-shot Estimate.
• Information on model name, model version, as well as data version are now returned as part of the API response in Suggest and One-shot Estimate.

API Changes (Request)

• The domain field has been renamed to model. This field is now optional.
• The manufacturing model has been deprecated.
• Inflation adjustments for spend-based estimations: You can now enable automatic inflation adjustments when using spend-based emission factors with the Estimate or One-shot Estimate endpoints. This feature accounts for inflation changes over time to provide more accurate carbon footprint calculations. For more details on the methdology, see here.
  • Estimate: Added inflation_adjustment object containing:
    • spend_year - The year of expenditure (e.g., 2020, 2023). Autopilot will automatically calculate inflation if the expenditure year is different to the emission factor year.
  • One-shot Estimate: Added inflation_adjustment boolean flag. Autopilot will use the year field of your request as the year of expenditure.

API Changes (Response)

New label field for match recommendations

To help you evaluate Autopilot emission factor matches better, instead of providing a confidence and similarity_score in suggestion_details and calculation_details, Autopilot now returns a label field that flags whether you should accept the emission factor or flag it for review.

{
    "suggestion_details": {
        "label": "accept" or "review"
    }
}

Private Emission Factors (add-on feature)

Autopilot can now include private emission factors that you have created through the Private Factors API or through the Dashboard when performing emission factor matches. This feature is available as an add-on.

The filter fields unit_type, year, region, source, exclude_source, and source_lca_activity will also apply to your private factors, allowing you to narrow results based on the attributes you've defined in your private emission factors.

Suggestion IDs from older API versions

Note that any suggestion_id returned by previous versions of Autopilot cannot be used in newer API versions.

Model and data version in API response

Model name, model version, and data version information were added to the response for Suggest and One-shot Estimate. This allows you to track which version generated your results and prioritize matches from newer models or data versions.