Autopilot ADD-ONADD-ON

Autopilot is an AI-powered calculation endpoint designed to automate spend- and activity-based emission estimates. It uses a proprietary natural language processing (NLP) model paired with Climatiq’s scientific expertise to streamline complex emission calculations, making carbon insights accessible to non-experts.

Autopilot significantly reduces the time and manual effort spent identifying the appropriate emission factors and mapping activity data. Capable of ingesting any taxonomy and unstructured data, this feature matches raw text content to the correct emission factors and delivers accurate and compliant emission estimates.

Leveraging a built-in expert review mechanism and machine learning, Autopilot's matching algorithm consistently refines its precision. This is achieved through active feedback and continuous improvement of the underlying NLP model.

Estimate ALPHAALPHA

POST Calculate total estimated emissions produced for a particular activity, in kgCO2e, using free-text input. The best matching emission factor will automatically be selected and used for the calculation. All requests are performed by sending a POST request to the following endpoint.

https://beta4.api.climatiq.io/autopilot/estimate

Request

The following parameters can be defined as a JSON-encoded object in a body.

Attributes	Required
text string The free-form input text, such as an activity name, service or material name.	required
parameters Parameters Calculation parameters. Currently the only unit types that are supported are Weight and Money	required
domain string One of the Domains to be used for the calculation.	required
year number The year which the activity occurred. Climatiq will attempt to find an emission factor as close to this year as possible, but might not match the year entirely. If there is no year specified, Climatiq will attempt to use the latest emission factors.	optional
region string The geographic region where the activity was performed. If this is not provided, Climatiq will pick from emission factors all over the world. If this is provided, Climatiq will only find emission factors matching the supplied region, unless `region_fallback` is set.	optional
region_fallback boolean Set this to `true` if you're willing to accept a less specific geographical region than the one you've specified. Climatiq will then intelligently attempt to select a different region if it does not find any emission factors with the initial region. Default is `false`	optional

Domains

Domains represent a collection of data and heuristics, defined for specific use cases.

Value	Description	Datasets
general	General list of materials and services	Climatiq
general_and_ecoinvent	General list of materials and services, from both the Climatiq database and ecoinvent	Climatiq + ecoinvent

Dry-runs

If you attempt to estimate using domain with a dataset that your API key does not have access to, the estimate will still work, but the CO2e values will not be provided. This is so you can evaluate how good matches would be using different domains and datasets, before purchasing commercial access to the data.

Example Request

curl --request POST \
  --url https://beta4.api.climatiq.io/autopilot/estimate \
  --header 'Authorization: Bearer API_KEY' \
  --data '{
	"domain": "construction",
	"text": "Cement",
	"parameters": {
		"money": 100,
        "money_unit": "usd"
	}
}'

Response

The response includes the CO2e estimate and details about the calculation.

Attribute
estimate Estimation The estimation performed returning the total CO2e value, constituent gases and more.
calculation_details object Details about the calculation, including review state and confidence level.

Calculation Details

The calculation_details object includes the following attributes.

Attribute
review_state string State of the review of this calculation. Possible values are: `human_review_requested`, `human_review_in_progress` or `human_review_finished`
last_human_review_at number Last human review date if any.
confidence string Confidence level on the calculation. Possible values are: `high`, `medium` and `low`. Note that the confidence might still be low even after a human review has been finished, e.g. if the string can't be matched because it's nonsensical or malformed, or if there are no emission factors that match the given string.

Example Response

{
    "estimate": {
        "co2e": 1023,
        "co2e_unit": "kg",
        "co2e_calculation_method": "ar5",
        "co2e_calculation_origin": "source",
        "emission_factor": {
            "name": "Cement/lime and plaster",
            "activity_id": "building_materials-type_cement_lime_plaster",
            "id": "397e827d-7090-411d-b6a9-7b6eb71f55c0",
            "access_type": "public",
            "source": "EXIOBASE",
            "source_dataset": "EXIOBASE 3",
            "year": 2019,
            "region": "JP",
            "category": "Building Materials",
            "source_lca_activity": "unknown",
            "data_quality_flags": []
        },
        "constituent_gases": {
            "co2e_total": 1023,
            "co2e_other": null,
            "co2": null,
            "ch4": null,
            "n2o": null
        },
        "activity_data": {
            "activity_value": 89.4,
            "activity_unit": "eur"
        },
        "audit_trail": "enabled"
    },
    "calculation_details": {
        "review_state": "human_review_finished",
        "last_human_review_at": "2023-11-21T12:34:13.814838Z",
        "confidence": "high"
    }
}

Request Review ALPHAALPHA

POST Request a review of a particular calculation.

https://beta4.api.climatiq.io/autopilot/request-review

Request

The following parameters can be defined as a JSON-encoded object in a body.

Attributes	Required
estimate object Object with request submitted to Estimate above.	required
reason string Optional reason or explanation for the review request.	optional

Example Request

curl --request POST \
  --url https://beta4.api.climatiq.io/autopilot/request-review \
  --header 'Authorization: Bearer API_KEY' \
  --data '{
    "estimate": {
        "domain": "construction",
        "text": "Cement",
        "parameters": {
            "money": 100
        }
    },
    "reason": "Result is not specific enough"
}'

Response

The response includes a confirmation message of the request.

Attribute
message string Confirmation message.

Example Response

{
    "message": "request registered"
}

Travel Procurement