Integrating with Spike API
API Reference: User Management
API Reference: Querying Data
API Reference: Nutrition AI
API Reference: Lab Reports
Release Notes
curl --request PATCH \
--url https://app-api.spikeapi.com/v3/nutrition_records/{nutrition_record_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"consumed_at": "2023-11-07T05:31:56Z",
"serving_size": 123
}
'{
"dish_name": "<string>",
"serving_size": 1.01,
"unit": "g",
"consumed_at": "2023-11-07T05:31:56Z",
"dish_description": "<string>",
"dish_description_translated": "<string>",
"dish_name_translated": "<string>",
"failure_reason": "<string>",
"ingredients": [
{
"name": "<string>",
"serving_size": 123,
"unit": "g",
"name_translated": "<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
}
}
],
"input_type": "image",
"modified_at": "2023-11-07T05:31:56Z",
"nutri_score": "<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
},
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"uploaded_at": "2023-11-07T05:31:56Z",
"user_time_offset_minutes": 123
}Modify Nutrition Record
Change the portion size for a nutrition record by ID.
You can modify the nutrition record by updating the total serving size or consumption time. At least one of these fields must be provided.
The status of the successfully modified record will be set to updated while the input type will preserve the original value.
Updating Serving Size
When the serving size is changed, all ingredients and their respective nutritional fields will be automatically recalculated proportionally to maintain the same nutritional ratios. This allows you to easily adjust portion sizes while maintaining accurate nutritional information.
The new serving size is expected to be in the same unit as the original serving size.
Setting Up Consumption Time
The consumption time indicates when the food was actually consumed. Leaving the consumption time empty or not providing it will keep the original value.
This allows you to first track planned meals (without consumption time) and eventually mark them as consumed by setting up consumption time.
curl --request PATCH \
--url https://app-api.spikeapi.com/v3/nutrition_records/{nutrition_record_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"consumed_at": "2023-11-07T05:31:56Z",
"serving_size": 123
}
'{
"dish_name": "<string>",
"serving_size": 1.01,
"unit": "g",
"consumed_at": "2023-11-07T05:31:56Z",
"dish_description": "<string>",
"dish_description_translated": "<string>",
"dish_name_translated": "<string>",
"failure_reason": "<string>",
"ingredients": [
{
"name": "<string>",
"serving_size": 123,
"unit": "g",
"name_translated": "<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
}
}
],
"input_type": "image",
"modified_at": "2023-11-07T05:31:56Z",
"nutri_score": "<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
},
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"uploaded_at": "2023-11-07T05:31:56Z",
"user_time_offset_minutes": 123
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Nutrition report record ID
Body
Response
OK
Detected dish name
"beef and broccoli stir-fry"
Serving size in metric units
x >= 0.01120
Metric unit (g for solids, ml for liquids)
g, mg, mcg, ml, kcal "g"
The UTC time when food was consumed. By default, it is set to the record update time
"2006-01-02T15:04:05"
"2006-01-02T15:04:05Z"
Detected dish description
"beef, ground, lean, cooked with broccoli, raw and rice, brown, cooked"
Dish description translated to target language
"Rindfleisch, Hackfleisch, mager, gekocht mit Brokkoli, roh und Reis, braun, gekocht"
Dish name translated to target language
"Rindfleisch und Brokkoli Pfanne"
Reason for processing failure
"Unable to identify food items"
List of detected ingredients with nutritional information
Show child attributes
Show child attributes
Nutrition record input type
image, manual "image"
Update timestamp in UTC
"2025-09-15T10:30:12.132Z"
Nutri-Score known as the 5-Colour Nutrition label (A-E)
"B"
Nutritional values in the given serving size
Show child attributes
Show child attributes
Report record ID
"6ba7b810-9dad-11d1-80b4-00c04fd430c8"
Processing status
pending, processing, completed, failed, updated "completed"
Upload timestamp in UTC
"2025-09-15T10:30:04.521Z"
User's local timezone offset in minutes
-540