Add recipe to favorites

This API available only for user access-token integration
POST
/v1beta/recipes

This endpoint allows to add favorite recipe.

It will return 400 error code if a limit of allowed number of saved recipes is exceeded. Limit is 50 recipes per user.

Partialy added recipe

If recipe was not sucessfully extracted from site. It means Whisk was not able to understand at least name and recipe ingredients.

Whisk will create a recipe copy for this user. So a user will be able to finish up a recipe by himself.

Recipe state will be failed, in case if whisk was not able to parse recipe.

Request parameters

ATTRIBUTETYPEDESCRIPTION
fieldsarray [string]

Extra fields to return on recipe

Possible values: normalizedIngredients, instructions, nutrition.

Request Body

ATTRIBUTETYPEDESCRIPTION
recipeId*string

Identifier of a Recipe to add.

collectionIdsarray

Collections for this recipe. If not specified it will add recipe without collection

Sample Request

curl "https://graph.whisk.com/v1beta/recipes" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer <Access-Token>" \ -d '{ "recipeId": "3d4fda8595114a3a9f7b12fd471a4169" }'

Response

ATTRIBUTETYPEDESCRIPTION
recipeManualRecipeDetails

Recipe details.

partiallyParsedPartialRecipeDetails

If parsing status is failed we can provide some fields whisk were abble to parse.

status*enum
Possible values: success, failure.

RawIngredient

ATTRIBUTETYPEDESCRIPTION
text*string
groupstring

NormalizedIngredient

ATTRIBUTETYPEDESCRIPTION
text*string
groupstring
analysisRecipeIngredientAnalysis

RawIngredient

ATTRIBUTETYPEDESCRIPTION
text*string
groupstring

RecipeIngredientAnalysis

ATTRIBUTETYPEDESCRIPTION
product*string
canonicalName*string
quantitynumber
unitstring
multipliernumber
brandstring
commentstring
categorystring

RecipeInstruction

ATTRIBUTETYPEDESCRIPTION
text*string
groupstring
imagesarray [ImageContainer]

RecipeInstructions

ATTRIBUTETYPEDESCRIPTION
steps*array [RecipeInstruction]

ProductCategory

ATTRIBUTETYPEDESCRIPTION
name*string

ImageContainer

ATTRIBUTETYPEDESCRIPTION
url*string

original image url, depricated. Please use field original instead

originalOriginalImage

original image information, e.g. image url

responsive*ResponsiveImage

ResponsiveImage

ATTRIBUTETYPEDESCRIPTION
url*string

Hosted url of an image

width*integer

Image width

height*integer

Image height

OriginalImage

ATTRIBUTETYPEDESCRIPTION
url*string

URL of the image

VideoContainer

ATTRIBUTETYPEDESCRIPTION
urlstring

URL to original video provider page

contentUrlstring

URL to video file. Actual bytes of the media object

embedUrlstring

An embed format of video with player

playerTypeenum
Possible values: flash, html5, silverlight.
thumbnailstring

A thumbnail image relevant to the Video

durationnumber

The duration of the recording

heightnumber

The height of the item

widthnumber

The width of the item

RecipeSource

ATTRIBUTETYPEDESCRIPTION
name*string
displayNamestring
sourceRecipeUrlstring
licensestring
imageImageContainer

RecipeLabels

ATTRIBUTETYPEDESCRIPTION
mealType*array [RecipeLabel]
cuisine*array [RecipeLabel]
category*array [RecipeLabel]

RecipeLabel

Some RecipeLabel description

ATTRIBUTETYPEDESCRIPTION
name*string
displayName*string

RecipeDurations

ATTRIBUTETYPEDESCRIPTION
cookTimenumber

Cooking time in minutes

prepTimenumber

Preparation time in minutes

totalTimenumber

Total time in minutes

RecipeConstraints

ATTRIBUTETYPEDESCRIPTION
violates*ConstraintsCollection

Constraints which are violated in a recipe

ConstraintsCollection

ATTRIBUTETYPEDESCRIPTION
diets*array

List of diets

Possible values: lacto-vegetarian, ovo-vegetarian, ovo-lacto-vegetarian, pescatarian, vegan, vegetarian.
avoidances*array

List of avoidances and intolerances

Possible values: celery, crustacean, egg, fish, groundnut, milk, mollusc, mustard, sesame, soybean, sulphites, tree-nut, wheat.

RecipeSaved

ATTRIBUTETYPEDESCRIPTION
valueboolean

True if this recipe is saved to favorites

collectionIdsarray [string]
ownerboolean

If current user is owner of the recipe

typeenum

Recipe type

Possible values: manual, imported.

RecipeAuthor

ATTRIBUTETYPEDESCRIPTION
name*string
imageImageContainer

Sample Response

{ "recipe": { "id": "1070c26c320ce194efca97093e72517b4e7", "name": "Home made pasta", "description": "Pasta with tomato souce", "ingredients": [ { "text": "Pappardelle pasta" }, { "text": "5 tomatoes" }, { "text": "3tbs of olive oil" } ], "saved": { "value": true, "collectionIds": [ "cd037513c9e149a1b707e85eab1fc7f6" ], "owner": true, "type": "manual" } }, "status": "success" }