Nutrition AI API

﻿
Getting Started
1.	Obtain an API key from the Spike Team.
2. Make HTTP requests to the API endpoint, including the necessary parameters.
3.	Parse the JSON responses to extract and utilize the nutritional data within your application.
Postman Collection Example
JSON file provides an example to help you get started quickly. You can test it easily by importing it into Postman and running it with the sample image already set up:
Spike Nutrition AI.postman_collection (Detailed).json
﻿
Utilizing advanced image recognition and machine learning algorithms, the API identifies food items within an image and calculates their nutritional content.
POST
Request
Header Parameters
X-API-Key
required
String
Your authentication key for accessing the service, which you will obtain from the Spike Team.
Body Parameters
userUuid
required
String
A unique identifier for your end-user that you use internally within your application.
imageLink
required
String
A string containing the URL of the meal image. Use this parameter when your image is hosted online and accessible via a public URL. Ensure that the link points directly to the image file (e.g., ends with .jpg, .png). Either imageLink or imageBase64 is required in your request.
 imageBase64
required
String
A string of the meal image encoded in Base64 format. Use this parameter to send the image directly within the request payload, without the need for external hosting. This is useful when you prefer not to expose the image publicly. Either imageBase64 or imageLink is required in your request.
config
optional
Object
Configurable parameters for each query.
EXAMPLES

