List Analysis

This endpoint allows you to perform analysis on Shopping List or any generic set of items

Analyze List

POST https://graph.whisk.com/v1/lists/analyze

Request Body

NameTypeDescription

items

array

Text of items to analyze. Example: ["1 tbsp olive oil", "2 large tomatoes"]

{
  "analyzedItems": [
    {
      "sourceText": "200g pack smoked salmon",
      "normalized": "200 g smoked salmon",
      "analysis": {
        "product": "smoked salmon",
        "quantity": 200,
        "unit": "g",
        "category": "MEATS AND SEAFOOD"
      }
    },
    ...
    {
      "sourceText": "1 tbsp salt and olive oil to serve",
      "normalized": "olive oil",
      "analysis": {
        "product": "olive oil",
        "category": "CONDIMENTS"
      }
    }
  ]
}

This endpoint allows you to perform analysis on Shopping List or any generic set of items

Sample Request

curl -X POST "https://graph.whisk.com/v1/lists/analyze" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Token <Access-Token>" \
  -d '{
    "items": [
      "200g pack smoked salmon",
      "2 slices sharp cheddar cheese",
      "1 tbsp salt and olive oil to serve"
    ]
  }'

Sample Response

{
  "analyzedItems": [
    {
      "sourceText": "200g pack smoked salmon",
      "normalized": "200 g smoked salmon",
      "analysis": {
        "product": "smoked salmon",
        "quantity": 200,
        "unit": "g",
        "category": "MEATS AND SEAFOOD"
      }
    },
    ...
    {
      "sourceText": "1 tbsp salt and olive oil to serve",
      "normalized": "olive oil",
      "analysis": {
        "product": "olive oil",
        "category": "CONDIMENTS"
      }
    }
  ]
}

Last updated