---
title: "Get Component Blueprint"
method: GET
path: "/component_blueprints/{key}"
---

# Get Component Blueprint

`GET /component_blueprints/{key}`

## Path parameters

- `key` string, required

## Headers

- `x-client-secret` string, required — A secret token identifying the client connecting to the API

## Response `200`

Successful Response

- ComponentBlueprint
  - `key` string, required
  - `display_name` string, required
  - `description` string, required
  - `type` 'ACTIVITY' | 'REMOVAL_COUNTERFACTUAL' | 'SEQUESTRATION' | 'LOSS' | 'ADJUSTMENT' | 'UNCERTAINTY_DISCOUNT', required
  - `inputs` ComponentBlueprintInput[], required — List of inputs to the component blueprint. It documents what datapoints need to be provided when instantiating a component from it.
    - `input_key` string, required — When instantiating a component from this blueprint, one of input datapoints must match this key.
    - `description` string, required — Description of the input variable
    - `data_shape` 'SCALAR' | 'LIST', required
    - `quantity_kind` 'acidity' | 'activity_concentration' | 'amount_of_substance' | 'amount_of_substance_concentration' | 'amount_of_substance_per_mass' | 'area' | 'area_carbon_emission_factor' | 'buffer_ph' | 'bulk_density' | 'count' | 'currency' | 'currency_carbon_emission_factor' | 'depth' | 'diameter' | 'diameter_at_breast_height' | 'dimensionless' | 'dimensionless_ratio' | 'distance' | 'distance_carbon_emission_factor' | 'dose_equivalent_rate' | 'electric_current' | 'elevation' | 'energy' | 'energy_carbon_emission_factor' | 'energy_density' | 'exchangeable_amount_of_substance_per_mass' | 'fuel_economy' | 'height' | 'ionic_strength' | 'latitude' | 'longitude' | 'mass' | 'mass_carbon' | 'mass_carbon_emission_factor' | 'mass_cdr_potential' | 'mass_concentration' | 'mass_density' | 'mass_distance' | 'mass_distance_carbon_emission_factor' | 'mass_energy_density' | 'mass_flow_rate' | 'mass_fraction' | 'mass_fraction_dry_basis' | 'mass_fraction_wet_basis' | 'mass_per_area' | 'mass_ratio' | 'molality_of_solute' | 'molar_mass' | 'mole_fraction' | 'partial_pressure' | 'particle_diameter' | 'particle_mass_density' | 'power' | 'pressure' | 'specific_surface_area' | 'specific_volume' | 'temperature' | 'time' | 'time_emission_factor' | 'voltage' | 'volume' | 'volume_carbon_emission_factor' | 'volume_distance_carbon_emission_factor' | 'volume_flow_rate' | 'volume_fraction' | 'volume_per_area', required
    - `compatible_unit` string, required — An example unit for this blueprint input. The unit provided when creating a component from this blueprint can be different, but must be able to be converted to this unit.
  - `expressions` ComponentBlueprintExpression[], required — This field is exposed purely for documentation purposes. It shows how the inputs are processed to arrive at the component's output value.
    - `key` string, required — Identifier of the expression within the component.
    - `template` string, required — Mathematical formula of the expression.
    - `inputs` ComponentBlueprintExpressionInput[], required — List of inputs to the expression. It documents how variables in the template are interpolated.
      - `template_key` string, required — Input identifier within the template string. It will match a template variable wrapped in `{` & `}`.
      - `input_key` string, required — Input identifier within other resources of the component. Depending on the type, it will match an input datapoint or another expression, unless it represents a fixed 0 tCO₂e value.
      - `type` 'DATAPOINT' | 'EXPRESSION_RESULT' | 'ZERO_TCO2E', required
      - `data_shape` 'SCALAR' | 'LIST', required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/isometric/apis/isometric-certify-data-ingestion-api.md) · [All operations](https://skmtc.net/isometric/apis/isometric-certify-data-ingestion-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/isometric/isometric-certify-data-ingestion-api/versions/9819e9c8ccf0/schema)