Responses
200
{
    "name": "Grilled Salmon Salad",
    "description": "A healthy salad featuring grilled salmon, mixed greens, and assorted vegetables.",
    "ingredients": [
        {
            "name": "Grilled Salmon",
            "servingSize": 150,
            "calories": 280,
            "carbohydrates": 0,
            "proteins": 30,
            "fats": 18,
            "microNutrients": {
                "saturatedFat": 3,
                "polyunsaturatedFat": 4,
                "monounsaturatedFat": 7,
                "transFat": 0,
                "fibre": 0,
                "sugar": 0,
                "cholesterol": 70,
                "sodium": 50,
                "potassium": 490,
                "vitaminA": 50,
                "vitaminC": 0,
                "calcium": 20,
                "iron": 0.5
            }
        },
        {
            "name": "Mixed Greens",
            "servingSize": 50,
            "calories": 10,
            "carbohydrates": 2,
            "proteins": 1,
            "fats": 0.2,
            "microNutrients": {
                "saturatedFat": 0,
                "polyunsaturatedFat": 0.1,
                "monounsaturatedFat": 0,
                "transFat": 0,
                "fibre": 1,
                "sugar": 0.5,
                "cholesterol": 0,
                "sodium": 10,
                "potassium": 150,
                "vitaminA": 200,
                "vitaminC": 15,
                "calcium": 20,
                "iron": 0.5
            }
        },
        {
            "name": "Broccoli",
            "servingSize": 40,
            "calories": 14,
            "carbohydrates": 2.8,
            "proteins": 1.2,
            "fats": 0.2,
            "microNutrients": {
                "saturatedFat": 0,
                "polyunsaturatedFat": 0.1,
                "monounsaturatedFat": 0,
                "transFat": 0,
                "fibre": 1.1,
                "sugar": 1.2,
                "cholesterol": 0,
                "sodium": 12,
                "potassium": 230,
                "vitaminA": 31,
                "vitaminC": 40,
                "calcium": 20,
                "iron": 0.3
            }
        },
        {
            "name": "Cauliflower",
            "servingSize": 30,
            "calories": 7,
            "carbohydrates": 1.4,
            "proteins": 0.6,
            "fats": 0.1,
            "microNutrients": {
                "saturatedFat": 0,
                "polyunsaturatedFat": 0,
                "monounsaturatedFat": 0,
                "transFat": 0,
                "fibre": 0.6,
                "sugar": 0.6,
                "cholesterol": 0,
                "sodium": 15,
                "potassium": 150,
                "vitaminA": 0,
                "vitaminC": 20,
                "calcium": 10,
                "iron": 0.2
            }
        },
        {
            "name": "Zucchini",
            "servingSize": 30,
            "calories": 5,
            "carbohydrates": 1,
            "proteins": 0.4,
            "fats": 0.1,
            "microNutrients": {
                "saturatedFat": 0,
                "polyunsaturatedFat": 0,
                "monounsaturatedFat": 0,
                "transFat": 0,
                "fibre": 0.3,
                "sugar": 0.8,
                "cholesterol": 0,
                "sodium": 2,
                "potassium": 150,
                "vitaminA": 10,
                "vitaminC": 8,
                "calcium": 10,
                "iron": 0.2
            }
        },
        {
            "name": "Tomato",
            "servingSize": 20,
            "calories": 4,
            "carbohydrates": 0.9,
            "proteins": 0.2,
            "fats": 0.1,
            "microNutrients": {
                "saturatedFat": 0,
                "polyunsaturatedFat": 0,
                "monounsaturatedFat": 0,
                "transFat": 0,
                "fibre": 0.3,
                "sugar": 0.6,
                "cholesterol": 0,
                "sodium": 1,
                "potassium": 100,
                "vitaminA": 42,
                "vitaminC": 6,
                "calcium": 5,
                "iron": 0.1
            }
        },
        {
            "name": "Parmesan Cheese",
            "servingSize": 10,
            "calories": 43,
            "carbohydrates": 0.3,
            "proteins": 3.9,
            "fats": 3,
            "microNutrients": {
                "saturatedFat": 1.9,
                "polyunsaturatedFat": 0.1,
                "monounsaturatedFat": 0.8,
                "transFat": 0,
                "fibre": 0,
                "sugar": 0.1,
                "cholesterol": 9,
                "sodium": 180,
                "potassium": 12,
                "vitaminA": 40,
                "vitaminC": 0,
                "calcium": 110,
                "iron": 0.2
            }
        }
    ]
}
{
    "name": "Grilled Salmon Salad",
    "description": "A healthy salad featuring grilled salmon, mixed greens, and assorted vegetables.",
    "ingredients": [
        {
            "name": "Grilled Salmon",
            "servingSize": 150,
            "calories": 280,
            "carbohydrates": 0,
            "proteins": 30,
            "fats": 18,
            "microNutrients": {
                "saturatedFat": 3,
                "polyunsaturatedFat": 4,
                "monounsaturatedFat": 7,
                "transFat": 0,
                "fibre": 0,
                "sugar": 0,
                "cholesterol": 70,
                "sodium": 50,
                "potassium": 490,
                "vitaminA": 50,
                "vitaminC": 0,
                "calcium": 20,
                "iron": 0.5
            }
        },
        {
            "name": "Mixed Greens",
            "servingSize": 50,
            "calories": 10,
            "carbohydrates": 2,
            "proteins": 1,
            "fats": 0.2,
            "microNutrients": {
                "saturatedFat": 0,
                "polyunsaturatedFat": 0.1,
                "monounsaturatedFat": 0,
                "transFat": 0,
                "fibre": 1,
                "sugar": 0.5,
                "cholesterol": 0,
                "sodium": 10,
                "potassium": 150,
                "vitaminA": 200,
                "vitaminC": 15,
                "calcium": 20,
                "iron": 0.5
            }
        },
        {
            "name": "Broccoli",
            "servingSize": 40,
            "calories": 14,
            "carbohydrates": 2.8,
            "proteins": 1.2,
            "fats": 0.2,
            "microNutrients": {
                "saturatedFat": 0,
                "polyunsaturatedFat": 0.1,
                "monounsaturatedFat": 0,
                "transFat": 0,
                "fibre": 1.1,
                "sugar": 1.2,
                "cholesterol": 0,
                "sodium": 12,
                "potassium": 230,
                "vitaminA": 31,
                "vitaminC": 40,
                "calcium": 20,
                "iron": 0.3
            }
        },
        {
            "name": "Cauliflower",
            "servingSize": 30,
            "calories": 7,
            "carbohydrates": 1.4,
            "proteins": 0.6,
            "fats": 0.1,
            "microNutrients": {
                "saturatedFat": 0,
                "polyunsaturatedFat": 0,
                "monounsaturatedFat": 0,
                "transFat": 0,
                "fibre": 0.6,
                "sugar": 0.6,
                "cholesterol": 0,
                "sodium": 15,
                "potassium": 150,
                "vitaminA": 0,
                "vitaminC": 20,
                "calcium": 10,
                "iron": 0.2
            }
        },
        {
            "name": "Zucchini",
            "servingSize": 30,
            "calories": 5,
            "carbohydrates": 1,
            "proteins": 0.4,
            "fats": 0.1,
            "microNutrients": {
                "saturatedFat": 0,
                "polyunsaturatedFat": 0,
                "monounsaturatedFat": 0,
                "transFat": 0,
                "fibre": 0.3,
                "sugar": 0.8,
                "cholesterol": 0,
                "sodium": 2,
                "potassium": 150,
                "vitaminA": 10,
                "vitaminC": 8,
                "calcium": 10,
                "iron": 0.2
            }
        },
        {
            "name": "Tomato",
            "servingSize": 20,
            "calories": 4,
            "carbohydrates": 0.9,
            "proteins": 0.2,
            "fats": 0.1,
            "microNutrients": {
                "saturatedFat": 0,
                "polyunsaturatedFat": 0,
                "monounsaturatedFat": 0,
                "transFat": 0,
                "fibre": 0.3,
                "sugar": 0.6,
                "cholesterol": 0,
                "sodium": 1,
                "potassium": 100,
                "vitaminA": 42,
                "vitaminC": 6,
                "calcium": 5,
                "iron": 0.1
            }
        },
        {
            "name": "Parmesan Cheese",
            "servingSize": 10,
            "calories": 43,
            "carbohydrates": 0.3,
            "proteins": 3.9,
            "fats": 3,
            "microNutrients": {
                "saturatedFat": 1.9,
                "polyunsaturatedFat": 0.1,
                "monounsaturatedFat": 0.8,
                "transFat": 0,
                "fibre": 0,
                "sugar": 0.1,
                "cholesterol": 9,
                "sodium": 180,
                "potassium": 12,
                "vitaminA": 40,
                "vitaminC": 0,
                "calcium": 110,
                "iron": 0.2
            }
        }
    ]
}
﻿
﻿
Usage
Guidelines for End User
For Optimal Results:
Capture a photo of the food you plan to eat, centering on the contents of your plate.
Ensure the meal occupies the majority of the image for better recognition.
Take off any packaging or utensils before snapping the photo.
Keep the background clutter-free; include only your plate or glass without additional items.
Use natural or bright lighting to clearly capture details of the food.
Adjust the angle to minimize items obscuring each other and at a slight angle for the best perspective.
Avoid using filters or enhancements that might alter the food’s appearance.
﻿
Requirements & Errors

