PCF Screen

⚠️

Preview Feature

This feature is currently in preview. That means that we believe the feature is good enough to start using, but:

There might still be bugs or edge cases we haven't covered.
The documentation and error messages might be less detailed.
We might need to make further changes in the API surface.

We need the ability to iterate quickly on preview versions, so we offer less guarantees of stability. When we make changes to the preview version, we will release a new version, and you must migrate to this new version within three months. Read more about API versioning at Climatiq here.For this reason, preview endpoints are not available without explicitly opting in. If you would like to opt-in to this preview feature, please contact us.

Climatiq’s PCF screen endpoint allows you to quickly generate an approximation of a Product Carbon Footprint (PCF) with a minimum of available information. Using a product name and a manufacturing location, the endpoint uses large language models to generate a Bill of Materials (BOM) and manufacturing processes that are typically required to produce this kind of product. You can provide the manufacturing year, the finished product weight and/or a description to provide more context, in order to achieve a more accurate result.

POST This endpoint allows you to approximate a Product Carbon Footprint for a product with minimal inputs.


https://preview.api.climatiq.io/pcf/v1-preview2/screen

Request

Request headersRequired HTTP headers for this request

Authorizationrequired string
Bearer token containing your Climatiq API key. Example: Authorization: Bearer CLIMATIQ_API_KEY
Don't have an API key? Get your API key here.

Request parametersShould be sent as a JSON object in the body

product_namerequired string
The name of the product being produced.
locationrequired object or string
The location where the product was manufactured. Accepts Location String, Query Location, IATA Code Location, UN/LOCODE Location or Coordinate Location
descriptionstring
A description of the product, a product code, model number, materials - anything that helps us calculate more accurately.
manufacturing_yearnumber
The year the product was manufactured.
finished_product_weightWeight
The weight of the finished product, without packaging.

Example request:


curl --request POST \
  --url https://preview.api.climatiq.io/pcf/v1-preview2/screen \
  --header "Authorization: Bearer $CLIMATIQ_API_KEY" \
  --data '{
    "product_name": "Bike frame",
    "location": "Phoenix, AZ",
    "description": "We are building 24 inch mountain bike frames from Steel for advanced mountain bikers.",
    "finished_product_weight": {
      "weight": 15.0,
      "weight_unit": "lb"
    }
  }'

Response

The response is equivalent (see the addition below) to that of the estimate endpoint with the fail_fast flag set to false.

Manufacturing inputs

In order to understand the manufacturing processes that the large language model added to the PCF, deviating from the normal response schema linked above, all manufacturing process items mirror the inputs that were used to create them. For example, an electricity process response could look like this:


{
    //...
    "manufacturing": {
        //...
        "breakdown": [
            {
                "type": "electricity",
                "total_co2e_kg": 0.195668243797,
                //...
                "inputs": {
                    "type": "electricity",
                    "amount": {
                        "energy": 0.15,
                        "energy_unit": "kWh"
                    }
                }
            }
        ]
    }
}

The inputs field mirrors exactly the request schema of the estimate endpoint for manufacturing processes.