> For the complete documentation index, see [llms.txt](https://docs.whisk.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.whisk.com/api/healthy-meal-recommendations/healthy-recipe-only-recommendations-for-sh.md). # Recipe recommendations for SH {% hint style="info" %} To provide diversity across recommended recipes result is shuffled for every request. We return recipes with calories per serving matching the range from 85% to 120% from requested {% endhint %} {% hint style="warning" %} Recommended integration flow is below. Let us know if it's not possible {% endhint %} ###

Recommended integration flow

### [Swagger Spec](https://api.whisk.com/spec/#/HealthyRecipeAPI/HealthyRecipeAPI_Search) ## Get Healthy Recipes `GET` `https://samsung-health-api.whisk.com/health/recipe/v2/search?` #### Path Parameters
NameTypeDescription
meal_time*stringMeal time for which to recommend recipes. One of MEAL_TIME_BREAKFAST,MEAL_TIME_LUNCH,MEAL_TIME_DINNER,MEAL_TIME_SNACK
calories*numberCalorie target for selected meal, kcal
languagestringISO 639-1 two letter language code. We return certain text fields localized. We do not perform mapping country to language. Client should select and pass language explicitly. The list of supported languages will be communicated separately. Default en
countrystringISO 3166-1 two letter country code. We may boost certain meals depending on user's country. The list of supported countries will be communicated separately. Default US
limit*numberNumber of recipes to be returned. Max 20
response_mask*string[]The list of recipe fields which should be returned. We return .explicitly requested fields only to save users' traffic. Possible values are id, title, image, nutrition, recipe_link, number_of_servings
{% tabs %} {% tab title="200 " %} ```javascript { "recipes": [ { "id": "107d638402cd5cd4dcbae589a0032668444", "title": "French toast by Lau", "image": { "url": "https://cloudinary-cdn.whisk.com/image/upload/v1592914668/recipe/61010b3adc018e6ab6aae7051771901f.jpg" }, "nutrition": { "nutrition": [ { "amount": 1.0110000000000001, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_NIA" }, { "amount": 0.05, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_FATRN" }, { "amount": 212.29, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_CHOCDF" }, { "amount": 800.76, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_CHOLE" }, { "amount": 593.9530000000001, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_P" }, { "amount": 326.521, "unit_name": "NUTRITION_UNIT_MKG", "code": "NUTRITION_CODE_VITA_RAE" }, { "amount": 6.072, "unit_name": "NUTRITION_UNIT_MKG", "code": "NUTRITION_CODE_VITD" }, { "amount": 74.66499999999999, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_MG" }, { "amount": 0.652, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_VITB6A" }, { "amount": 4.7219999999999995, "unit_name": "NUTRITION_UNIT_MKG", "code": "NUTRITION_CODE_VITK1" }, { "amount": 58.717999999999996, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_PROCNT" }, { "amount": 27.552, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_VITC" }, { "amount": 460.392, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_CA" }, { "amount": 83.40100000000001, "unit_name": "NUTRITION_UNIT_MKG", "code": "NUTRITION_CODE_FOL" }, { "amount": 2.978, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_FAPU" }, { "amount": 71.81699999999998, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_SUGAR" }, { "amount": 1760.569, "unit_name": "NUTRITION_UNIT_KCAL", "code": "NUTRITION_CODE_ENERC_KCAL" }, { "amount": 17.968, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_FIBTG" }, { "amount": 69.349, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_FAT" }, { "amount": 926.807, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_K" }, { "amount": 1551.4779999999996, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_NA" }, { "amount": 3.1229999999999998, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_ZN" }, { "amount": 33.238, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_FASAT" }, { "amount": 1.7710000000000001, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_TOCPHA" }, { "amount": 1.0949999999999998, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_RIBF" }, { "amount": 2.827, "unit_name": "NUTRITION_UNIT_MKG", "code": "NUTRITION_CODE_VITB12" }, { "amount": 0.269, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_THIA" }, { "amount": 2.662, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_FE" }, { "amount": 6.9799999999999995, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_FAMS" } ] }, "recipe_link": "https://app.samsungfood.com/recipes/107d638402cd5cd4dcbae589a0032668444", "number_of_servings": 4 }, ... ] } ``` {% endtab %} {% tab title="400 If some request parameter is invalid, unsupported, or out of bound" %} ```javascript { "code": "general.badRequest", "message": "language is incorrect" } ``` {% endtab %} {% tab title="403: Forbidden " %} ```javascript { // Response } ``` {% endtab %} {% tab title="500: Internal Server Error " %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} ### Sample Request The example below requests five Breakfast options around 400 kcal in English language. All fields are requested. ``` curl -X GET "https://api.whisk.com/health/recipe/v2/search?meal_time=MEAL_TIME_BREAKFAST&calories=400&language=en&country=gb&limit=5&response_mask.paths=id&response_mask.paths=title&response_mask.paths=image&response_mask.paths=nutrition&response_mask.paths=recipe_link&response_mask.paths=number_of_servings" -H "accept: application/json" -H "Authorization: Token %TOKEN%" ``` ### Response Data returned in JSON. Empty strings, zero values, empty arrays and null values are not returned. #### Json response example with the proper response\_mask.paths specified ```javascript { "recipes": [ { "id": "107d638402cd5cd4dcbae589a0032668444", "title": "French toast by Lau", "image": { "url": "https://cloudinary-cdn.whisk.com/image/upload/v1592914668/recipe/61010b3adc018e6ab6aae7051771901f.jpg" }, "nutrition": { "nutrition": [ { "amount": 1.0110000000000001, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_NIA" }, { "amount": 0.05, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_FATRN" }, { "amount": 212.29, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_CHOCDF" }, { "amount": 800.76, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_CHOLE" }, { "amount": 593.9530000000001, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_P" }, { "amount": 326.521, "unit_name": "NUTRITION_UNIT_MKG", "code": "NUTRITION_CODE_VITA_RAE" }, { "amount": 6.072, "unit_name": "NUTRITION_UNIT_MKG", "code": "NUTRITION_CODE_VITD" }, { "amount": 74.66499999999999, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_MG" }, { "amount": 0.652, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_VITB6A" }, { "amount": 4.7219999999999995, "unit_name": "NUTRITION_UNIT_MKG", "code": "NUTRITION_CODE_VITK1" }, { "amount": 58.717999999999996, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_PROCNT" }, { "amount": 27.552, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_VITC" }, { "amount": 460.392, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_CA" }, { "amount": 83.40100000000001, "unit_name": "NUTRITION_UNIT_MKG", "code": "NUTRITION_CODE_FOL" }, { "amount": 2.978, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_FAPU" }, { "amount": 71.81699999999998, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_SUGAR" }, { "amount": 1760.569, "unit_name": "NUTRITION_UNIT_KCAL", "code": "NUTRITION_CODE_ENERC_KCAL" }, { "amount": 17.968, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_FIBTG" }, { "amount": 69.349, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_FAT" }, { "amount": 926.807, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_K" }, { "amount": 1551.4779999999996, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_NA" }, { "amount": 3.1229999999999998, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_ZN" }, { "amount": 33.238, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_FASAT" }, { "amount": 1.7710000000000001, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_TOCPHA" }, { "amount": 1.0949999999999998, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_RIBF" }, { "amount": 2.827, "unit_name": "NUTRITION_UNIT_MKG", "code": "NUTRITION_CODE_VITB12" }, { "amount": 0.269, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_THIA" }, { "amount": 2.662, "unit_name": "NUTRITION_UNIT_MG", "code": "NUTRITION_CODE_FE" }, { "amount": 6.9799999999999995, "unit_name": "NUTRITION_UNIT_G", "code": "NUTRITION_CODE_FAMS" } ] }, "recipe_link": "https://app.samsungfood.com/recipes/107d638402cd5cd4dcbae589a0032668444", "number_of_servings": 4 }, ... ] } ``` ### Core attributes | Name | Type | Description | | -------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | recipes | array | top-level container object | | recipes.id | string | unique recipe identifier across Samsung Food | | recipes.title | string | recipe title | | recipes.nutrition | object | container object | | recipes.nutrition.nutrition | array | container array | | recipes.nutrition.nutrition.amount | number | amount for a certain nutrient per 1 recipe serving | | recipes.nutrition.nutrition.unit\_name | string | nutrient unit name, depends on the nutrient. One of `NUTRITION_UNIT_G, NUTRITION_UNIT_MG, NUTRITION_UNIT_MKG, NUTRITION_UNIT_KCAL` | | recipes.nutrition.nutrition.code | string |

nutrient code. The following nutrients are supported:
NUTRITION\_CODE\_ENERC\_KCAL: Energy, NUTRITION\_CODE\_FAT: Total Fat, NUTRITION\_CODE\_FASAT: Saturated Fat, NUTRITION\_CODE\_CHOCDF: Carbohydrate Total, NUTRITION\_CODE\_SUGAR: Sugars, NUTRITION\_CODE\_PROCNT: Protein, NUTRITION\_CODE\_NA: Sodium, NUTRITION\_CODE\_FIBTG: Fiber, NUTRITION\_CODE\_FATRN: Trans Fat, NUTRITION\_CODE\_FAMS: Monounsaturated Fat, NUTRITION\_CODE\_FAPU: Polyunsaturated Fat, NUTRITION\_CODE\_FAT\_UNSAT: Unsaturated Fat, NUTRITION\_CODE\_CHOLE: Cholesterol, NUTRITION\_CODE\_CA: Calcium, NUTRITION\_CODE\_MG: Magnesium, NUTRITION\_CODE\_K: Potassium, NUTRITION\_CODE\_FE: Iron, NUTRITION\_CODE\_ZN: Zinc, NUTRITION\_CODE\_P: Phosphorus, NUTRITION\_CODE\_VITA\_RAE: Vitamin A, NUTRITION\_CODE\_VITC: Vitamin C, NUTRITION\_CODE\_THIA: Thiamin B1, NUTRITION\_CODE\_RIBF: Riboflavin B2, NUTRITION\_CODE\_NIA: Niacin B3, NUTRITION\_CODE\_VITB6A: Vitamin B6, NUTRITION\_CODE\_FOL: Folic Acid B9, NUTRITION\_CODE\_VITB12: Vitamin B12, NUTRITION\_CODE\_VITD: Vitamin D, NUTRITION\_CODE\_TOCPHA: Vitamin E, NUTRITION\_CODE\_VITK1: Vitamin K

| | recipes.image | object | container object | | recipes.image.url | string | Image url leading to Samsung Food CDN | | recipes.recipe\_link | array | A link to the recipe on Samsung Food | | recipes.number\_of\_servings | array | Default number of serving for the recipe | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.whisk.com/api/healthy-meal-recommendations/healthy-recipe-only-recommendations-for-sh.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.