Image Size
Minimum image size required: 512x512 pixel.
Errors
"error": {
        "name": "Error",
        "status": 500,
        "faults": [
            "Image is too small"
        ]
    }
"error": {
        "name": "Error",
        "status": 500,
        "faults": [
            "Image is too small"
        ]
    }
﻿
No Food Detected
Computer vision has not detected any food or drink in the provided image.
Errors
"error": {
     "name": "Error",
     "status": 400,
     "faults": [
         "No Food Detected"
    ]
}
"error": {
     "name": "Error",
     "status": 400,
     "faults": [
         "No Food Detected"
    ]
}
﻿
User ID not found
Bad Request, userUuid must be provided in String format. It is a unique identifier for your end-user that you use internally within your application.
Errors
"error": {
     "name": "BadRequestException",
     "status": 400,
     "faults": [
         "userUuid: userUuid must be a string"
    ]
}
"error": {
     "name": "BadRequestException",
     "status": 400,
     "faults": [
         "userUuid: userUuid must be a string"
    ]
}
﻿
Invalid API Key
No or wrong API key provided.
Errors
"error": {
   "name": "UnauthorizedException",
   "status": 401,
   "faults": [
       "Invalid API key"
   ]
}
"error": {
   "name": "UnauthorizedException",
   "status": 401,
   "faults": [
       "Invalid API key"
   ]
}
﻿
Missing or Incorrect Image URL
The imageLink must be an absolute URL that includes the full protocol (e.g., https://)
Errors
"error": {
    "name": "TypeError",
    "status": 500,
    "faults": [
       "Only absolute URLs are supported"
   ]
}
"error": {
    "name": "TypeError",
    "status": 500,
    "faults": [
       "Only absolute URLs are supported"
   ]
}
﻿
﻿
Measurement units
Curl
    "servingSize": g,
    "calories": kcal,
    "macroNutrients": {
        "carbohydrates": g,
        "proteins": g,
        "fats": g
    "microNutrients": {
        "saturatedFat": g,
        "polyunsaturatedFat": g,
        "monounsaturatedFat": g,
        "transFat": g,
        "fibre": g,
        "sugar": g,
        "cholesterol": mg,
        "sodium": mg,
        "potassium": mg,
        "vitaminA": mcg,
        "vitaminC": mg,
        "calcium": mg,
        "iron": mg
    "servingSize": g,
    "calories": kcal,
    "macroNutrients": {
        "carbohydrates": g,
        "proteins": g,
        "fats": g
    "microNutrients": {
        "saturatedFat": g,
        "polyunsaturatedFat": g,
        "monounsaturatedFat": g,
        "transFat": g,
        "fibre": g,
        "sugar": g,
        "cholesterol": mg,
        "sodium": mg,
        "potassium": mg,
        "vitaminA": mcg,
        "vitaminC": mg,
        "calcium": mg,
        "iron": mg
﻿
﻿
Response times
Response times can vary because the AI doesn’t always process images at the same speed. Even with the same photo, the system might take longer due to internal factors in how it analyzes the image and provides nutritional information. This means you might experience different wait times even when scanning the same meal.
Did this page help you?
Omron EU vs US Region
Nutrition AI API

Getting Started

Postman Collection Example

Usage

Guidelines for End User

Requirements & Errors Image Size

No Food Detected

User ID not found

Invalid API Key

Missing or Incorrect Image URL

﻿

Measurement units

Response times
