Whisk Docs

v2.0.0

• The Whisk Platform: Introducing the Whisk Platform.
• Introduction: Learn how to integrate Whisk to power your food applications using our REST API.
• Integration: Learn how to integrate with the Whisk.
• Authentication: Learn how to authenticate the use of Whisk API services.
• Server Token: A server token allows you to enable server-to-server integration with Whisk for non-personalized data.
• User Access Token: A user access token authorizes you to read, modify or write data on behalf of a specific Whisk user.
• Auth Flow Example: Learn about the Whisk authentication flow.
• Client Token: A client token allows you to access a limited subset of Whisk APIs in read-only mode.
• Anonymous Access from Client Apps
• Whisk Sandbox: Whisk Sandbox allows risk and cost free testing of our API services.
• Getting Started
• Provisioning
• Get provisioning: Endpoint allows to get provisioning data
• Autocomplete: The Autocomplete endpoint allows you to guess a product a user is writing into an input field. It then may be displayed as a shopping list or search suggestion.
• Community: The Community API service offers you the ability to discover, search, and retrieve communities related to recipe content that exist on Whisk.
• Get your Communities: This endpoint retrieves a list of communities filtered by your role and pagination.
• Get Communities from a Topic: This endpoint retrieves the list of communities from a specific topic using the topic identifier and pagination filters.
• Discover Recommended Communities: This endpoint retrieves a list of communities recommended to you by Whisk.
• Search Communities: This endpoint allows you to search for communities using keywords and various filters.
• Get a Community: This endpoint retrieves community details using the community identifier.
• Get Recipes from a Community: This endpoint retrieves a list of recipes from a specific community using the community identifier and pagination filters.
• Add Recipes to a Community: This endpoint allows you add a batch of existing recipes in a community.
• Remove a Recipe from a Community: This endpoint allows you to remove a recipe from a community.
• Join a Community: This endpoint allows to become a member of a public community.
• Leave a Community: This endpoint allows to leave a community.
• Posts and Reviews: Posts and reviews API allows to support social functions in your App, like writing reviews for recipes , add Posts (with different types attached content), leave replies.
• Get reviews for a recipe: API endpoint allows you to get reviews for particular recipe
• Create or edit review: Endpoint allows to create new review or edit existing review
• Create a Post: Endpoint allows to create new Post
• Get Post by id: Endpoint allows to get Post by Id
• Delete a Post: Endpoint allows to delete a post
• Edit a Post: Endpoint allows to create new Post
• Report a Post: Endpoint allows to report a post
• Create a Post Reply: Endpoint allows to create new Reply
• Get Post Replies: Endpoint allows to get Reply by Id
• Delete a Post reply: Endpoint allows to delete a reply
• Report a Post reply: Endpoint allows to report post reply
• Like a Post or Reply: Endpoint allows to like existing post or Reply
• Users who liked a Post or Reply: Endpoint allows to get users who liked existing post or Reply
• Public profiles: Posts and reviews API allows to support social functions in your App, like writing reviews for recipes , add Posts (with different types attached content), leave replies.
• Hide recipe in Public profile: Endpoint allows user who don't want to show recipe in public profile to hide it. Recipe will remain in his recipe box (favourites)
• Get Recipes for Public Profile: There are recipes displayed in public profile, based on several conditions. Endpoint allows to get recipes available in public profile.
• Get User's public profile by user_id: Endpoint allows to get user's public profile by Id
• Get User's public profile by username: Endpoint allows to get user's public profile by Username
• Custom Label: Custom labels are user-defined labels added to recipes.
• Feed
• Obtain a Recipe Feed
• Food DB
• Autocomplete: GET https://api.whisk.com/food/v2/autocomplete
• Search: POST https://api.whisk.com/food/v2/search
• Get Food: GET https://api.whisk.com/food/v2/get
• Food List
• Food Log: Food logging is often used in pair with Healthy recipe recommendations
• Foodpairing
• Healthy meal recommendations
• Healthy recipe only recommendations for DA
• Recipe recommendations for SH: A method to fetch a set of recipes supporting a certain calorie goal
• Tailored Plan API request for Samsung TV
• Meal Plan
• Generate a Meal Plan
• Meal Object
• Get Meals: A method to get a meal.
• Delete Meal: A method to delete a meal from a meal plan.
• Add a Meal: A method to add a meal to a meal plan.
• Meal Plan Settings Object: The meal plan settings object
• Get Meal Plan Settings
• Update Meal Plan Settings
• Meal Plan Batch
• Recipe: The Recipe API service lets you read and write any internal and external recipes and your Whisk recipe collections.
• Get a Recipe
• Search a Recipe: A method to search recipes.
• 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: Method for getting smart collections. Smart collections are special types of collections created automatically in Whisk. Content in smart collections also updates automatically based on user actions.
• Get Recipes from a Smart Collection: Method allow to get all recipes in Smart collection
• Shopping List: The Shopping List API service offers you the ability to read and write your shopping list data.
• Get your Shopping Lists: This endpoint offers you the ability to read reference details of all your shopping lists that exist in your Whisk account.
• Get a Shopping List: This endpoint allows you to read data of a shopping list.
• Create a Shopping List: This endpoint allows you create a new shopping list.
• Delete a Shopping List: This endpoint allows you to delete any secondary shopping list.
• Update basic details of a Shopping List: This endpoint allows you to update the shopping list name or set/reset it as primary.
• Move Items between Shopping Lists: This endpoints allows you to move shopping list items from one shopping list to another.
• Add Items to a Shopping List: This endpoints allows you to add items to your shopping list.
• Delete an Item from a Shopping List: This endpoint allows you remove an item from a shopping list.
• Update an Item in a Shopping List: This endpoint allows you update an item in a shopping list.
• Clear Items from a Shopping List: This endpoint allows you to remove items from a shopping list.
• Media: Media service API allow to upload images into the whisk cloud. Maximum image size is 50M
• Store Item
• Unit Conversion
• Users
• Get a User
• Update User Settings using Patch
• Update User Settings using Post
• Overview
• Examples
• Shoppable Recipes
• Shoppable Products
• Shoppable Media
• Basic Setup
• Basic Setup
• Methods
• Event Listeners
• Widget
• Subscriptions
• Global Configuration
• UTM Parameters
• Using With SPA
• Overview
• Examples
• Reference
• Authentication Scopes: A list of supported auth scopes for token generation.
• Errors and Troubleshooting: All supported errors that you may unfortunately encounter while using Whisk API.
• Cursor Pagination
• Limits
• Nutrients: Nutrition calculations, Macronutrients, and Micronutrients.
• Recipe Labels
• Filtering Recipes using Custom Labels: This topic comprehensively describes how you can use the Custom Labels filter to search recipes.
• Health Score, Glycemic Index, Glycemic Load
• Whisk User Data
• Integrated Retailers: List of retailers that are integrated with Whisk.
• Optimizing Image Load
• Meal Plan

v1.0.0

• Overview
• Creating An Account
• Getting Started
• Whisk Sandbox
• 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
• Overview
• Examples
• Shoppable Recipes
• Shoppable Products
• Shoppable Media
• Basic Setup
• Basic Setup
• Methods
• Event Listeners
• Widget
• Subscriptions
• Global Configuration
• UTM Parameters
• Using With SPA
• Overview
• Examples
• Reference
• Object IDs
• URL Lookup
• Searching
• Multiple IDs request
• Nutrients
• Recipe Labels
• Health Score, Glycemic Index, Glycemic Load
• Whisk User Data
• Supported Retailers
• Optimizing Image Load

Agent Instructions: Querying This Documentation

If you need additional information, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on a page URL with the ask query parameter:

GET https://docs.whisk.com/readme.md?ask=<question>

The question should be specific, self-contained, and written in natural language. 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.