Whisk Docs
Whisk HomeHelp CenterDeveloper Tools
v2.0.0
v2.0.0
  • The Whisk Platform
  • Whisk API Overview
    • Introduction
    • Integration
    • Authentication
      • Server Token
      • User Access Token
        • Auth Flow Example
      • Client Token
      • Anonymous Access from Client Apps
    • Whisk Sandbox
    • Getting Started
  • Whisk API Reference 2.0
    • Provisioning
      • Get provisioning
    • Autocomplete
    • Community
      • Get your Communities
      • Get Communities from a Topic
      • Discover Recommended Communities
      • Search Communities
      • Get a Community
      • Get Recipes from a Community
      • Add Recipes to a Community
      • Remove a Recipe from a Community
      • Join a Community
      • Leave a Community
    • Posts and Reviews
      • Get reviews for a recipe
      • Create or edit review
      • Create a Post
      • Get Post by id
      • Delete a Post
      • Edit a Post
      • Report a Post
      • Create a Post Reply
      • Get Post Replies
      • Delete a Post reply
      • Report a Post reply
      • Like a Post or Reply
      • Users who liked a Post or Reply
    • Public profiles
      • Hide recipe in Public profile
      • Get Recipes for Public Profile
      • Get User's public profile by user_id
      • Get User's public profile by username
    • Custom Label
    • Feed
      • Obtain a Recipe Feed
    • Food DB
      • Autocomplete
      • Search
      • Get Food
    • Food List
    • Food Log
    • Foodpairing
    • Healthy meal recommendations
      • Healthy recipe only recommendations for DA
      • Recipe recommendations for SH
      • Tailored Plan API request for Samsung TV
    • Meal Plan
      • Generate a Meal Plan
      • Meal Object
        • Get Meals
        • Delete Meal
        • Add a Meal
      • Meal Plan Settings Object
        • Get Meal Plan Settings
        • Update Meal Plan Settings
      • Meal Plan Batch
    • Recipe
      • Get a Recipe
      • Search a Recipe
      • User Recipes & Collections
        • Add User Recipe
        • Create A Recipe
        • Update External Recipe
        • Get All User Recipes
        • Update User Recipe
        • Remove Recipe from Favorites
        • Create Collection
        • Get All User Collections
        • Get Collection
        • Get Recipes from a Collection
        • Remove Collection
        • Get Smart Collection
        • Get Recipes from a Smart Collection
    • Shopping List
      • Get your Shopping Lists
      • Get a Shopping List
      • Create a Shopping List
      • Delete a Shopping List
      • Update basic details of a Shopping List
      • Move Items between Shopping Lists
      • Add Items to a Shopping List
      • Delete an Item from a Shopping List
      • Update an Item in a Shopping List
      • Clear Items from a Shopping List
    • Media
    • Store Item
    • Unit Conversion
    • Users
      • Get a User
      • Update User Settings using Patch
      • Update User Settings using Post
    • Try it out!
  • Shopping List SDK
    • Overview
    • Examples
      • Shoppable Recipes
      • Shoppable Products
      • Shoppable Media
    • Basic Setup
      • Basic Setup
      • Methods
      • Event Listeners
      • Widget
      • Subscriptions
      • Global Configuration
      • UTM Parameters
      • Using With SPA
  • Shopping List Mobile API
    • Overview
    • Examples
    • Reference
  • API Resources
    • Authentication Scopes
    • Errors and Troubleshooting
    • Cursor Pagination
    • Limits
    • Nutrients
    • Recipe Labels
    • Filtering Recipes using Custom Labels
    • Health Score, Glycemic Index, Glycemic Load
    • Whisk User Data
    • Integrated Retailers
    • Optimizing Image Load
    • Meal Plan
Powered by GitBook
On this page

Was this helpful?

  1. Whisk API Reference 2.0
  2. Healthy meal recommendations

Tailored Plan API request for Samsung TV

PreviousRecipe recommendations for SHNextMeal Plan

Last updated 3 months ago

Was this helpful?

Recommend for chosen mealtime and the whole week

GET "https://api.whisk.com/health/recommendations/v2/get_tailored_plan?period.from.year=2025&period.from.month=2&period.from.day=17&period.to.year=2025&period.to.month=2&period.to.day=23&meal_times=MEAL_TIME_BREAKFAST&meal_times=MEAL_TIME_LUNCH&meal_times=MEAL_TIME_DINNER&meal_times=MEAL_TIME_SNACK&fields=RECIPE_FIELD_INVALID" -H "accept: application/json" -H "Authorization: %USER_TOKEN%"

Recommend for chosen recipe fields and the whole day

GET "https://api.whisk.com/health/recommendations/v2/get_tailored_plan?period.from.year=2025&period.from.month=2&period.from.day=20&period.to.year=2025&period.to.month=2&period.to.day=20&meal_times=MEAL_TIME_DINNER&fields=RECIPE_FIELD_NORMALIZED_INGREDIENTS&fields=RECIPE_FIELD_INSTRUCTIONS&fields=RECIPE_FIELD_INSTRUCTION_INTENTS&fields=RECIPE_FIELD_NUTRITION&fields=RECIPE_FIELD_NUTRITION_COVERAGE&fields=RECIPE_FIELD_SAVED&fields=RECIPE_FIELD_INGREDIENTS_LINKED_PRODUCTS&fields=RECIPE_FIELD_SAVE_COUNT&fields=RECIPE_FIELD_NORMALIZED_INGREDIENT_NUTRITION&fields=RECIPE_FIELD_AVAILABILITY&fields=RECIPE_FIELD_CONTENT_POLICY_VIOLATION&fields=RECIPE_FIELD_AUTHOR&fields=RECIPE_FIELD_PARENT&fields=RECIPE_FIELD_REVIEWS_STATS&fields=RECIPE_FIELD_REVIEWS_TAGS&fields=RECIPE_FIELD_MY_REVIEW" -H "accept: application/json" -H "Authorization: %USER_TOKEN%"

