Skip to content

Tools ​

recipes ​

ToolDescription
get_current_userShows which Mealie account this connection acts as, with its group and household.
search_recipesSearches recipes by free text (search) and by categories, tags, tools and foods. Each filter takes IDs or slugs. Several values in one filter mean any of them, unless require_all is true. Returns summaries; use get_recipe for full details.
get_recipeGets one recipe in full, including ingredients, instructions and nutrition.
create_recipeCreates a recipe from structured data. Ingredients with a food or unit need its id and name from list_foods / list_units; create missing ones first with create_food / create_unit. Quantities are decimals, and an ingredient that is not split into food and unit goes in note. To import from a web page, use import_recipe_from_url. Returns a short summary (id, slug, name, servings, tags, ingredient count, rating, image present); get_recipe has the full recipe.
import_recipe_from_urlHas Mealie scrape a recipe web page and create a recipe from it. Returns the new slug; use get_recipe to review what was imported. Some sites block the scraper (ah.be answers 403): the call then fails with an error, and the recipe has to be added with create_recipe instead. Mealie returns no import warnings, so check the result.
update_recipeChanges the given fields of a recipe and leaves the rest alone. List fields (ingredients, instructions, notes, categories, tags, tools) are replaced as a whole, so send the complete list. Ingredient rules are the same as in create_recipe: food and unit need id and name from list_foods / list_units, quantities are decimals, unparsed text goes in note. Returns a short summary; get_recipe has the full recipe.
duplicate_recipeCopies a recipe, optionally under a new name.
mark_recipe_madeRecords that a recipe was made, today by default.
rate_recipeSets the rating (0 to 5) or favorite flag of the account this connection acts as, and replaces that account's earlier rating. Ratings are per user: there is no way to read or set another user's rating.
delete_recipePermanently deletes a recipe.

recipe-assets ​

ToolDescription
set_recipe_image_from_urlHas Mealie download an image and use it as the recipe image.
upload_recipe_imageReplaces the recipe image with an uploaded file, up to about 12 MB.
delete_recipe_imageRemoves the image from a recipe.
upload_recipe_assetAttaches a file, such as a PDF of the original recipe, up to about 12 MB.

ingredients ​

ToolDescription
parse_ingredientsUses Mealie's parser to split free-text ingredient lines into quantity, unit and food. It only reads: nothing is created, so a food or unit Mealie does not know may come back without an id. Create it with create_food / create_unit before using it in create_recipe.
list_foodsLists or searches foods in Mealie's shared vocabulary. Each item has its id and aliases. search is free text handled by Mealie; it is certain to look at the name, and whether it also matches plural names and aliases is up to Mealie, so try the plural or the alias too before concluding something is missing.
create_foodAdds a food to Mealie's shared vocabulary. Recipes reference it by id, so create it here before using it in an ingredient.
update_foodChanges the given fields of a food and leaves the others alone.
merge_foodsMerges one food into another. from_id disappears and every ingredient that used it moves to to_id, so recipes keep their links. Use this for near-duplicates instead of delete_food, which unlinks the ingredients. Cannot be undone.
delete_foodPermanently deletes a food. Ingredients using it lose the link; to keep them, use merge_foods instead.
list_unitsLists or searches units in Mealie's shared vocabulary. Each item has its id, abbreviations, fraction and use_abbreviation settings and aliases. search is free text handled by Mealie; it is certain to look at the name, and whether it also matches plural names and aliases is up to Mealie, so try the plural or the alias too before concluding something is missing.
create_unitAdds a unit to Mealie's shared vocabulary. Recipes reference it by id, so create it here before using it in an ingredient.
update_unitChanges the given fields of a unit and leaves the others alone.
merge_unitsMerges one unit into another. from_id disappears and every ingredient that used it moves to to_id, so recipes keep their links. Use this for near-duplicates instead of delete_unit, which unlinks the ingredients. Cannot be undone.
delete_unitPermanently deletes a unit. Ingredients using it lose the link; to keep them, use merge_units instead.

organizers ​

ToolDescription
list_categoriesLists or searches categories.
list_unused_categoriesLists categories that no recipe uses.
create_categoryCreates a category.
rename_categoryRenames a category.
delete_categoryPermanently deletes a category and removes it from every recipe.
list_tagsLists or searches tags.
list_unused_tagsLists tags that no recipe uses.
create_tagCreates a tag.
rename_tagRenames a tag.
delete_tagPermanently deletes a tag and removes it from every recipe.
list_recipe_toolsLists or searches recipe tools.
list_unused_recipe_toolsLists recipe tools that no recipe uses.
create_recipe_toolCreates a recipe tool.
rename_recipe_toolRenames a recipe tool.
delete_recipe_toolPermanently deletes a recipe tool and removes it from every recipe.

cookbooks ​

ToolDescription
list_cookbooksLists the household’s cookbooks. A cookbook is a saved recipe filter, so each one shows its query_filter_string.
get_cookbookGets one cookbook, including its recipe filter.
create_cookbookCreates a cookbook: a named, saved recipe filter. For a "Freezer menu" of everything tagged freezer, create or find the tag, then pass its ID in tags. Recipes are matched by the filter and never added by hand.
update_cookbookChanges the given fields of a cookbook and leaves the others alone. Giving any filter field replaces the whole existing filter.
delete_cookbookPermanently deletes a cookbook. The recipes it showed are not touched.

shopping ​

ToolDescription
list_shopping_listsLists the household's shopping lists. Use get_shopping_list for the items.
get_shopping_listGets a shopping list with all its items.
create_shopping_listCreates an empty shopping list.
rename_shopping_listRenames a shopping list.
delete_shopping_listPermanently deletes a shopping list and its items.
add_shopping_itemsAdds one or more items to a shopping list.
update_shopping_itemChanges the given fields of a shopping item, including ticking it off.
delete_shopping_itemRemoves an item from its shopping list.
add_recipe_to_shopping_listAdds a recipe's ingredients to a shopping list, scaled by a multiplier.

mealplans ​

ToolDescription
get_mealplansLists meal plan entries for the household, optionally within a date range.
get_todays_mealsGets today's meal plan entries.
create_mealplan_entryAdds a meal to the plan: either a recipe, or a title and note for something without one.
create_random_mealplan_entryLets Mealie pick a recipe for a date, following the household's meal plan rules.
update_mealplan_entryChanges the given fields of a meal plan entry.
delete_mealplan_entryRemoves an entry from the meal plan.

Released under the MIT License.