Knowledge Panels

List external knowledge panel sources (JSON)

Changed on

Returns the ordered list of external knowledge panel sources configured on the server.

Providers can use the knowledge_panel_url field to point to their own API. The URL may contain template variables that the frontend will expand before calling:

  • $code → product barcode
  • $lc → UI language (2 letters)
  • $cc → user/device country (2 letters)

Example: https://provider.example.com/off/v1/knowledge-panel/$code?lang=$lc&country=$cc

The frontend percent-encodes the variable values when substituting them into the URL.

get/api/v3/external_sources

Request

  • Base URL
    https://world.openfoodfacts.org
  • Auth
    API key in header User-Agent

Response

OK

status'success' | 'success_with_warnings' | 'success_with_errors' | 'failure'

Overall status of the request: whether it failed or succeeded, with or without warnings or errors.

Example response

{
  "status": "success_with_errors",
  "result": {
    "id": "product_updated",
    "name": "Product updated",
    "lc_name": "Produit mis à jour"
  },
  "errors": [
    {
      "message": {
        "id": "sugars_higher_than_carbohydrates",
        "name": "Sugars higher than carbohydrates",
        "lc_name": "Sucres plus élevés que les glucides",
        "description": "Sugars (40g) are higher than carbohydrates (35g).",
        "lc_description": "Les sucres (40g) sont plus élévés que les glucdes."
      },
      "field": {
        "id": "nutriment.sugars",
        "value": "40"
      },
      "impact": {
        "id": "nutrients_not_updated",
        "name": "Nutrients not updated",
        "lc_name": "Nutriments non mis à jour",
        "description": "The nutrients were not updated.",
        "lc_description": "Les nutriments n'ont pas été mis à jour."
      }
    }
  ]
}

Changes

    • breaking

      the allOf[subschema #2]/external_sources/items response's property type changed from no type to object for status

    • info

      added to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    12 more changes in this revision