Skip to main content
Analyze Nutrition Facts Label
curl --request POST \
  --url https://app-api.spikeapi.com/v3/nutrition_records/ingredients/label \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "analysis_mode": "precise",
  "body": "<string>",
  "body_url": "<string>"
}
'
{
  "name": "<string>",
  "serving_size": 1.01,
  "unit": "g",
  "failure_reason": "<string>",
  "nutritional_fields": {
    "calcium_mg": 123,
    "carbohydrate_g": 123,
    "cholesterol_mg": 123,
    "energy_kcal": 123,
    "fat_monounsaturated_g": 123,
    "fat_polyunsaturated_g": 123,
    "fat_saturated_g": 123,
    "fat_total_g": 123,
    "fat_trans_g": 123,
    "fiber_total_dietary_g": 123,
    "folate_mcg": 123,
    "iron_mg": 123,
    "magnesium_mg": 123,
    "niacin_mg": 123,
    "phosphorus_mg": 123,
    "potassium_mg": 123,
    "protein_g": 123,
    "riboflavin_mg": 123,
    "salt_g": 123,
    "salt_mg": 123,
    "sodium_g": 123,
    "sodium_mg": 123,
    "sugars_total_g": 123,
    "thiamin_mg": 123,
    "vitamin_a_rae_mcg": 123,
    "vitamin_b12_mcg": 123,
    "vitamin_b6_mg": 123,
    "vitamin_c_mg": 123,
    "vitamin_d_mcg": 123,
    "vitamin_e_mg": 123,
    "vitamin_k_mcg": 123,
    "zinc_mg": 123
  },
  "status": "completed"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
analysis_mode
enum<string>
default:precise

A preferred mode for the analysis

Available options:
fast,
precise
body
string

Base64-encoded binary data, this or 'body_url' is required

body_url
string

URL to the image, this or 'body' is required

Response

OK

name
string
required

Detected ingredient name

Example:

"beef and broccoli stir-fry"

serving_size
number<double>
required

Serving size in metric units

Required range: x >= 0.01
Example:

120

unit
enum<string>
required

Metric unit (g for solids, ml for liquids)

Available options:
g,
mg,
mcg,
ml,
kcal
Example:

"g"

failure_reason
string

Reason for processing failure

Example:

"Unable to identify label"

nutritional_fields
object

Nutritional values in the given serving size

status
enum<string>

Processing status

Available options:
completed,
failed
Example:

"completed"