Whisk Docs
Whisk HomeHelp CenterDeveloper Tools
v1.0.0
v1.0.0
  • Overview
  • Guides
    • Creating An Account
    • Getting Started
    • Whisk Sandbox
  • API
    • Authentication
      • Server Token
      • Client Token
      • User Access Token
      • Anonymous Access
    • Recipes
      • Get Recipe
      • Get Recipe Categories
      • Recipe Objects
    • Recipe Discovery
      • Recipe Feed
      • Recipe Search
      • Get Similar Recipes
    • Shopping Lists
      • Get Shopping Lists
      • Create A Shopping List
      • Add Items To A Shopping List
      • List Analysis
    • Meal Plans
      • Meal Plan Management
      • Delete Meals
      • Auto-Generator
      • Error Handling
    • Retailers
      • Get Available Stores
      • Retailers Checkout Flow
      • Retailer Aliases
      • OAuth Retailer Flow
      • Retailer User Info
      • Search Store Items
    • Carts
      • Create a Cart
      • Update Cart Item
      • Splitting Combined Items
      • Add Items To Cart
      • Add Recipes To Cart
      • Get Cart Item Options
      • Swap Cart Item Product
      • Delete A Cart Or A Cart Item
      • Checkout
    • Users
      • Get A User
      • Update A User
    • 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
    • Tools
      • Autocomplete
  • 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
  • Tips and Tricks
    • Object IDs
    • URL Lookup
    • Searching
    • Multiple IDs request
  • Resources
    • Nutrients
    • Recipe Labels
    • Health Score, Glycemic Index, Glycemic Load
    • Whisk User Data
    • Supported Retailers
    • Optimizing Image Load
Powered by GitBook
On this page
  • Meal generation settings
  • Settings model
  • User profile

Was this helpful?

  1. API
  2. Meal Plans

Auto-Generator

PreviousDelete MealsNextError Handling

Last updated 5 years ago

Was this helpful?

This endpoint generates a meal plan for a specified period of time. How does it work?

  • The daily caloric intake is calculated according to specific fields in the user’s profile, i.e. their height, weight, sex and activity levels

  • The meal planner then composes a tailor made meal plan, composed of recipes taken from Whisk’s extensive and varied recipe database

PUT

/mealplan/v2/generate

More info:

Meal generation settings

To get and update the meal planner settings for each plan, use the following endpoints:

GET

/mealplan/v2/settings

More info:

PUT

/mealplan/v2/settings

More info:

Meal generation settings can also be specified as part of the , in which case the stored settings will be disregarded and overridden.

Settings model

ATTRIBUTE

TYPE

DESCRIPTION

servings

nubmer

The number of servings, i,e, people, for which this meal plan is generated.

calorie_per_day

number

The daily caloric intake which will be used to generate the meal plan, with a ±100 kcal variance.

week_template

array

Specifies which meals are to be generated in which daily spot. E.g: Monday: Lunch, slot 2 Tuesday: Breakfast, slot 1 and Lunch, slot 2 Wednesday: Breakfast, slot 1 and Lunch, slot 2 Thursday: Breakfast, slot 1 and Lunch, slot 2 Friday: Dinner, slot 3 Weekend: keep empty

replace_only_generated

boolean

If set to true, meals that were custom-created using the Add Meal endpoint will not be overridden. Only empty daily slots or automatically generated meals will be filled with the newly generated ones.

User profile

GET

/user/v2/me

PATCH

/user/v2/settings

This list of user profile preferences could impact the meal recommendation algorithm:

  • Age

  • Gender

  • Health goals

  • Height, Weight

  • Activity level

  • Dietary Preferences

  • Allergies and Intolerance

  • Disliked Ingredients

  • Cooking Preferences

To get and configure User profile you can use :

https://api.whisk.com/spec/#/MealPlanAPI/GenerateMealPlan2
https://api.whisk.com/spec/#/MealPlanAPI/GetMealPlanSettings2
https://api.whisk.com/spec/#/MealPlanAPI/UpdateMealPlanSettings2
generation request
these endpoints