dmxawwjt.nx.link

{
  "components": {
    "schemas": {
      "ErrorResponse": {
        "properties": {
          "error": {
            "description": "Error code or short description",
            "example": "missing_parameter",
            "type": "string"
          },
          "message": {
            "description": "Detailed error message",
            "example": "Required query parameter 'query' is missing",
            "type": "string"
          }
        },
        "required": [
          "error",
          "message"
        ],
        "type": "object"
      },
      "ProductScoreResponse": {
        "properties": {
          "climate_change_total": {
            "description": "Climate change impact in kg CO2 equivalent",
            "example": 0.335,
            "format": "float",
            "type": "number"
          },
          "ecotoxicity_for_freshwater_aquatic_ecosystems_total": {
            "description": "Freshwater ecotoxicity in CTUe (Comparative Toxic Units)",
            "example": 5.55,
            "format": "float",
            "type": "number"
          },
          "energy_resources_depletion_total": {
            "description": "Energy resource depletion in megajoules (MJ)",
            "example": 6.96,
            "format": "float",
            "type": "number"
          },
          "fine_particles_total": {
            "description": "Fine particulate matter impact",
            "example": 2.62e-8,
            "format": "float",
            "type": "number"
          },
          "fresh_water_eutrophication_total": {
            "description": "Freshwater eutrophication impact",
            "example": 0.00009,
            "format": "float",
            "type": "number"
          },
          "input_query": {
            "description": "The original query string submitted",
            "example": "plastic water bottle",
            "type": "string"
          },
          "ionizing_radiations_total": {
            "description": "Ionizing radiation impact",
            "example": 0.116,
            "format": "float",
            "type": "number"
          },
          "land_use_total": {
            "description": "Land use impact in points (Pt)",
            "example": 21.63,
            "format": "float",
            "type": "number"
          },
          "marine_eutrophication_total": {
            "description": "Marine eutrophication impact",
            "example": 0.0011,
            "format": "float",
            "type": "number"
          },
          "mineral_resource_depletion_total": {
            "description": "Mineral and metal resource depletion",
            "example": 0.00000974,
            "format": "float",
            "type": "number"
          },
          "n_selected_products": {
            "description": "Number of products analyzed to generate this score",
            "example": 50,
            "type": "integer"
          },
          "ozone_depletion_total": {
            "description": "Ozone layer depletion impact",
            "example": 3.56e-7,
            "format": "float",
            "type": "number"
          },
          "photochemical_formation_of_ozone_total": {
            "description": "Photochemical ozone formation impact",
            "example": 0.0013,
            "format": "float",
            "type": "number"
          },
          "score_unique_ef_total": {
            "description": "Overall normalized environmental impact score (lower is better)",
            "example": 0.056,
            "format": "float",
            "type": "number"
          },
          "terrestrial_and_fresh_water_acidification_total": {
            "description": "Acidification impact on terrestrial and freshwater ecosystems",
            "example": 0.0027,
            "format": "float",
            "type": "number"
          },
          "terrestrial_eutrophication_total": {
            "description": "Terrestrial eutrophication impact",
            "example": 0.0086,
            "format": "float",
            "type": "number"
          },
          "toxicological_effects_on_human_health_carcinogenic_substances_total": {
            "description": "Human toxicity from carcinogenic substances",
            "example": 4.8e-10,
            "format": "float",
            "type": "number"
          },
          "toxicological_effects_on_human_health_non_carcinogenic_substances_total": {
            "description": "Human toxicity from non-carcinogenic substances",
            "example": 7.78e-9,
            "format": "float",
            "type": "number"
          },
          "water_resources_depletion_total": {
            "description": "Water resource depletion in cubic meters (m³)",
            "example": 0.75,
            "format": "float",
            "type": "number"
          }
        },
        "required": [
          "input_query",
          "score_unique_ef_total"
        ],
        "type": "object"
      }
    }
  },
  "externalDocs": {
    "description": "How to use this API",
    "url": "https://product-score-api-830409082043.europe-central2.run.app"
  },
  "info": {
    "description": "API for scoring products based on Life Cycle Assessment (LCA) data. Returns environmental impact metrics across multiple categories including climate change, energy depletion, water usage, and more. **Usage**: Call the endpoint with a query parameter describing the product (e.g., `?query=plastic water bottle`).",
    "title": "Product Score API",
    "version": "1.0.0"
  },
  "openapi": "3.0.3",
  "paths": {
    "/score_product": {
      "get": {
        "description": "Returns comprehensive LCA scores and environmental impact metrics for a product identified by the query string. **Example call**: `GET /score_product?query=plastic water bottle`",
        "operationId": "scoreProduct",
        "parameters": [
          {
            "description": "The product name or description to score (e.g., 'plastic water bottle', 'stainless steel bottle', 'organic apple')",
            "example": "plastic water bottle",
            "in": "query",
            "name": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "example": {
                  "climate_change_total": 0.335,
                  "energy_resources_depletion_total": 6.96,
                  "input_query": "plastic water bottle",
                  "n_selected_products": 50,
                  "score_unique_ef_total": 0.056,
                  "water_resources_depletion_total": 0.75
                },
                "schema": {
                  "$ref": "#/components/schemas/ProductScoreResponse"
                }
              }
            },
            "description": "Successful product scoring"
          },
          "400": {
            "content": {
              "application/json": {
                "example": {
                  "error": "missing_parameter",
                  "message": "Required query parameter 'query' is missing"
                },
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Bad request (e.g., missing query parameter)"
          },
          "500": {
            "content": {
              "application/json": {
                "example": {
                  "error": "internal_error",
                  "message": "An unexpected error occurred while processing the request"
                },
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Internal server error"
          }
        },
        "summary": "Score a product based on query string"
      }
    }
  },
  "servers": [
    {
      "description": "Production server",
      "url": "https://product-score-api-830409082043.europe-central2.run.app"
    }
  ]
}