Example response

This API allows you to request meal recommendations for either a single day or an entire week. You can flexibly configure your request by selecting the desired meal plan duration according to your needs.

Additionally, the API enables you to choose specific fields you want to include in the response. These may include:

  • Recipe ingredients – a complete list of ingredients required for each dish.

  • Nutritional information – details about calories, protein, fats, and carbohydrates for each recipe.

  • Cooking instructions – step-by-step guidance on how to prepare each dish.

  • Preparation time – an estimated time required to cook each recipe.

  • Meal category – such as breakfast, lunch, dinner, or snacks.

  • Dietary properties – labels indicating vegetarian, gluten-free, or other special dietary options.

This API provides a high level of flexibility and customization, allowing you to tailor meal recommendations to your preferences and requirements.

{
  "recommended_meals": [
    {
      "date": { "year": 2025, "month": 2, "day": 20 },
      "meal_time": "MEAL_TIME_DINNER",
      "recommended_meal_food": [
        {
          "recipe": {
            "id": "107018d00feb9a37d7ea3c8a4c9095bdb07",
            "name": "Korean Traditional Lunch Box Ideas 😊😋",
            "description": "Hello K Friends! ... Hope you enjoy it!",
            "ingredients": [
              { "text": "1C rice", "id": "0" },
              { "text": "7 oz (200g) bulgogi", "id": "1" },
              { "text": "7 oz (200g) stir fried kimchi", "id": "2" },
              { "text": "7 oz (200g) egg roll", "id": "3" },
              { "text": "7 oz (200g) cucumber salad", "id": "4" }
            ],
            "instructions": {
              "steps": [
                { "text": "Put 1 cup of rice in the rice cooker...", "instruction_intents": {}, "cooking_intents": {} },
                { "text": "Pour about 1 and a half cups of water...", "instruction_intents": {}, "cooking_intents": {} },
                "..."
              ]
            },
            "images": [
              {
                "responsive": { "url": "https://cloudinary-cdn.whisk.com/image/upload/..." },
                "url": "https://whisk-res.cloudinary.com/image/upload/..."
              }
            ],
            "servings": 2,
            "durations": { "cook_time": 30, "prep_time": 30, "total_time": 60 },
            "normalized_ingredients": "...",
            "nutrition": {
              "status": "STATUS_AVAILABLE",
              "total": [
                {
                  "label": "Total Fat",
                  "code": "NUTRITION_CODE_FAT",
                  "code_translated": { "name": "FAT", "display_name": "Total Fat" },
                  "value": 35.759,
                  "unit": "NUTRITION_UNIT_G",
                  "unit_translated": { "name": "G", "display_name": "g" }
                },
                "..."
              ],
              "coverage": 1,
              "health_score": { "value": 6.054, "nutrients_influence": "..." },
              "glycemic_index": { "value": 54.04 },
              "glycemic_load": { "value": 73.45 }
            },
            "language": "en",
            "save_count": 243,
            "recipe_availability": {
              "banned_in_some_communities": { "community_ids": ["0e11c742066a4d8aadd2375423bb28ed"] }
            },
            "content_policy_violation": {
              "text_status": "MODERATION_STATUS_SUCCESS",
              "image_status": "MODERATION_STATUS_SUCCESS",
              "ingredients_status": "MODERATION_STATUS_SUCCESS"
            },
            "source": { "license": "LICENCE_EXTENDED" },
            "creator": {
              "id": "10222d17ec38c9f4217b00dd05c70f26104",
              "first_name": "Chung's K Food",
              "...": "..."
            },
            "recipe_author": {
              "user": {
                "id": "10222d17ec38c9f4217b00dd05c70f26104",
                "first_name": "Chung's K Food",
                "..."
              }
            },
            "permissions": { "is_instructions_enabled": true, "is_guided_cooking_enabled": true },
            "videos": [ { "embed_url": "https://www.youtube.com/embed/BzArD0TZCCE" } ],
            "recipe_videos": [
              {
                "youtube_video": {
                  "original_link": "https://youtu.be/BzArD0TZCCE",
                  "normalized_link": "https://www.youtube.com/embed/BzArD0TZCCE",
                  "video_id": "BzArD0TZCCE"
                }
              }
            ],
            "reviews": {}
          }
        }
      ]
    }
  ]

Note. Limitations on this endpoint:

  1. Recipe Recommendations Only: This endpoint provides only recipe recommendations—combinations like recipe/side dish or product/product are not supported.

  2. Fallback for Non–Food+ Users: For users without Food+, health data is disregarded, and recommendations are based on a standard 2000-calorie daily intake.

Full API reference
Full API reference