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
  • API Services
  • API Request
  • API Response

Was this helpful?

  1. Whisk API Overview

Introduction

Learn how to integrate Whisk to power your food applications using our REST API.

PreviousThe Whisk PlatformNextIntegration

Last updated 1 year ago

Was this helpful?

We do not accept new API clients now

Whisk API lets you connect to our platform and use services for recipe feed and search, shopping lists, food data, and personalization. The API is HTTP-based, so it works with any language that has an HTTP library, such as cURL.

API Services

Here is the list of services that our API provides:

Service

Description

The Recipe API allows you to pull recipes from external sources and normalize and enrich their content with smart data. It also offers functionalities to integrate recipe search on your website or app and lets you create and delete recipes and manage recipe collections on the Whisk platform.

The Feed API allows you to get smart recommendations on recipe content based on your existing content and user preferences if you are part of the Whisk ecosystem.

The Meal Plan API provides you the functionality to create a meal schedule made up of specific recipes during a period.

The Shopping List API provides a simple way to integrate Whisk’s add-to-basket functionality into your website or app, allowing you to send items and recipes to an online grocery cart.

The Store Item API allows you to retrieve store items from a specific retailer.

The Food List API allows you to track items in your pantry or refrigerator and use it for recommendations.

The Community API allows you to discover, search and retrieve communities related to recipe content from the Whisk platform.

The Custom Label API allows you to retrieve a list of all labels that you created on the Whisk platform.

The Users API allows you to handle user management on the Whisk platform.

API Request

A Whisk API request is composed of:

Endpoint

The Endpoint is the URL you use to send a request. You can also call it a Request URL. It follows this structure:

https://api.whisk.com/recipe/v2/1124ba?quantity.servings=2

An Endpoint contains the following components.

Component

Description

Example

Host

The Whisk API domain.

api.whisk.com

Resource Path

The path to the resource. In the example, the path leads to a recipe resource.

/recipe/v2/1124ba

Query Parameters

Options to modify your request with key-value pairs. An endpoint may or may not have query parameters depending on the need.

?quantity.servings=2

HTTP Method

An HTTP method represents the type of request you send to the server.

The primary or most-commonly-used HTTP methods are:

  • POST: Creates a resource.

  • GET: Retrieves one or more resources.

  • PUT: Updates a resource.

  • DELETE: Deletes a resource.

These correspond to create, read, update, and delete (or CRUD) operations, respectively. While working with Whisk API, you can also come across other less used verbs, like PATCH or UPSERT.

Headers

-H "Accept: application/json" \
-H "Authorization: Token <YOUR-API-ACCESS-TOKEN>"

Body

{
  "name": "New Recipes Collection"
}

The Body contains information you want to send to the server. This option is only used with POST, PUT, PATCH or DELETE requests. A GET request has no body. Whisk API uses JSON (JavaScript Object Notation) as its content format to specify the body in the request.

API Response

Headers are property-value pairs used for specifying for authentication and providing information about the body content type.

All Whisk API responses are formatted in JSON and include a status code. For more information on the different status codes that our API supports, see .

access token
Status Codes and Error Handling
The Endpoint or Request URL
HTTP Method
The Headers
The Body
Recipe
Feed
Meal Plan
Shopping List
Store Item
Food List
Community
Custom Label
Users