Claude en MCP
MCP-tools
Elke handeling in de app is ook een tool voor Claude, met dezelfde controles, rechten en versiegeschiedenis. Deze pagina wordt gemaakt uit dezelfde definities als de tools zelf. De beschrijvingen per tool zijn Engels: zo leest Claude ze.
Schrijvende tools geven before, after en version_id terug en nemen een optionele reason aan, die in de geschiedenis als “Waarom” verschijnt. Fouten hebben een code: not_found, validation, cycle, forbidden of conflict. Elke tool vraagt een recht (kolom “Recht”); dat geef je bij het koppelen van Claude.
43 toolsElke wijziging maakt een versie
| Tool | Recht | Wat het doet |
|---|---|---|
recipe_list |
lezen | List and search recipes with dough totals, hydration and composition. |
recipe_get |
lezen | Get one recipe with lines, baker’s percentages, hydration, method, products, allergens and where it is used. |
recipe_create |
recepten wijzigen | Create a recipe, optionally with its lines and method steps. |
recipe_update |
recepten wijzigen | Change recipe details: name, category, tags, status, notes, loss. |
recipe_set_lines |
recepten wijzigen | Replace all lines of a recipe (ingredients or component recipes, in grams). |
recipe_set_steps |
recepten wijzigen | Replace the method steps of a recipe. |
recipe_archive |
recepten wijzigen | Archive a recipe (or bring it back). |
recipe_duplicate |
recepten wijzigen | Copy a recipe with its lines and method under a new name, as a draft. |
recipe_where_used |
lezen | Recipes that use this recipe as a component: directly, and through other components. |
recipe_scale |
lezen | Scale a recipe to a dough weight, flour weight or number of pieces of a product. |
recipe_check |
lezen | Run the recipe checks: cycles, missing quantities, duplicate lines, salt and yeast ranges, dry seeds, pieces per batch, allergens, label names and recipes that use this one. |
recipe_apply_edit |
recepten wijzigen | Change a recipe in one go: lines, method and product sizes, written as one version. |
ingredient_list |
lezen | List ingredients with how many recipes use each. |
ingredient_get |
lezen | Get one ingredient with the recipes that use it directly. |
ingredient_create |
grondstoffen wijzigen | Create an ingredient. |
ingredient_update |
grondstoffen wijzigen | Change an ingredient: names, label name, composition, flour flag, allergens, packs, supplier data, “recept ontbreekt”. |
ingredient_merge |
grondstoffen wijzigen | Propose merging duplicate ingredients into one. |
product_list |
lezen | List products (sellable pieces of a recipe) with pieces per batch. |
product_create |
recepten wijzigen | Add a product to a recipe: a sellable piece with its dough weight, e.g. Desembrood 1.250 g and 950 g are two products of one recipe. |
product_update |
recepten wijzigen | Change a product: name, piece weight, extras, shop price, traces note. |
product_archive |
recepten wijzigen | Archive a product (or bring it back). |
product_set_location |
recepten wijzigen | Set whether a product is sold at a location, and its price there. |
location_list |
lezen | List the locations (shops, production sites) of the bakery. |
location_create |
beheer | Add a location: a shop, a production site or a shop with bakery. |
location_update |
beheer | Change a location: name, kind, opening days, day start, primary; or archive it. |
import_stage |
importeren | Stage parsed workbook tabs as one import batch: proposes ingredients, duplicate merges, component links and categories. |
import_list |
importeren | List import batches, newest first, with their summary and item counts (open questions per kind). |
import_get |
importeren | Get an import batch with its summary and the items to review, optionally filtered by kind or status. |
import_resolve |
importeren | Decide one item of a staged import. |
import_approve |
importeren | Propose writing a fully decided import batch: ingredients, recipes, lines, method and products. |
import_discard |
importeren | Throw away a staged import. |
pending_list |
lezen | List staged changes waiting for confirmation, such as ingredient merges. |
pending_confirm |
lezen | Carry out a staged change. |
pending_cancel |
lezen | Cancel a staged change. |
version_list |
lezen | List the change history, newest first: who changed what (line by line for recipes), through the app, Claude or an import, and why. |
version_get |
lezen | Get one version with the full before and after, and for recipes the effect on dough, hydration and pieces. |
version_restore |
lezen | Put an entity back as it was at a version. |
docs_search |
lezen | Search the documentation for how the app and the tools work. |
docs_get |
lezen | Get one documentation page as Markdown, with the list of all pages. |
device_list |
lezen | List the paired devices (bakery iPads), with their location and when they were last used. |
device_create_pairing_code |
beheer | Create a one-time code to pair an iPad with a location. |
device_revoke |
beheer | Unpair a device. |
company_settings_update |
beheer | Change company settings, such as whether suggestions of Adorea are on in the recipe editor. |
Recepten
Section titled “Recepten”recipe_list
Section titled “recipe_list”List and search recipes with dough totals, hydration and composition. Filter by text, category, tag, status, ingredient or missing data.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
query |
string | Matches name, slug and tags | |
category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
||
tag |
string | e.g. “seizoen” | |
status |
"draft" | "complete" |
||
ingredient |
string | Only recipes containing this ingredient, also through components | |
missing |
"quantity" | "piece_weight" |
Only recipes with lines without grams, or without a product piece weight | |
include_archived |
boolean | Standaard false. |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
items |
object[] | ja | |
items[].id |
string | ja | |
items[].slug |
string | ja | |
items[].name |
string | ja | |
items[].category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
ja | |
items[].tags |
string[] | ja | |
items[].reference_note |
string | null | ja | |
items[].status |
"draft" | "complete" |
ja | |
items[].can_be_component |
boolean | ja | |
items[].loss_pct |
number | ja | |
items[].bake_profile |
record | null | ja | |
items[].source_note |
string | null | ja | |
items[].archived_at |
string | null | ja | |
items[].dough_total_g |
number | ja | |
items[].flour_total_g |
number | ja | |
items[].hydration_pct |
number | null | ja | |
items[].line_count |
integer | ja | |
items[].missing_quantity_count |
integer | ja | |
items[].composition |
record | ja | Grams per composition group, for the dough bar |
items[].product_count |
integer | ja | |
items[].has_piece_weight |
boolean | ja | |
items[].piece_weights_g |
number[] | ja | Piece weights of its active products, largest first |
items[].components |
object[] | ja | Recipes it uses as a component, in line order |
items[].components[].id |
string | ja | |
items[].components[].slug |
string | ja | |
items[].components[].name |
string | ja |
Voorbeeld
Section titled “Voorbeeld”Every recipe with hazelnuts, also through a filling or dough it uses.
{ "ingredient": "hazelnoot"}recipe_get
Section titled “recipe_get”Get one recipe with lines, baker’s percentages, hydration, method, products, allergens and where it is used.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
recipe |
string | ja | Recipe id or slug, e.g. “desembrood” |
bakers_percentage_base |
"component" | "flour" |
What counts as 100% for baker’s percentages. “component”: the recipe’s flour, or its component lines when it has no flour. “flour”: all flour, including flour inside components (percentages tegen meel) Standaard "component". |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
recipe |
object | ja | |
recipe.id |
string | ja | |
recipe.slug |
string | ja | |
recipe.name |
string | ja | |
recipe.category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
ja | |
recipe.tags |
string[] | ja | |
recipe.reference_note |
string | null | ja | |
recipe.status |
"draft" | "complete" |
ja | |
recipe.can_be_component |
boolean | ja | |
recipe.loss_pct |
number | ja | |
recipe.bake_profile |
record | null | ja | |
recipe.source_note |
string | null | ja | |
recipe.archived_at |
string | null | ja | |
lines |
object[] | ja | |
lines[].id |
string | ja | |
lines[].position |
integer | ja | |
lines[].ingredient_id |
string | null | ja | |
lines[].component_recipe_id |
string | null | ja | |
lines[].grams |
number | null | ja | |
lines[].counts_as_flour |
boolean | ja | |
lines[].group_label |
string | null | ja | |
lines[].note |
string | null | ja | |
lines[].optional |
boolean | ja | |
lines[].display_name |
string | null | ja | |
lines[].name |
string | ja | Display name: the line display name, else the ingredient or component name |
lines[].composition |
string | null | ja | |
lines[].bakers_pct |
number | null | ja | Baker’s percentage; null without grams or when nothing counts as 100% |
lines[].component_slug |
string | null | ja | |
steps |
object[] | ja | |
steps[].id |
string | ja | |
steps[].position |
integer | ja | |
steps[].text |
string | ja | |
steps[].duration_min |
number | null | ja | |
steps[].temperature_c |
number | null | ja | |
products |
object[] | ja | |
products[].id |
string | ja | |
products[].name |
string | ja | |
products[].piece_weight_g |
number | null | ja | |
products[].pieces_per_batch |
integer | null | ja | |
products[].shop_price_cents |
integer | null | ja | |
analysis |
object | ja | |
analysis.flour_total_g |
number | ja | |
analysis.dough_total_g |
number | ja | |
analysis.bakers_percentage_base_g |
number | ja | Grams that count as 100% for the baker’s percentages |
analysis.hydration_pct |
number | null | ja | |
analysis.missing_quantity_count |
integer | ja | |
composition |
record | ja | |
allergens |
"gluten" | "crustaceans" | "eggs" | "fish" | "peanuts" | "soy" | "milk" | "nuts" | "celery" | "mustard" | "sesame" | "sulphites" | "lupin" | "molluscs"[] |
ja | |
used_in |
object[] | ja | Recipes that use this one as a component, directly |
used_in[].id |
string | ja | |
used_in[].slug |
string | ja | |
used_in[].name |
string | ja | |
version_id |
string | null | ja | Newest version of this recipe or its products; pass it as base_version_id to recipe_apply_edit |
Voorbeeld
Section titled “Voorbeeld”{ "recipe": "desembrood"}recipe_create
Section titled “recipe_create”Create a recipe, optionally with its lines and method steps. The slug is made from the name and never changes.
Toegang: recepten wijzigen write:recipes
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
name |
string | ja | |
category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
ja | |
tags |
string[] | ||
reference_note |
string | null | ||
status |
"draft" | "complete" |
||
can_be_component |
boolean | Can be used as a component in other recipes | |
loss_pct |
number | Dough and bake loss in percent, applied when scaling | |
bake_profile |
record | null | ||
source_note |
string | null | ||
lines |
object[] | Standaard []. |
|
lines[].ingredient |
string | Ingredient id, name or alias (case-insensitive), e.g. “T65” | |
lines[].recipe |
string | Component recipe (a sub-recipe such as a dough or cream) | |
lines[].grams |
number | null | Null when the quantity is unknown Standaard null. |
|
lines[].counts_as_flour |
boolean | Defaults to the ingredient’s flour flag; false for components | |
lines[].group_label |
string | null | Dough structure, e.g. “biga”, “deel 1” | |
lines[].note |
string | null | Process detail, e.g. “18 °C” | |
lines[].optional |
boolean | Standaard false. |
|
lines[].display_name |
string | null | Name shown to bakers when it differs from the ingredient | |
steps |
object[] | Standaard []. |
|
steps[].text |
string | ja | |
steps[].duration_min |
number | null | ||
steps[].temperature_c |
number | null | ||
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
object | ja | |
before |
object | Variant | |
before.id |
string | ja | |
before.slug |
string | ja | |
before.name |
string | ja | |
before.category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
ja | |
before.tags |
string[] | ja | |
before.reference_note |
string | null | ja | |
before.status |
"draft" | "complete" |
ja | |
before.can_be_component |
boolean | ja | |
before.loss_pct |
number | ja | |
before.bake_profile |
record | null | ja | |
before.source_note |
string | null | ja | |
before.archived_at |
string | null | ja | |
before.lines |
object[] | ja | |
before.lines[].id |
string | ja | |
before.lines[].position |
integer | ja | |
before.lines[].ingredient_id |
string | null | ja | |
before.lines[].component_recipe_id |
string | null | ja | |
before.lines[].grams |
number | null | ja | |
before.lines[].counts_as_flour |
boolean | ja | |
before.lines[].group_label |
string | null | ja | |
before.lines[].note |
string | null | ja | |
before.lines[].optional |
boolean | ja | |
before.lines[].display_name |
string | null | ja | |
before.steps |
object[] | ja | |
before.steps[].id |
string | ja | |
before.steps[].position |
integer | ja | |
before.steps[].text |
string | ja | |
before.steps[].duration_min |
number | null | ja | |
before.steps[].temperature_c |
number | null | ja | |
after |
object | ja | |
after.id |
string | ja | |
after.slug |
string | ja | |
after.name |
string | ja | |
after.category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
ja | |
after.tags |
string[] | ja | |
after.reference_note |
string | null | ja | |
after.status |
"draft" | "complete" |
ja | |
after.can_be_component |
boolean | ja | |
after.loss_pct |
number | ja | |
after.bake_profile |
record | null | ja | |
after.source_note |
string | null | ja | |
after.archived_at |
string | null | ja | |
after.lines |
object[] | ja | |
after.lines[].id |
string | ja | |
after.lines[].position |
integer | ja | |
after.lines[].ingredient_id |
string | null | ja | |
after.lines[].component_recipe_id |
string | null | ja | |
after.lines[].grams |
number | null | ja | |
after.lines[].counts_as_flour |
boolean | ja | |
after.lines[].group_label |
string | null | ja | |
after.lines[].note |
string | null | ja | |
after.lines[].optional |
boolean | ja | |
after.lines[].display_name |
string | null | ja | |
after.steps |
object[] | ja | |
after.steps[].id |
string | ja | |
after.steps[].position |
integer | ja | |
after.steps[].text |
string | ja | |
after.steps[].duration_min |
number | null | ja | |
after.steps[].temperature_c |
number | null | ja | |
version_id |
string | ja | |
checks |
object[] | ja | Checks on the recipe as written: warnings and notes, see recipe_check |
checks[].id |
"cycle" | "unmatched_ingredient" | "missing_quantity" | "duplicate_line" | "magnitude_jump" | "salt_range" | "yeast_range" | "no_flour" | "dry_addition" | "hydration_shift" | "piece_remainder" | "pieces_change" | "where_used" | "allergen_change" | "label_name_missing" | "step_mentions_missing" | "source_conflict" |
ja | |
checks[].severity |
"error" | "warn" | "info" | "ok" |
ja | |
checks[].message |
object | ja | |
checks[].message.nl |
string | ja | |
checks[].message.en |
string | ja | |
checks[].line |
string | null | ja | |
checks[].step |
integer | null | ja | |
checks[].suggestable |
boolean | ja | Adorea may propose a fix |
checks[].action |
object | null | ja |
recipe_update
Section titled “recipe_update”Change recipe details: name, category, tags, status, notes, loss. Lines and steps have their own ops. The slug stays.
Toegang: recepten wijzigen write:recipes
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
name |
string | ||
category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
||
tags |
string[] | ||
reference_note |
string | null | ||
status |
"draft" | "complete" |
||
can_be_component |
boolean | Can be used as a component in other recipes | |
loss_pct |
number | Dough and bake loss in percent, applied when scaling | |
bake_profile |
record | null | ||
source_note |
string | null | ||
recipe |
string | ja | Recipe id or slug, e.g. “desembrood” |
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
object | ja | |
before |
object | Variant | |
before.id |
string | ja | |
before.slug |
string | ja | |
before.name |
string | ja | |
before.category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
ja | |
before.tags |
string[] | ja | |
before.reference_note |
string | null | ja | |
before.status |
"draft" | "complete" |
ja | |
before.can_be_component |
boolean | ja | |
before.loss_pct |
number | ja | |
before.bake_profile |
record | null | ja | |
before.source_note |
string | null | ja | |
before.archived_at |
string | null | ja | |
before.lines |
object[] | ja | |
before.lines[].id |
string | ja | |
before.lines[].position |
integer | ja | |
before.lines[].ingredient_id |
string | null | ja | |
before.lines[].component_recipe_id |
string | null | ja | |
before.lines[].grams |
number | null | ja | |
before.lines[].counts_as_flour |
boolean | ja | |
before.lines[].group_label |
string | null | ja | |
before.lines[].note |
string | null | ja | |
before.lines[].optional |
boolean | ja | |
before.lines[].display_name |
string | null | ja | |
before.steps |
object[] | ja | |
before.steps[].id |
string | ja | |
before.steps[].position |
integer | ja | |
before.steps[].text |
string | ja | |
before.steps[].duration_min |
number | null | ja | |
before.steps[].temperature_c |
number | null | ja | |
after |
object | ja | |
after.id |
string | ja | |
after.slug |
string | ja | |
after.name |
string | ja | |
after.category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
ja | |
after.tags |
string[] | ja | |
after.reference_note |
string | null | ja | |
after.status |
"draft" | "complete" |
ja | |
after.can_be_component |
boolean | ja | |
after.loss_pct |
number | ja | |
after.bake_profile |
record | null | ja | |
after.source_note |
string | null | ja | |
after.archived_at |
string | null | ja | |
after.lines |
object[] | ja | |
after.lines[].id |
string | ja | |
after.lines[].position |
integer | ja | |
after.lines[].ingredient_id |
string | null | ja | |
after.lines[].component_recipe_id |
string | null | ja | |
after.lines[].grams |
number | null | ja | |
after.lines[].counts_as_flour |
boolean | ja | |
after.lines[].group_label |
string | null | ja | |
after.lines[].note |
string | null | ja | |
after.lines[].optional |
boolean | ja | |
after.lines[].display_name |
string | null | ja | |
after.steps |
object[] | ja | |
after.steps[].id |
string | ja | |
after.steps[].position |
integer | ja | |
after.steps[].text |
string | ja | |
after.steps[].duration_min |
number | null | ja | |
after.steps[].temperature_c |
number | null | ja | |
version_id |
string | ja | |
checks |
object[] | ja | Checks on the recipe as written: warnings and notes, see recipe_check |
checks[].id |
"cycle" | "unmatched_ingredient" | "missing_quantity" | "duplicate_line" | "magnitude_jump" | "salt_range" | "yeast_range" | "no_flour" | "dry_addition" | "hydration_shift" | "piece_remainder" | "pieces_change" | "where_used" | "allergen_change" | "label_name_missing" | "step_mentions_missing" | "source_conflict" |
ja | |
checks[].severity |
"error" | "warn" | "info" | "ok" |
ja | |
checks[].message |
object | ja | |
checks[].message.nl |
string | ja | |
checks[].message.en |
string | ja | |
checks[].line |
string | null | ja | |
checks[].step |
integer | null | ja | |
checks[].suggestable |
boolean | ja | Adorea may propose a fix |
checks[].action |
object | null | ja |
recipe_set_lines
Section titled “recipe_set_lines”Replace all lines of a recipe (ingredients or component recipes, in grams). Send the full list. A recipe cannot contain itself through components.
Toegang: recepten wijzigen write:recipes
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
recipe |
string | ja | Recipe id or slug, e.g. “desembrood” |
lines |
object[] | ja | The complete new list of lines, in order |
lines[].ingredient |
string | Ingredient id, name or alias (case-insensitive), e.g. “T65” | |
lines[].recipe |
string | Component recipe (a sub-recipe such as a dough or cream) | |
lines[].grams |
number | null | Null when the quantity is unknown Standaard null. |
|
lines[].counts_as_flour |
boolean | Defaults to the ingredient’s flour flag; false for components | |
lines[].group_label |
string | null | Dough structure, e.g. “biga”, “deel 1” | |
lines[].note |
string | null | Process detail, e.g. “18 °C” | |
lines[].optional |
boolean | Standaard false. |
|
lines[].display_name |
string | null | Name shown to bakers when it differs from the ingredient | |
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
object | ja | |
before |
object | Variant | |
before.id |
string | ja | |
before.slug |
string | ja | |
before.name |
string | ja | |
before.category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
ja | |
before.tags |
string[] | ja | |
before.reference_note |
string | null | ja | |
before.status |
"draft" | "complete" |
ja | |
before.can_be_component |
boolean | ja | |
before.loss_pct |
number | ja | |
before.bake_profile |
record | null | ja | |
before.source_note |
string | null | ja | |
before.archived_at |
string | null | ja | |
before.lines |
object[] | ja | |
before.lines[].id |
string | ja | |
before.lines[].position |
integer | ja | |
before.lines[].ingredient_id |
string | null | ja | |
before.lines[].component_recipe_id |
string | null | ja | |
before.lines[].grams |
number | null | ja | |
before.lines[].counts_as_flour |
boolean | ja | |
before.lines[].group_label |
string | null | ja | |
before.lines[].note |
string | null | ja | |
before.lines[].optional |
boolean | ja | |
before.lines[].display_name |
string | null | ja | |
before.steps |
object[] | ja | |
before.steps[].id |
string | ja | |
before.steps[].position |
integer | ja | |
before.steps[].text |
string | ja | |
before.steps[].duration_min |
number | null | ja | |
before.steps[].temperature_c |
number | null | ja | |
after |
object | ja | |
after.id |
string | ja | |
after.slug |
string | ja | |
after.name |
string | ja | |
after.category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
ja | |
after.tags |
string[] | ja | |
after.reference_note |
string | null | ja | |
after.status |
"draft" | "complete" |
ja | |
after.can_be_component |
boolean | ja | |
after.loss_pct |
number | ja | |
after.bake_profile |
record | null | ja | |
after.source_note |
string | null | ja | |
after.archived_at |
string | null | ja | |
after.lines |
object[] | ja | |
after.lines[].id |
string | ja | |
after.lines[].position |
integer | ja | |
after.lines[].ingredient_id |
string | null | ja | |
after.lines[].component_recipe_id |
string | null | ja | |
after.lines[].grams |
number | null | ja | |
after.lines[].counts_as_flour |
boolean | ja | |
after.lines[].group_label |
string | null | ja | |
after.lines[].note |
string | null | ja | |
after.lines[].optional |
boolean | ja | |
after.lines[].display_name |
string | null | ja | |
after.steps |
object[] | ja | |
after.steps[].id |
string | ja | |
after.steps[].position |
integer | ja | |
after.steps[].text |
string | ja | |
after.steps[].duration_min |
number | null | ja | |
after.steps[].temperature_c |
number | null | ja | |
version_id |
string | ja | |
checks |
object[] | ja | Checks on the recipe as written: warnings and notes, see recipe_check |
checks[].id |
"cycle" | "unmatched_ingredient" | "missing_quantity" | "duplicate_line" | "magnitude_jump" | "salt_range" | "yeast_range" | "no_flour" | "dry_addition" | "hydration_shift" | "piece_remainder" | "pieces_change" | "where_used" | "allergen_change" | "label_name_missing" | "step_mentions_missing" | "source_conflict" |
ja | |
checks[].severity |
"error" | "warn" | "info" | "ok" |
ja | |
checks[].message |
object | ja | |
checks[].message.nl |
string | ja | |
checks[].message.en |
string | ja | |
checks[].line |
string | null | ja | |
checks[].step |
integer | null | ja | |
checks[].suggestable |
boolean | ja | Adorea may propose a fix |
checks[].action |
object | null | ja |
Voorbeeld
Section titled “Voorbeeld”{ "recipe": "desembrood", "lines": [ { "ingredient": "Tarwebloem T65", "grams": 900 }, { "ingredient": "Volkorenmeel", "grams": 100 }, { "ingredient": "Water", "grams": 720 }, { "recipe": "desem", "grams": 200 }, { "ingredient": "Zout", "grams": 20 } ], "reason": "Iets meer water na proefbak"}recipe_set_steps
Section titled “recipe_set_steps”Replace the method steps of a recipe. Send the full list.
Toegang: recepten wijzigen write:recipes
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
recipe |
string | ja | Recipe id or slug, e.g. “desembrood” |
steps |
object[] | ja | The complete new method, in order |
steps[].text |
string | ja | |
steps[].duration_min |
number | null | ||
steps[].temperature_c |
number | null | ||
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
object | ja | |
before |
object | Variant | |
before.id |
string | ja | |
before.slug |
string | ja | |
before.name |
string | ja | |
before.category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
ja | |
before.tags |
string[] | ja | |
before.reference_note |
string | null | ja | |
before.status |
"draft" | "complete" |
ja | |
before.can_be_component |
boolean | ja | |
before.loss_pct |
number | ja | |
before.bake_profile |
record | null | ja | |
before.source_note |
string | null | ja | |
before.archived_at |
string | null | ja | |
before.lines |
object[] | ja | |
before.lines[].id |
string | ja | |
before.lines[].position |
integer | ja | |
before.lines[].ingredient_id |
string | null | ja | |
before.lines[].component_recipe_id |
string | null | ja | |
before.lines[].grams |
number | null | ja | |
before.lines[].counts_as_flour |
boolean | ja | |
before.lines[].group_label |
string | null | ja | |
before.lines[].note |
string | null | ja | |
before.lines[].optional |
boolean | ja | |
before.lines[].display_name |
string | null | ja | |
before.steps |
object[] | ja | |
before.steps[].id |
string | ja | |
before.steps[].position |
integer | ja | |
before.steps[].text |
string | ja | |
before.steps[].duration_min |
number | null | ja | |
before.steps[].temperature_c |
number | null | ja | |
after |
object | ja | |
after.id |
string | ja | |
after.slug |
string | ja | |
after.name |
string | ja | |
after.category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
ja | |
after.tags |
string[] | ja | |
after.reference_note |
string | null | ja | |
after.status |
"draft" | "complete" |
ja | |
after.can_be_component |
boolean | ja | |
after.loss_pct |
number | ja | |
after.bake_profile |
record | null | ja | |
after.source_note |
string | null | ja | |
after.archived_at |
string | null | ja | |
after.lines |
object[] | ja | |
after.lines[].id |
string | ja | |
after.lines[].position |
integer | ja | |
after.lines[].ingredient_id |
string | null | ja | |
after.lines[].component_recipe_id |
string | null | ja | |
after.lines[].grams |
number | null | ja | |
after.lines[].counts_as_flour |
boolean | ja | |
after.lines[].group_label |
string | null | ja | |
after.lines[].note |
string | null | ja | |
after.lines[].optional |
boolean | ja | |
after.lines[].display_name |
string | null | ja | |
after.steps |
object[] | ja | |
after.steps[].id |
string | ja | |
after.steps[].position |
integer | ja | |
after.steps[].text |
string | ja | |
after.steps[].duration_min |
number | null | ja | |
after.steps[].temperature_c |
number | null | ja | |
version_id |
string | ja | |
checks |
object[] | ja | Checks on the recipe as written: warnings and notes, see recipe_check |
checks[].id |
"cycle" | "unmatched_ingredient" | "missing_quantity" | "duplicate_line" | "magnitude_jump" | "salt_range" | "yeast_range" | "no_flour" | "dry_addition" | "hydration_shift" | "piece_remainder" | "pieces_change" | "where_used" | "allergen_change" | "label_name_missing" | "step_mentions_missing" | "source_conflict" |
ja | |
checks[].severity |
"error" | "warn" | "info" | "ok" |
ja | |
checks[].message |
object | ja | |
checks[].message.nl |
string | ja | |
checks[].message.en |
string | ja | |
checks[].line |
string | null | ja | |
checks[].step |
integer | null | ja | |
checks[].suggestable |
boolean | ja | Adorea may propose a fix |
checks[].action |
object | null | ja |
recipe_archive
Section titled “recipe_archive”Archive a recipe (or bring it back). A recipe still used as a component by an active recipe cannot be archived.
Toegang: recepten wijzigen write:recipes
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
recipe |
string | ja | Recipe id or slug, e.g. “desembrood” |
archived |
boolean | false brings it back Standaard true. |
|
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
object | ja | |
before |
object | Variant | |
before.id |
string | ja | |
before.slug |
string | ja | |
before.name |
string | ja | |
before.category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
ja | |
before.tags |
string[] | ja | |
before.reference_note |
string | null | ja | |
before.status |
"draft" | "complete" |
ja | |
before.can_be_component |
boolean | ja | |
before.loss_pct |
number | ja | |
before.bake_profile |
record | null | ja | |
before.source_note |
string | null | ja | |
before.archived_at |
string | null | ja | |
before.lines |
object[] | ja | |
before.lines[].id |
string | ja | |
before.lines[].position |
integer | ja | |
before.lines[].ingredient_id |
string | null | ja | |
before.lines[].component_recipe_id |
string | null | ja | |
before.lines[].grams |
number | null | ja | |
before.lines[].counts_as_flour |
boolean | ja | |
before.lines[].group_label |
string | null | ja | |
before.lines[].note |
string | null | ja | |
before.lines[].optional |
boolean | ja | |
before.lines[].display_name |
string | null | ja | |
before.steps |
object[] | ja | |
before.steps[].id |
string | ja | |
before.steps[].position |
integer | ja | |
before.steps[].text |
string | ja | |
before.steps[].duration_min |
number | null | ja | |
before.steps[].temperature_c |
number | null | ja | |
after |
object | ja | |
after.id |
string | ja | |
after.slug |
string | ja | |
after.name |
string | ja | |
after.category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
ja | |
after.tags |
string[] | ja | |
after.reference_note |
string | null | ja | |
after.status |
"draft" | "complete" |
ja | |
after.can_be_component |
boolean | ja | |
after.loss_pct |
number | ja | |
after.bake_profile |
record | null | ja | |
after.source_note |
string | null | ja | |
after.archived_at |
string | null | ja | |
after.lines |
object[] | ja | |
after.lines[].id |
string | ja | |
after.lines[].position |
integer | ja | |
after.lines[].ingredient_id |
string | null | ja | |
after.lines[].component_recipe_id |
string | null | ja | |
after.lines[].grams |
number | null | ja | |
after.lines[].counts_as_flour |
boolean | ja | |
after.lines[].group_label |
string | null | ja | |
after.lines[].note |
string | null | ja | |
after.lines[].optional |
boolean | ja | |
after.lines[].display_name |
string | null | ja | |
after.steps |
object[] | ja | |
after.steps[].id |
string | ja | |
after.steps[].position |
integer | ja | |
after.steps[].text |
string | ja | |
after.steps[].duration_min |
number | null | ja | |
after.steps[].temperature_c |
number | null | ja | |
version_id |
string | ja | |
checks |
object[] | ja | Checks on the recipe as written: warnings and notes, see recipe_check |
checks[].id |
"cycle" | "unmatched_ingredient" | "missing_quantity" | "duplicate_line" | "magnitude_jump" | "salt_range" | "yeast_range" | "no_flour" | "dry_addition" | "hydration_shift" | "piece_remainder" | "pieces_change" | "where_used" | "allergen_change" | "label_name_missing" | "step_mentions_missing" | "source_conflict" |
ja | |
checks[].severity |
"error" | "warn" | "info" | "ok" |
ja | |
checks[].message |
object | ja | |
checks[].message.nl |
string | ja | |
checks[].message.en |
string | ja | |
checks[].line |
string | null | ja | |
checks[].step |
integer | null | ja | |
checks[].suggestable |
boolean | ja | Adorea may propose a fix |
checks[].action |
object | null | ja |
recipe_duplicate
Section titled “recipe_duplicate”Copy a recipe with its lines and method under a new name, as a draft. Products are not copied.
Toegang: recepten wijzigen write:recipes
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
recipe |
string | ja | Recipe id or slug, e.g. “desembrood” |
name |
string | ja | Name of the copy |
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
object | ja | |
before |
object | Variant | |
before.id |
string | ja | |
before.slug |
string | ja | |
before.name |
string | ja | |
before.category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
ja | |
before.tags |
string[] | ja | |
before.reference_note |
string | null | ja | |
before.status |
"draft" | "complete" |
ja | |
before.can_be_component |
boolean | ja | |
before.loss_pct |
number | ja | |
before.bake_profile |
record | null | ja | |
before.source_note |
string | null | ja | |
before.archived_at |
string | null | ja | |
before.lines |
object[] | ja | |
before.lines[].id |
string | ja | |
before.lines[].position |
integer | ja | |
before.lines[].ingredient_id |
string | null | ja | |
before.lines[].component_recipe_id |
string | null | ja | |
before.lines[].grams |
number | null | ja | |
before.lines[].counts_as_flour |
boolean | ja | |
before.lines[].group_label |
string | null | ja | |
before.lines[].note |
string | null | ja | |
before.lines[].optional |
boolean | ja | |
before.lines[].display_name |
string | null | ja | |
before.steps |
object[] | ja | |
before.steps[].id |
string | ja | |
before.steps[].position |
integer | ja | |
before.steps[].text |
string | ja | |
before.steps[].duration_min |
number | null | ja | |
before.steps[].temperature_c |
number | null | ja | |
after |
object | ja | |
after.id |
string | ja | |
after.slug |
string | ja | |
after.name |
string | ja | |
after.category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
ja | |
after.tags |
string[] | ja | |
after.reference_note |
string | null | ja | |
after.status |
"draft" | "complete" |
ja | |
after.can_be_component |
boolean | ja | |
after.loss_pct |
number | ja | |
after.bake_profile |
record | null | ja | |
after.source_note |
string | null | ja | |
after.archived_at |
string | null | ja | |
after.lines |
object[] | ja | |
after.lines[].id |
string | ja | |
after.lines[].position |
integer | ja | |
after.lines[].ingredient_id |
string | null | ja | |
after.lines[].component_recipe_id |
string | null | ja | |
after.lines[].grams |
number | null | ja | |
after.lines[].counts_as_flour |
boolean | ja | |
after.lines[].group_label |
string | null | ja | |
after.lines[].note |
string | null | ja | |
after.lines[].optional |
boolean | ja | |
after.lines[].display_name |
string | null | ja | |
after.steps |
object[] | ja | |
after.steps[].id |
string | ja | |
after.steps[].position |
integer | ja | |
after.steps[].text |
string | ja | |
after.steps[].duration_min |
number | null | ja | |
after.steps[].temperature_c |
number | null | ja | |
version_id |
string | ja | |
checks |
object[] | ja | Checks on the recipe as written: warnings and notes, see recipe_check |
checks[].id |
"cycle" | "unmatched_ingredient" | "missing_quantity" | "duplicate_line" | "magnitude_jump" | "salt_range" | "yeast_range" | "no_flour" | "dry_addition" | "hydration_shift" | "piece_remainder" | "pieces_change" | "where_used" | "allergen_change" | "label_name_missing" | "step_mentions_missing" | "source_conflict" |
ja | |
checks[].severity |
"error" | "warn" | "info" | "ok" |
ja | |
checks[].message |
object | ja | |
checks[].message.nl |
string | ja | |
checks[].message.en |
string | ja | |
checks[].line |
string | null | ja | |
checks[].step |
integer | null | ja | |
checks[].suggestable |
boolean | ja | Adorea may propose a fix |
checks[].action |
object | null | ja |
recipe_where_used
Section titled “recipe_where_used”Recipes that use this recipe as a component: directly, and through other components.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
recipe |
string | ja | Recipe id or slug, e.g. “desembrood” |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
direct |
object[] | ja | |
direct[].id |
string | ja | |
direct[].slug |
string | ja | |
direct[].name |
string | ja | |
indirect |
object[] | ja | |
indirect[].id |
string | ja | |
indirect[].slug |
string | ja | |
indirect[].name |
string | ja |
recipe_scale
Section titled “recipe_scale”Scale a recipe to a dough weight, flour weight or number of pieces of a product. Changes nothing.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
recipe |
string | ja | Recipe id or slug, e.g. “desembrood” |
target |
object | ja | |
target |
object, kind = "dough" |
Variant | |
target.kind |
"dough" |
ja | |
target.grams |
number | ja | Total dough to make, in grams |
target |
object, kind = "flour" |
Variant | |
target.kind |
"flour" |
ja | |
target.grams |
number | ja | Total flour, in grams |
target |
object, kind = "pieces" |
Variant | |
target.kind |
"pieces" |
ja | |
target.pieces |
integer | ja | |
target.product |
string | Product of this recipe whose piece weight to use; defaults to the only one | |
target.piece_weight_g |
number | Piece weight when there is no product | |
expand |
boolean | Also list component recipes expanded into their own ingredients Standaard false. |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
recipe |
object | ja | |
recipe.id |
string | ja | |
recipe.slug |
string | ja | |
recipe.name |
string | ja | |
factor |
number | ja | |
loss_pct |
number | ja | |
dough_total_g |
number | ja | |
flour_total_g |
number | ja | |
pieces |
integer | null | ja | Whole pieces the scaled batch yields, when a piece weight is known |
piece_weight_g |
number | null | ja | |
lines |
object[] | ja | |
lines[].name |
string | ja | |
lines[].group_label |
string | null | ja | |
lines[].note |
string | null | ja | |
lines[].component_recipe_id |
string | null | ja | |
lines[].reference_grams |
number | null | ja | |
lines[].grams |
number | null | ja | Unrounded; round for display only |
expanded_lines |
object[] | null | ja | |
extras |
object[] | ja | Per-piece extras (toppings) for the whole batch |
extras[].name |
string | ja | |
extras[].grams |
number | ja |
Voorbeeld
Section titled “Voorbeeld”{ "recipe": "desembrood", "target": { "kind": "pieces", "pieces": 60, "product": "Desembrood groot" }}recipe_check
Section titled “recipe_check”Run the recipe checks: cycles, missing quantities, duplicate lines, salt and yeast ranges, dry seeds, pieces per batch, allergens, label names and recipes that use this one. On the saved recipe, or on a changed draft compared with it. Changes nothing.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
recipe |
string | ja | Recipe id or slug, e.g. “desembrood” |
draft |
object | A changed version to check against the saved recipe, as the editor keeps it. Leave out to check the saved recipe as it is | |
draft.lines |
object[] | ja | |
draft.lines[].key |
string | ja | |
draft.lines[].ingredient_id |
string | null | ja | |
draft.lines[].component_recipe_id |
string | null | ja | |
draft.lines[].name |
string | ja | |
draft.lines[].grams |
number | null | ja | |
draft.lines[].counts_as_flour |
boolean | ja | |
draft.lines[].group_label |
string | null | ja | |
draft.lines[].note |
string | null | ja | |
draft.lines[].optional |
boolean | ja | |
draft.lines[].display_name |
string | null | ja | |
draft.steps |
object[] | ja | |
draft.steps[].key |
string | ja | |
draft.steps[].text |
string | ja | |
draft.steps[].duration_min |
number | null | ja | |
draft.steps[].temperature_c |
number | null | ja | |
draft.products |
object[] | ja | |
draft.products[].key |
string | ja | |
draft.products[].id |
string | null | ja | |
draft.products[].name |
string | ja | |
draft.products[].piece_weight_g |
number | null | ja | |
draft.products[].archived |
boolean | ja | |
include_context |
boolean | Also return the data the checks ran on, for an editor that re-runs them itself Standaard false. |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
checks |
object[] | ja | |
checks[].id |
"cycle" | "unmatched_ingredient" | "missing_quantity" | "duplicate_line" | "magnitude_jump" | "salt_range" | "yeast_range" | "no_flour" | "dry_addition" | "hydration_shift" | "piece_remainder" | "pieces_change" | "where_used" | "allergen_change" | "label_name_missing" | "step_mentions_missing" | "source_conflict" |
ja | |
checks[].severity |
"error" | "warn" | "info" | "ok" |
ja | |
checks[].message |
object | ja | |
checks[].message.nl |
string | ja | |
checks[].message.en |
string | ja | |
checks[].line |
string | null | ja | |
checks[].step |
integer | null | ja | |
checks[].suggestable |
boolean | ja | Adorea may propose a fix |
checks[].action |
object | null | ja | |
context |
any | With include_context: ingredients, recipes and thresholds the checks used | |
draft |
object | ja | The saved recipe as a draft (lines keyed by line id), the base of an edit |
draft.lines |
object[] | ja | |
draft.lines[].key |
string | ja | |
draft.lines[].ingredient_id |
string | null | ja | |
draft.lines[].component_recipe_id |
string | null | ja | |
draft.lines[].name |
string | ja | |
draft.lines[].grams |
number | null | ja | |
draft.lines[].counts_as_flour |
boolean | ja | |
draft.lines[].group_label |
string | null | ja | |
draft.lines[].note |
string | null | ja | |
draft.lines[].optional |
boolean | ja | |
draft.lines[].display_name |
string | null | ja | |
draft.steps |
object[] | ja | |
draft.steps[].key |
string | ja | |
draft.steps[].text |
string | ja | |
draft.steps[].duration_min |
number | null | ja | |
draft.steps[].temperature_c |
number | null | ja | |
draft.products |
object[] | ja | |
draft.products[].key |
string | ja | |
draft.products[].id |
string | null | ja | |
draft.products[].name |
string | ja | |
draft.products[].piece_weight_g |
number | null | ja | |
draft.products[].archived |
boolean | ja |
Voorbeeld
Section titled “Voorbeeld”Warnings and notes on the saved recipe: missing quantities, salt range, label names.
{ "recipe": "desembrood"}recipe_apply_edit
Section titled “recipe_apply_edit”Change a recipe in one go: lines, method and product sizes, written as one version. Refused with conflict when the recipe changed since base_version_id; read it again and redo the edit. Returns the checks on the result.
Toegang: recepten wijzigen write:recipes
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
recipe |
string | ja | Recipe id or slug, e.g. “desembrood” |
base_version_id |
string | null | ja | version_id from recipe_get when the edit started. If the recipe or its products changed since, the edit is refused with conflict |
edit |
object | ja | |
edit.lines |
object[] | The complete new list of lines, in order; leave out to keep the lines | |
edit.lines[].ingredient |
string | Ingredient id, name or alias (case-insensitive), e.g. “T65” | |
edit.lines[].recipe |
string | Component recipe (a sub-recipe such as a dough or cream) | |
edit.lines[].grams |
number | null | Null when the quantity is unknown Standaard null. |
|
edit.lines[].counts_as_flour |
boolean | Defaults to the ingredient’s flour flag; false for components | |
edit.lines[].group_label |
string | null | Dough structure, e.g. “biga”, “deel 1” | |
edit.lines[].note |
string | null | Process detail, e.g. “18 °C” | |
edit.lines[].optional |
boolean | Standaard false. |
|
edit.lines[].display_name |
string | null | Name shown to bakers when it differs from the ingredient | |
edit.lines[].id |
string | Id of an existing line of this recipe, to keep it as the same line (the history pairs it up) | |
edit.steps |
object[] | The complete new method; leave out to keep it | |
edit.steps[].text |
string | ja | |
edit.steps[].duration_min |
number | null | ||
edit.steps[].temperature_c |
number | null | ||
edit.products |
object[] | Products to add, change or archive (name, piece weight). Products not listed stay as they are | |
edit.products[].id |
string | Existing product of this recipe; leave out to add a product | |
edit.products[].name |
string | ja | |
edit.products[].piece_weight_g |
number | null | ja | |
edit.products[].archived |
boolean | true archives the product Standaard false. |
|
reason |
string | Why this change is made; shown as “Waarom” in the version history | |
suggestions_accepted |
object[] | Suggestions of Adorea that are part of this edit (app only) Standaard []. |
|
suggestions_accepted[].title |
string | ja | |
suggestions_accepted[].call_id |
string | The suggestion call it came from | |
suggestions_accepted[].from_command |
boolean | Carried out from a typed instruction, not taken over from a proposal Standaard false. |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
object | ja | |
before.id |
string | ja | |
before.slug |
string | ja | |
before.name |
string | ja | |
before.category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
ja | |
before.tags |
string[] | ja | |
before.reference_note |
string | null | ja | |
before.status |
"draft" | "complete" |
ja | |
before.can_be_component |
boolean | ja | |
before.loss_pct |
number | ja | |
before.bake_profile |
record | null | ja | |
before.source_note |
string | null | ja | |
before.archived_at |
string | null | ja | |
before.lines |
object[] | ja | |
before.lines[].id |
string | ja | |
before.lines[].position |
integer | ja | |
before.lines[].ingredient_id |
string | null | ja | |
before.lines[].component_recipe_id |
string | null | ja | |
before.lines[].grams |
number | null | ja | |
before.lines[].counts_as_flour |
boolean | ja | |
before.lines[].group_label |
string | null | ja | |
before.lines[].note |
string | null | ja | |
before.lines[].optional |
boolean | ja | |
before.lines[].display_name |
string | null | ja | |
before.steps |
object[] | ja | |
before.steps[].id |
string | ja | |
before.steps[].position |
integer | ja | |
before.steps[].text |
string | ja | |
before.steps[].duration_min |
number | null | ja | |
before.steps[].temperature_c |
number | null | ja | |
after |
object | ja | |
after.id |
string | ja | |
after.slug |
string | ja | |
after.name |
string | ja | |
after.category |
"brood" | "viennoiserie" | "cake_taart" | "koek" | "halffabricaat" |
ja | |
after.tags |
string[] | ja | |
after.reference_note |
string | null | ja | |
after.status |
"draft" | "complete" |
ja | |
after.can_be_component |
boolean | ja | |
after.loss_pct |
number | ja | |
after.bake_profile |
record | null | ja | |
after.source_note |
string | null | ja | |
after.archived_at |
string | null | ja | |
after.lines |
object[] | ja | |
after.lines[].id |
string | ja | |
after.lines[].position |
integer | ja | |
after.lines[].ingredient_id |
string | null | ja | |
after.lines[].component_recipe_id |
string | null | ja | |
after.lines[].grams |
number | null | ja | |
after.lines[].counts_as_flour |
boolean | ja | |
after.lines[].group_label |
string | null | ja | |
after.lines[].note |
string | null | ja | |
after.lines[].optional |
boolean | ja | |
after.lines[].display_name |
string | null | ja | |
after.steps |
object[] | ja | |
after.steps[].id |
string | ja | |
after.steps[].position |
integer | ja | |
after.steps[].text |
string | ja | |
after.steps[].duration_min |
number | null | ja | |
after.steps[].temperature_c |
number | null | ja | |
version_id |
string | ja | |
products |
object[] | ja | Versions written for products changed in the same edit |
products[].product_id |
string | ja | |
products[].version_id |
string | ja | |
checks |
object[] | ja | |
checks[].id |
"cycle" | "unmatched_ingredient" | "missing_quantity" | "duplicate_line" | "magnitude_jump" | "salt_range" | "yeast_range" | "no_flour" | "dry_addition" | "hydration_shift" | "piece_remainder" | "pieces_change" | "where_used" | "allergen_change" | "label_name_missing" | "step_mentions_missing" | "source_conflict" |
ja | |
checks[].severity |
"error" | "warn" | "info" | "ok" |
ja | |
checks[].message |
object | ja | |
checks[].message.nl |
string | ja | |
checks[].message.en |
string | ja | |
checks[].line |
string | null | ja | |
checks[].step |
integer | null | ja | |
checks[].suggestable |
boolean | ja | Adorea may propose a fix |
checks[].action |
object | null | ja |
Voorbeeld
Section titled “Voorbeeld”Take base_version_id from recipe_get. One edit is one version.
{ "recipe": "desembrood", "base_version_id": "01JD3Y8Q2W5V7K9M1N3P5R7T9V", "edit": { "lines": [ { "ingredient": "Tarwebloem T65", "grams": 900 }, { "ingredient": "Volkorenmeel", "grams": 100 }, { "ingredient": "Water", "grams": 720 }, { "recipe": "desem", "grams": 200 }, { "ingredient": "Zout", "grams": 22 } ] }, "reason": "Zout naar 2,2%"}Grondstoffen
Section titled “Grondstoffen”ingredient_list
Section titled “ingredient_list”List ingredients with how many recipes use each. Filter by text, composition, allergen, unconfirmed import assumptions, or “recept ontbreekt”.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
query |
string | Matches name, label name and aliases | |
composition |
"meel" | "vocht" | "rijs" | "vet" | "suiker" | "toevoeging" | "overig" |
||
allergen |
"gluten" | "crustaceans" | "eggs" | "fish" | "peanuts" | "soy" | "milk" | "nuts" | "celery" | "mustard" | "sesame" | "sulphites" | "lupin" | "molluscs" |
||
unconfirmed |
boolean | Only ingredients with conversion assumptions that are not confirmed yet | |
recipe_missing |
boolean | Only preferments marked “recept ontbreekt” | |
include_archived |
boolean | Standaard false. |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
items |
object[] | ja | |
items[].id |
string | ja | |
items[].name |
string | ja | |
items[].label_name |
string | null | ja | |
items[].aliases |
string[] | ja | |
items[].composition |
"meel" | "vocht" | "rijs" | "vet" | "suiker" | "toevoeging" | "overig" |
ja | |
items[].is_flour_default |
boolean | ja | |
items[].g_per_piece |
number | null | ja | |
items[].g_per_ml |
number | null | ja | |
items[].allergens |
"gluten" | "crustaceans" | "eggs" | "fish" | "peanuts" | "soy" | "milk" | "nuts" | "celery" | "mustard" | "sesame" | "sulphites" | "lupin" | "molluscs"[] |
ja | |
items[].packs |
object[] | ja | |
items[].packs[].name |
string | ja | |
items[].packs[].grams |
number | ja | |
items[].article_number |
string | null | ja | |
items[].supplier |
string | null | ja | |
items[].origin |
string | null | ja | |
items[].recipe_missing |
boolean | A preferment such as desem without a recipe of its own (“recept ontbreekt”) Standaard false. |
|
items[].assumptions |
object[] | Conversions from the import that still need a one-time confirmation Standaard []. |
|
items[].assumptions[].text |
string | ja | e.g. “1 ei = 50 g”, as the workbook states it |
items[].assumptions[].recipes |
string[] | ja | Recipes whose grams rest on it |
items[].assumptions[].confirmed_at |
string | null | ja | When the owner confirmed it; null while unconfirmed |
items[].absorbs_water |
boolean | Seeds, grains and flakes: take up water and want soaking water Standaard false. |
|
items[].merged_into_id |
string | null | ja | |
items[].archived_at |
string | null | ja | |
items[].recipe_count |
integer | ja |
ingredient_get
Section titled “ingredient_get”Get one ingredient with the recipes that use it directly.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
ingredient |
string | ja | Ingredient id, name or alias (case-insensitive), e.g. “T65” |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
ingredient |
object | ja | |
ingredient.id |
string | ja | |
ingredient.name |
string | ja | |
ingredient.label_name |
string | null | ja | |
ingredient.aliases |
string[] | ja | |
ingredient.composition |
"meel" | "vocht" | "rijs" | "vet" | "suiker" | "toevoeging" | "overig" |
ja | |
ingredient.is_flour_default |
boolean | ja | |
ingredient.g_per_piece |
number | null | ja | |
ingredient.g_per_ml |
number | null | ja | |
ingredient.allergens |
"gluten" | "crustaceans" | "eggs" | "fish" | "peanuts" | "soy" | "milk" | "nuts" | "celery" | "mustard" | "sesame" | "sulphites" | "lupin" | "molluscs"[] |
ja | |
ingredient.packs |
object[] | ja | |
ingredient.packs[].name |
string | ja | |
ingredient.packs[].grams |
number | ja | |
ingredient.article_number |
string | null | ja | |
ingredient.supplier |
string | null | ja | |
ingredient.origin |
string | null | ja | |
ingredient.recipe_missing |
boolean | A preferment such as desem without a recipe of its own (“recept ontbreekt”) Standaard false. |
|
ingredient.assumptions |
object[] | Conversions from the import that still need a one-time confirmation Standaard []. |
|
ingredient.assumptions[].text |
string | ja | e.g. “1 ei = 50 g”, as the workbook states it |
ingredient.assumptions[].recipes |
string[] | ja | Recipes whose grams rest on it |
ingredient.assumptions[].confirmed_at |
string | null | ja | When the owner confirmed it; null while unconfirmed |
ingredient.absorbs_water |
boolean | Seeds, grains and flakes: take up water and want soaking water Standaard false. |
|
ingredient.merged_into_id |
string | null | ja | |
ingredient.archived_at |
string | null | ja | |
used_in |
object[] | ja | |
used_in[].id |
string | ja | |
used_in[].slug |
string | ja | |
used_in[].name |
string | ja | |
used_in[].grams |
number | null | ja |
ingredient_create
Section titled “ingredient_create”Create an ingredient. Composition and the flour flag are guessed from the name when left out.
Toegang: grondstoffen wijzigen write:ingredients
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
name |
string | ja | |
label_name |
string | null | Name on product labels | |
aliases |
string[] | ||
composition |
"meel" | "vocht" | "rijs" | "vet" | "suiker" | "toevoeging" | "overig" |
Group in the dough bar; vocht counts for hydration | |
is_flour_default |
boolean | New recipe lines with this ingredient count as flour | |
g_per_piece |
number | null | Grams per piece, e.g. one egg | |
g_per_ml |
number | null | ||
allergens |
"gluten" | "crustaceans" | "eggs" | "fish" | "peanuts" | "soy" | "milk" | "nuts" | "celery" | "mustard" | "sesame" | "sulphites" | "lupin" | "molluscs"[] |
||
packs |
object[] | ||
packs[].name |
string | ja | |
packs[].grams |
number | ja | |
article_number |
string | null | ||
supplier |
string | null | ||
origin |
string | null | ||
recipe_missing |
boolean | Mark a preferment such as desem as “recept ontbreekt” | |
absorbs_water |
boolean | Seeds, grains and flakes that take up water; guessed from the name when left out | |
assumptions |
object[] | Replaces the list of conversion assumptions | |
assumptions[].text |
string | ja | e.g. “1 ei = 50 g”, as the workbook states it |
assumptions[].recipes |
string[] | ja | Recipes whose grams rest on it |
assumptions[].confirmed_at |
string | null | ja | When the owner confirmed it; null while unconfirmed |
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
object | ja | |
before |
object | Variant | |
before.id |
string | ja | |
before.name |
string | ja | |
before.label_name |
string | null | ja | |
before.aliases |
string[] | ja | |
before.composition |
"meel" | "vocht" | "rijs" | "vet" | "suiker" | "toevoeging" | "overig" |
ja | |
before.is_flour_default |
boolean | ja | |
before.g_per_piece |
number | null | ja | |
before.g_per_ml |
number | null | ja | |
before.allergens |
"gluten" | "crustaceans" | "eggs" | "fish" | "peanuts" | "soy" | "milk" | "nuts" | "celery" | "mustard" | "sesame" | "sulphites" | "lupin" | "molluscs"[] |
ja | |
before.packs |
object[] | ja | |
before.packs[].name |
string | ja | |
before.packs[].grams |
number | ja | |
before.article_number |
string | null | ja | |
before.supplier |
string | null | ja | |
before.origin |
string | null | ja | |
before.recipe_missing |
boolean | A preferment such as desem without a recipe of its own (“recept ontbreekt”) Standaard false. |
|
before.assumptions |
object[] | Conversions from the import that still need a one-time confirmation Standaard []. |
|
before.assumptions[].text |
string | ja | e.g. “1 ei = 50 g”, as the workbook states it |
before.assumptions[].recipes |
string[] | ja | Recipes whose grams rest on it |
before.assumptions[].confirmed_at |
string | null | ja | When the owner confirmed it; null while unconfirmed |
before.absorbs_water |
boolean | Seeds, grains and flakes: take up water and want soaking water Standaard false. |
|
before.merged_into_id |
string | null | ja | |
before.archived_at |
string | null | ja | |
after |
object | ja | |
after.id |
string | ja | |
after.name |
string | ja | |
after.label_name |
string | null | ja | |
after.aliases |
string[] | ja | |
after.composition |
"meel" | "vocht" | "rijs" | "vet" | "suiker" | "toevoeging" | "overig" |
ja | |
after.is_flour_default |
boolean | ja | |
after.g_per_piece |
number | null | ja | |
after.g_per_ml |
number | null | ja | |
after.allergens |
"gluten" | "crustaceans" | "eggs" | "fish" | "peanuts" | "soy" | "milk" | "nuts" | "celery" | "mustard" | "sesame" | "sulphites" | "lupin" | "molluscs"[] |
ja | |
after.packs |
object[] | ja | |
after.packs[].name |
string | ja | |
after.packs[].grams |
number | ja | |
after.article_number |
string | null | ja | |
after.supplier |
string | null | ja | |
after.origin |
string | null | ja | |
after.recipe_missing |
boolean | A preferment such as desem without a recipe of its own (“recept ontbreekt”) Standaard false. |
|
after.assumptions |
object[] | Conversions from the import that still need a one-time confirmation Standaard []. |
|
after.assumptions[].text |
string | ja | e.g. “1 ei = 50 g”, as the workbook states it |
after.assumptions[].recipes |
string[] | ja | Recipes whose grams rest on it |
after.assumptions[].confirmed_at |
string | null | ja | When the owner confirmed it; null while unconfirmed |
after.absorbs_water |
boolean | Seeds, grains and flakes: take up water and want soaking water Standaard false. |
|
after.merged_into_id |
string | null | ja | |
after.archived_at |
string | null | ja | |
version_id |
string | ja |
ingredient_update
Section titled “ingredient_update”Change an ingredient: names, label name, composition, flour flag, allergens, packs, supplier data, “recept ontbreekt”. confirm_assumptions confirms the conversions from the import.
Toegang: grondstoffen wijzigen write:ingredients
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
name |
string | ||
label_name |
string | null | Name on product labels | |
aliases |
string[] | ||
composition |
"meel" | "vocht" | "rijs" | "vet" | "suiker" | "toevoeging" | "overig" |
Group in the dough bar; vocht counts for hydration | |
is_flour_default |
boolean | New recipe lines with this ingredient count as flour | |
g_per_piece |
number | null | Grams per piece, e.g. one egg | |
g_per_ml |
number | null | ||
allergens |
"gluten" | "crustaceans" | "eggs" | "fish" | "peanuts" | "soy" | "milk" | "nuts" | "celery" | "mustard" | "sesame" | "sulphites" | "lupin" | "molluscs"[] |
||
packs |
object[] | ||
packs[].name |
string | ja | |
packs[].grams |
number | ja | |
article_number |
string | null | ||
supplier |
string | null | ||
origin |
string | null | ||
recipe_missing |
boolean | Mark a preferment such as desem as “recept ontbreekt” | |
absorbs_water |
boolean | Seeds, grains and flakes that take up water; guessed from the name when left out | |
assumptions |
object[] | Replaces the list of conversion assumptions | |
assumptions[].text |
string | ja | e.g. “1 ei = 50 g”, as the workbook states it |
assumptions[].recipes |
string[] | ja | Recipes whose grams rest on it |
assumptions[].confirmed_at |
string | null | ja | When the owner confirmed it; null while unconfirmed |
ingredient |
string | ja | Ingredient id, name or alias (case-insensitive), e.g. “T65” |
archived |
boolean | Archive (true) or bring back (false) | |
confirm_assumptions |
boolean | Mark every open conversion assumption as confirmed now | |
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
object | ja | |
before |
object | Variant | |
before.id |
string | ja | |
before.name |
string | ja | |
before.label_name |
string | null | ja | |
before.aliases |
string[] | ja | |
before.composition |
"meel" | "vocht" | "rijs" | "vet" | "suiker" | "toevoeging" | "overig" |
ja | |
before.is_flour_default |
boolean | ja | |
before.g_per_piece |
number | null | ja | |
before.g_per_ml |
number | null | ja | |
before.allergens |
"gluten" | "crustaceans" | "eggs" | "fish" | "peanuts" | "soy" | "milk" | "nuts" | "celery" | "mustard" | "sesame" | "sulphites" | "lupin" | "molluscs"[] |
ja | |
before.packs |
object[] | ja | |
before.packs[].name |
string | ja | |
before.packs[].grams |
number | ja | |
before.article_number |
string | null | ja | |
before.supplier |
string | null | ja | |
before.origin |
string | null | ja | |
before.recipe_missing |
boolean | A preferment such as desem without a recipe of its own (“recept ontbreekt”) Standaard false. |
|
before.assumptions |
object[] | Conversions from the import that still need a one-time confirmation Standaard []. |
|
before.assumptions[].text |
string | ja | e.g. “1 ei = 50 g”, as the workbook states it |
before.assumptions[].recipes |
string[] | ja | Recipes whose grams rest on it |
before.assumptions[].confirmed_at |
string | null | ja | When the owner confirmed it; null while unconfirmed |
before.absorbs_water |
boolean | Seeds, grains and flakes: take up water and want soaking water Standaard false. |
|
before.merged_into_id |
string | null | ja | |
before.archived_at |
string | null | ja | |
after |
object | ja | |
after.id |
string | ja | |
after.name |
string | ja | |
after.label_name |
string | null | ja | |
after.aliases |
string[] | ja | |
after.composition |
"meel" | "vocht" | "rijs" | "vet" | "suiker" | "toevoeging" | "overig" |
ja | |
after.is_flour_default |
boolean | ja | |
after.g_per_piece |
number | null | ja | |
after.g_per_ml |
number | null | ja | |
after.allergens |
"gluten" | "crustaceans" | "eggs" | "fish" | "peanuts" | "soy" | "milk" | "nuts" | "celery" | "mustard" | "sesame" | "sulphites" | "lupin" | "molluscs"[] |
ja | |
after.packs |
object[] | ja | |
after.packs[].name |
string | ja | |
after.packs[].grams |
number | ja | |
after.article_number |
string | null | ja | |
after.supplier |
string | null | ja | |
after.origin |
string | null | ja | |
after.recipe_missing |
boolean | A preferment such as desem without a recipe of its own (“recept ontbreekt”) Standaard false. |
|
after.assumptions |
object[] | Conversions from the import that still need a one-time confirmation Standaard []. |
|
after.assumptions[].text |
string | ja | e.g. “1 ei = 50 g”, as the workbook states it |
after.assumptions[].recipes |
string[] | ja | Recipes whose grams rest on it |
after.assumptions[].confirmed_at |
string | null | ja | When the owner confirmed it; null while unconfirmed |
after.absorbs_water |
boolean | Seeds, grains and flakes: take up water and want soaking water Standaard false. |
|
after.merged_into_id |
string | null | ja | |
after.archived_at |
string | null | ja | |
version_id |
string | ja |
ingredient_merge
Section titled “ingredient_merge”Propose merging duplicate ingredients into one. Staged: nothing changes until pending_confirm. Recipes keep showing the name bakers know.
Toegang: grondstoffen wijzigen write:ingredients
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
from |
string[] | ja | Ingredients to merge away |
into |
string | ja | The ingredient that stays |
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
pending |
object | ja | |
pending.id |
string | ja | |
pending.op_name |
string | ja | |
pending.input |
any | ja | |
pending.preview |
any | ja | |
pending.created_by |
string | ja | |
pending.status |
"pending" | "confirmed" | "cancelled" | "expired" |
ja | |
pending.expires_at |
string | ja | |
pending.created_at |
string | ja | |
preview |
object | ja | |
preview.into |
object | ja | |
preview.into.id |
string | ja | |
preview.into.name |
string | ja | |
preview.from |
object[] | ja | |
preview.from[].id |
string | ja | |
preview.from[].name |
string | ja | |
preview.aliases_added |
string[] | ja | |
preview.recipes |
object[] | ja | |
preview.recipes[].id |
string | ja | |
preview.recipes[].name |
string | ja | |
preview.recipes[].lines |
integer | ja | |
preview.text |
string | ja |
Voorbeeld
Section titled “Voorbeeld”{ "from": [ "bloem T65", "Tarwebloem t65" ], "into": "Tarwebloem T65", "reason": "Dubbele namen uit de import"}Producten
Section titled “Producten”product_list
Section titled “product_list”List products (sellable pieces of a recipe) with pieces per batch.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
recipe |
string | Recipe id or slug, e.g. “desembrood” | |
query |
string | ||
include_archived |
boolean | Standaard false. |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
items |
object[] | ja | |
items[].id |
string | ja | |
items[].recipe_id |
string | ja | |
items[].name |
string | ja | |
items[].piece_weight_g |
number | null | ja | |
items[].extra_per_piece |
object[] | ja | |
items[].extra_per_piece[].ingredient_id |
string | null | ||
items[].extra_per_piece[].recipe_id |
string | null | ||
items[].extra_per_piece[].grams |
number | ja | |
items[].shop_price_cents |
integer | null | ja | |
items[].traces_note |
string | null | ja | |
items[].archived_at |
string | null | ja | |
items[].locations |
object[] | ja | |
items[].locations[].location_id |
string | ja | |
items[].locations[].sold_here |
boolean | ja | |
items[].locations[].shop_price_cents |
integer | null | ja | |
items[].recipe_slug |
string | ja | |
items[].recipe_name |
string | ja | |
items[].pieces_per_batch |
integer | null | ja | Whole pieces one batch of the recipe yields |
product_create
Section titled “product_create”Add a product to a recipe: a sellable piece with its dough weight, e.g. Desembrood 1.250 g and 950 g are two products of one recipe.
Toegang: recepten wijzigen write:recipes
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
name |
string | ja | e.g. “Desembrood groot” |
piece_weight_g |
number | null | Dough weight per piece in grams | |
extra_per_piece |
object[] | Added per piece after dividing, e.g. seeds on top | |
extra_per_piece[].ingredient |
string | Ingredient id, name or alias (case-insensitive), e.g. “T65” | |
extra_per_piece[].recipe |
string | Recipe id or slug, e.g. “desembrood” | |
extra_per_piece[].grams |
number | ja | |
shop_price_cents |
integer | null | ||
traces_note |
string | null | ||
recipe |
string | ja | Recipe id or slug, e.g. “desembrood” |
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
object | ja | |
before |
object | Variant | |
before.id |
string | ja | |
before.recipe_id |
string | ja | |
before.name |
string | ja | |
before.piece_weight_g |
number | null | ja | |
before.extra_per_piece |
object[] | ja | |
before.extra_per_piece[].ingredient_id |
string | null | ||
before.extra_per_piece[].recipe_id |
string | null | ||
before.extra_per_piece[].grams |
number | ja | |
before.shop_price_cents |
integer | null | ja | |
before.traces_note |
string | null | ja | |
before.archived_at |
string | null | ja | |
before.locations |
object[] | ja | |
before.locations[].location_id |
string | ja | |
before.locations[].sold_here |
boolean | ja | |
before.locations[].shop_price_cents |
integer | null | ja | |
after |
object | ja | |
after.id |
string | ja | |
after.recipe_id |
string | ja | |
after.name |
string | ja | |
after.piece_weight_g |
number | null | ja | |
after.extra_per_piece |
object[] | ja | |
after.extra_per_piece[].ingredient_id |
string | null | ||
after.extra_per_piece[].recipe_id |
string | null | ||
after.extra_per_piece[].grams |
number | ja | |
after.shop_price_cents |
integer | null | ja | |
after.traces_note |
string | null | ja | |
after.archived_at |
string | null | ja | |
after.locations |
object[] | ja | |
after.locations[].location_id |
string | ja | |
after.locations[].sold_here |
boolean | ja | |
after.locations[].shop_price_cents |
integer | null | ja | |
version_id |
string | ja |
product_update
Section titled “product_update”Change a product: name, piece weight, extras, shop price, traces note.
Toegang: recepten wijzigen write:recipes
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
name |
string | e.g. “Desembrood groot” | |
piece_weight_g |
number | null | Dough weight per piece in grams | |
extra_per_piece |
object[] | Added per piece after dividing, e.g. seeds on top | |
extra_per_piece[].ingredient |
string | Ingredient id, name or alias (case-insensitive), e.g. “T65” | |
extra_per_piece[].recipe |
string | Recipe id or slug, e.g. “desembrood” | |
extra_per_piece[].grams |
number | ja | |
shop_price_cents |
integer | null | ||
traces_note |
string | null | ||
product |
string | ja | Product id, or product name within the recipe |
recipe |
string | Move to another recipe | |
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
object | ja | |
before |
object | Variant | |
before.id |
string | ja | |
before.recipe_id |
string | ja | |
before.name |
string | ja | |
before.piece_weight_g |
number | null | ja | |
before.extra_per_piece |
object[] | ja | |
before.extra_per_piece[].ingredient_id |
string | null | ||
before.extra_per_piece[].recipe_id |
string | null | ||
before.extra_per_piece[].grams |
number | ja | |
before.shop_price_cents |
integer | null | ja | |
before.traces_note |
string | null | ja | |
before.archived_at |
string | null | ja | |
before.locations |
object[] | ja | |
before.locations[].location_id |
string | ja | |
before.locations[].sold_here |
boolean | ja | |
before.locations[].shop_price_cents |
integer | null | ja | |
after |
object | ja | |
after.id |
string | ja | |
after.recipe_id |
string | ja | |
after.name |
string | ja | |
after.piece_weight_g |
number | null | ja | |
after.extra_per_piece |
object[] | ja | |
after.extra_per_piece[].ingredient_id |
string | null | ||
after.extra_per_piece[].recipe_id |
string | null | ||
after.extra_per_piece[].grams |
number | ja | |
after.shop_price_cents |
integer | null | ja | |
after.traces_note |
string | null | ja | |
after.archived_at |
string | null | ja | |
after.locations |
object[] | ja | |
after.locations[].location_id |
string | ja | |
after.locations[].sold_here |
boolean | ja | |
after.locations[].shop_price_cents |
integer | null | ja | |
version_id |
string | ja |
product_archive
Section titled “product_archive”Archive a product (or bring it back).
Toegang: recepten wijzigen write:recipes
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
product |
string | ja | Product id, or product name within the recipe |
archived |
boolean | Standaard true. |
|
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
object | ja | |
before |
object | Variant | |
before.id |
string | ja | |
before.recipe_id |
string | ja | |
before.name |
string | ja | |
before.piece_weight_g |
number | null | ja | |
before.extra_per_piece |
object[] | ja | |
before.extra_per_piece[].ingredient_id |
string | null | ||
before.extra_per_piece[].recipe_id |
string | null | ||
before.extra_per_piece[].grams |
number | ja | |
before.shop_price_cents |
integer | null | ja | |
before.traces_note |
string | null | ja | |
before.archived_at |
string | null | ja | |
before.locations |
object[] | ja | |
before.locations[].location_id |
string | ja | |
before.locations[].sold_here |
boolean | ja | |
before.locations[].shop_price_cents |
integer | null | ja | |
after |
object | ja | |
after.id |
string | ja | |
after.recipe_id |
string | ja | |
after.name |
string | ja | |
after.piece_weight_g |
number | null | ja | |
after.extra_per_piece |
object[] | ja | |
after.extra_per_piece[].ingredient_id |
string | null | ||
after.extra_per_piece[].recipe_id |
string | null | ||
after.extra_per_piece[].grams |
number | ja | |
after.shop_price_cents |
integer | null | ja | |
after.traces_note |
string | null | ja | |
after.archived_at |
string | null | ja | |
after.locations |
object[] | ja | |
after.locations[].location_id |
string | ja | |
after.locations[].sold_here |
boolean | ja | |
after.locations[].shop_price_cents |
integer | null | ja | |
version_id |
string | ja |
product_set_location
Section titled “product_set_location”Set whether a product is sold at a location, and its price there.
Toegang: recepten wijzigen write:recipes
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
product |
string | ja | Product id, or product name within the recipe |
location |
string | ja | Location id or name |
sold_here |
boolean | ja | |
shop_price_cents |
integer | null | Price at this location; null uses the product price | |
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
object | ja | |
before |
object | Variant | |
before.id |
string | ja | |
before.recipe_id |
string | ja | |
before.name |
string | ja | |
before.piece_weight_g |
number | null | ja | |
before.extra_per_piece |
object[] | ja | |
before.extra_per_piece[].ingredient_id |
string | null | ||
before.extra_per_piece[].recipe_id |
string | null | ||
before.extra_per_piece[].grams |
number | ja | |
before.shop_price_cents |
integer | null | ja | |
before.traces_note |
string | null | ja | |
before.archived_at |
string | null | ja | |
before.locations |
object[] | ja | |
before.locations[].location_id |
string | ja | |
before.locations[].sold_here |
boolean | ja | |
before.locations[].shop_price_cents |
integer | null | ja | |
after |
object | ja | |
after.id |
string | ja | |
after.recipe_id |
string | ja | |
after.name |
string | ja | |
after.piece_weight_g |
number | null | ja | |
after.extra_per_piece |
object[] | ja | |
after.extra_per_piece[].ingredient_id |
string | null | ||
after.extra_per_piece[].recipe_id |
string | null | ||
after.extra_per_piece[].grams |
number | ja | |
after.shop_price_cents |
integer | null | ja | |
after.traces_note |
string | null | ja | |
after.archived_at |
string | null | ja | |
after.locations |
object[] | ja | |
after.locations[].location_id |
string | ja | |
after.locations[].sold_here |
boolean | ja | |
after.locations[].shop_price_cents |
integer | null | ja | |
version_id |
string | ja |
Locaties
Section titled “Locaties”location_list
Section titled “location_list”List the locations (shops, production sites) of the bakery.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
include_archived |
boolean | Standaard false. |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
items |
object[] | ja | |
items[].id |
string | ja | |
items[].name |
string | ja | |
items[].kind |
"winkel" | "productie" | "winkel_bakkerij" |
ja | |
items[].opening_days |
integer[] | ja | |
items[].day_start |
string | null | ja | |
items[].is_primary |
boolean | ja | |
items[].archived_at |
string | null | ja |
location_create
Section titled “location_create”Add a location: a shop, a production site or a shop with bakery.
Toegang: beheer admin
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
name |
string | ja | |
kind |
"winkel" | "productie" | "winkel_bakkerij" |
ja | |
opening_days |
integer[] | ISO weekdays, 1 = Monday | |
day_start |
string | null | “HH:MM” the production day starts | |
is_primary |
boolean | ||
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
object | ja | |
before |
object | Variant | |
before.id |
string | ja | |
before.name |
string | ja | |
before.kind |
"winkel" | "productie" | "winkel_bakkerij" |
ja | |
before.opening_days |
integer[] | ja | |
before.day_start |
string | null | ja | |
before.is_primary |
boolean | ja | |
before.archived_at |
string | null | ja | |
after |
object | ja | |
after.id |
string | ja | |
after.name |
string | ja | |
after.kind |
"winkel" | "productie" | "winkel_bakkerij" |
ja | |
after.opening_days |
integer[] | ja | |
after.day_start |
string | null | ja | |
after.is_primary |
boolean | ja | |
after.archived_at |
string | null | ja | |
version_id |
string | ja |
location_update
Section titled “location_update”Change a location: name, kind, opening days, day start, primary; or archive it.
Toegang: beheer admin
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
name |
string | ||
kind |
"winkel" | "productie" | "winkel_bakkerij" |
||
opening_days |
integer[] | ISO weekdays, 1 = Monday | |
day_start |
string | null | “HH:MM” the production day starts | |
is_primary |
boolean | ||
location |
string | ja | Location id or name |
archived |
boolean | ||
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
object | ja | |
before |
object | Variant | |
before.id |
string | ja | |
before.name |
string | ja | |
before.kind |
"winkel" | "productie" | "winkel_bakkerij" |
ja | |
before.opening_days |
integer[] | ja | |
before.day_start |
string | null | ja | |
before.is_primary |
boolean | ja | |
before.archived_at |
string | null | ja | |
after |
object | ja | |
after.id |
string | ja | |
after.name |
string | ja | |
after.kind |
"winkel" | "productie" | "winkel_bakkerij" |
ja | |
after.opening_days |
integer[] | ja | |
after.day_start |
string | null | ja | |
after.is_primary |
boolean | ja | |
after.archived_at |
string | null | ja | |
version_id |
string | ja |
Importeren
Section titled “Importeren”import_stage
Section titled “import_stage”Stage parsed workbook tabs as one import batch: proposes ingredients, duplicate merges, component links and categories. Writes no recipes; review with import_get, decide with import_resolve, then import_approve.
Toegang: importeren import
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
source_files |
string[] | ja | |
sheets |
object[] | ja | |
sheets[].file |
string | ja | |
sheets[].sheet |
string | ja | Tab name as written, including “ (onvolledig)” |
sheets[].workbook_number |
integer | null | ja | |
sheets[].name |
string | ja | Tab name without “ (onvolledig)” |
sheets[].incomplete |
boolean | ja | |
sheets[].slug |
string | null | ja | |
sheets[].lines |
object[] | ja | |
sheets[].lines[].row |
integer | ja | |
sheets[].lines[].raw |
string | ja | |
sheets[].lines[].name |
string | ja | |
sheets[].lines[].percentage |
number | null | ja | |
sheets[].lines[].grams |
number | null | ja | |
sheets[].lines[].component |
object | ja | |
sheets[].lines[].component |
object | Variant | |
sheets[].lines[].component.target |
string | ja | |
sheets[].lines[].component.hint |
string | ja | |
sheets[].lines[].group_label |
string | null | ja | |
sheets[].lines[].note |
string | null | ja | |
sheets[].lines[].optional |
boolean | ja | |
sheets[].piece_weight_g |
number | null | ja | |
sheets[].shop_price_cents |
integer | null | ja | |
sheets[].steps |
string[] | ja | |
sheets[].notes |
object | ja | |
sheets[].notes.source |
string | null | ja | |
sheets[].notes.conversions |
string[] | ja | |
sheets[].notes.components |
string[] | ja | |
sheets[].notes.dough_weight |
string | null | ja | |
sheets[].notes.warnings |
string[] | ja | |
sheets[].notes.missing |
string | null | ja | |
sheets[].sizes |
object[] | ja | |
sheets[].sizes[].label |
string | null | ja | |
sheets[].sizes[].grams |
number | ja | |
sheets[].issues |
string[] | ja | |
available_sheets |
string[] | Every tab name in the source workbooks, also those not imported now, to tell “not in this batch” from “does not exist” Standaard []. |
|
flags |
object[] | Known questions to keep flagged for the owner, e.g. a value that differs from an older source Standaard []. |
|
flags[].sheet |
string | ja | |
flags[].text |
string | ja | |
flags[].propose |
object | Changes the proposed recipe decision, e.g. a rename; stays changeable | |
flags[].propose.name |
string | ||
flags[].propose.can_be_component |
boolean |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
batch |
object | ja | |
batch.id |
string | ja | |
batch.status |
"staged" | "approved" | "discarded" |
ja | |
batch.source_files |
string[] | ja | |
batch.summary |
object | ja | |
batch.summary.recipes |
integer | ja | |
batch.summary.incomplete |
integer | ja | |
batch.summary.with_component_line |
integer | ja | |
batch.summary.lines_without_quantity |
integer | ja | |
batch.summary.without_piece_weight |
integer | ja | |
batch.summary.without_shop_price |
integer | ja | |
batch.summary.with_conversions |
integer | ja | |
batch.summary.distinct_ingredient_names |
integer | ja | |
batch.summary.ingredients_new |
integer | ja | |
batch.summary.ingredients_existing |
integer | ja | |
batch.summary.items |
record | ja | Item count per kind and status |
batch.result |
object | ja | After approval: what was written, per tab |
batch.result |
object | Variant | |
batch.result.recipes |
object[] | ja | |
batch.result.recipes[].file |
string | ja | |
batch.result.recipes[].sheet |
string | ja | |
batch.result.recipes[].recipe_id |
string | ja | |
batch.result.recipes[].slug |
string | ja | |
batch.result.recipes[].action |
"created" | "updated" | "unchanged" |
ja | |
batch.result.statements |
integer | ja | Statements in the one D1 batch that wrote it |
batch.created_by |
string | ja | |
batch.created_at |
string | ja |
import_list
Section titled “import_list”List import batches, newest first, with their summary and item counts (open questions per kind).
Toegang: importeren import
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
status |
"staged" | "approved" | "discarded" |
||
limit |
integer | Standaard 20. |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
items |
object[] | ja | |
items[].id |
string | ja | |
items[].status |
"staged" | "approved" | "discarded" |
ja | |
items[].source_files |
string[] | ja | |
items[].summary |
object | ja | |
items[].summary.recipes |
integer | ja | |
items[].summary.incomplete |
integer | ja | |
items[].summary.with_component_line |
integer | ja | |
items[].summary.lines_without_quantity |
integer | ja | |
items[].summary.without_piece_weight |
integer | ja | |
items[].summary.without_shop_price |
integer | ja | |
items[].summary.with_conversions |
integer | ja | |
items[].summary.distinct_ingredient_names |
integer | ja | |
items[].summary.ingredients_new |
integer | ja | |
items[].summary.ingredients_existing |
integer | ja | |
items[].summary.items |
record | ja | Item count per kind and status |
items[].result |
object | ja | After approval: what was written, per tab |
items[].result |
object | Variant | |
items[].result.recipes |
object[] | ja | |
items[].result.recipes[].file |
string | ja | |
items[].result.recipes[].sheet |
string | ja | |
items[].result.recipes[].recipe_id |
string | ja | |
items[].result.recipes[].slug |
string | ja | |
items[].result.recipes[].action |
"created" | "updated" | "unchanged" |
ja | |
items[].result.statements |
integer | ja | Statements in the one D1 batch that wrote it |
items[].created_by |
string | ja | |
items[].created_at |
string | ja |
import_get
Section titled “import_get”Get an import batch with its summary and the items to review, optionally filtered by kind or status.
Toegang: importeren import
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
batch |
string | Batch id; defaults to the newest batch | |
kind |
"recipe" | "ingredient" | "ingredient_merge" | "component" | "missing_recipe" | "conversion" | "flag" |
||
status |
"open" | "proposed" | "resolved" | "info" |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
batch |
object | ja | |
batch.id |
string | ja | |
batch.status |
"staged" | "approved" | "discarded" |
ja | |
batch.source_files |
string[] | ja | |
batch.summary |
object | ja | |
batch.summary.recipes |
integer | ja | |
batch.summary.incomplete |
integer | ja | |
batch.summary.with_component_line |
integer | ja | |
batch.summary.lines_without_quantity |
integer | ja | |
batch.summary.without_piece_weight |
integer | ja | |
batch.summary.without_shop_price |
integer | ja | |
batch.summary.with_conversions |
integer | ja | |
batch.summary.distinct_ingredient_names |
integer | ja | |
batch.summary.ingredients_new |
integer | ja | |
batch.summary.ingredients_existing |
integer | ja | |
batch.summary.items |
record | ja | Item count per kind and status |
batch.result |
object | ja | After approval: what was written, per tab |
batch.result |
object | Variant | |
batch.result.recipes |
object[] | ja | |
batch.result.recipes[].file |
string | ja | |
batch.result.recipes[].sheet |
string | ja | |
batch.result.recipes[].recipe_id |
string | ja | |
batch.result.recipes[].slug |
string | ja | |
batch.result.recipes[].action |
"created" | "updated" | "unchanged" |
ja | |
batch.result.statements |
integer | ja | Statements in the one D1 batch that wrote it |
batch.created_by |
string | ja | |
batch.created_at |
string | ja | |
items |
object[] | ja | |
items[].id |
string | ja | |
items[].kind |
"recipe" | "ingredient" | "ingredient_merge" | "component" | "missing_recipe" | "conversion" | "flag" |
ja | |
items[].status |
"open" | "proposed" | "resolved" | "info" |
ja | |
items[].payload |
any | ja | |
items[].resolution |
any | null | ja |
import_resolve
Section titled “import_resolve”Decide one item of a staged import. Changes only the batch; recipes are written when the batch is approved.
Toegang: importeren import
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
batch |
string | ja | |
item |
string | ja | |
resolution |
record | ja | Depends on the item kind. recipe: {action:“import”, name?, category?, can_be_component?} or {action:“skip”}. ingredient: {action:“create”, name, composition, is_flour_default, aliases} or {action:“use_existing”, ingredient_id}. ingredient_merge: {action:“merge”, into: |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
id |
string | ja | |
kind |
"recipe" | "ingredient" | "ingredient_merge" | "component" | "missing_recipe" | "conversion" | "flag" |
ja | |
status |
"open" | "proposed" | "resolved" | "info" |
ja | |
payload |
any | ja | |
resolution |
any | null | ja |
import_approve
Section titled “import_approve”Propose writing a fully decided import batch: ingredients, recipes, lines, method and products. Staged: nothing changes until pending_confirm.
Toegang: importeren import
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
batch |
string | ja | |
reason |
string |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
pending |
object | ja | |
pending.id |
string | ja | |
pending.op_name |
string | ja | |
pending.input |
any | ja | |
pending.preview |
any | ja | |
pending.created_by |
string | ja | |
pending.status |
"pending" | "confirmed" | "cancelled" | "expired" |
ja | |
pending.expires_at |
string | ja | |
pending.created_at |
string | ja | |
preview |
any | ja |
import_discard
Section titled “import_discard”Throw away a staged import. Nothing was written to recipes, so nothing changes there.
Toegang: importeren import
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
batch |
string | ja |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
batch |
object | ja | |
batch.id |
string | ja | |
batch.status |
"staged" | "approved" | "discarded" |
ja | |
batch.source_files |
string[] | ja | |
batch.summary |
object | ja | |
batch.summary.recipes |
integer | ja | |
batch.summary.incomplete |
integer | ja | |
batch.summary.with_component_line |
integer | ja | |
batch.summary.lines_without_quantity |
integer | ja | |
batch.summary.without_piece_weight |
integer | ja | |
batch.summary.without_shop_price |
integer | ja | |
batch.summary.with_conversions |
integer | ja | |
batch.summary.distinct_ingredient_names |
integer | ja | |
batch.summary.ingredients_new |
integer | ja | |
batch.summary.ingredients_existing |
integer | ja | |
batch.summary.items |
record | ja | Item count per kind and status |
batch.result |
object | ja | After approval: what was written, per tab |
batch.result |
object | Variant | |
batch.result.recipes |
object[] | ja | |
batch.result.recipes[].file |
string | ja | |
batch.result.recipes[].sheet |
string | ja | |
batch.result.recipes[].recipe_id |
string | ja | |
batch.result.recipes[].slug |
string | ja | |
batch.result.recipes[].action |
"created" | "updated" | "unchanged" |
ja | |
batch.result.statements |
integer | ja | Statements in the one D1 batch that wrote it |
batch.created_by |
string | ja | |
batch.created_at |
string | ja |
Voorgestelde wijzigingen
Section titled “Voorgestelde wijzigingen”pending_list
Section titled “pending_list”List staged changes waiting for confirmation, such as ingredient merges.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
status |
"pending" | "confirmed" | "cancelled" | "expired" |
Standaard "pending". |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
items |
object[] | ja | |
items[].id |
string | ja | |
items[].op_name |
string | ja | |
items[].input |
any | ja | |
items[].preview |
any | ja | |
items[].created_by |
string | ja | |
items[].status |
"pending" | "confirmed" | "cancelled" | "expired" |
ja | |
items[].expires_at |
string | ja | |
items[].created_at |
string | ja |
pending_confirm
Section titled “pending_confirm”Carry out a staged change. Needs the same permission as the op that staged it.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
id |
string | ja | |
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
pending |
object | ja | |
pending.id |
string | ja | |
pending.op_name |
string | ja | |
pending.input |
any | ja | |
pending.preview |
any | ja | |
pending.created_by |
string | ja | |
pending.status |
"pending" | "confirmed" | "cancelled" | "expired" |
ja | |
pending.expires_at |
string | ja | |
pending.created_at |
string | ja | |
version_ids |
string[] | ja |
pending_cancel
Section titled “pending_cancel”Cancel a staged change. Nothing is written.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
id |
string | ja |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
pending |
object | ja | |
pending.id |
string | ja | |
pending.op_name |
string | ja | |
pending.input |
any | ja | |
pending.preview |
any | ja | |
pending.created_by |
string | ja | |
pending.status |
"pending" | "confirmed" | "cancelled" | "expired" |
ja | |
pending.expires_at |
string | ja | |
pending.created_at |
string | ja |
Geschiedenis
Section titled “Geschiedenis”version_list
Section titled “version_list”List the change history, newest first: who changed what (line by line for recipes), through the app, Claude or an import, and why.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
entity_type |
"recipe" | "ingredient" | "product" | "location" | "device" | "company" |
||
entity |
string | Entity id; for recipes also the slug | |
via |
"app" | "mcp" | "import" |
Only changes made in the app, through Claude (mcp) or by an import | |
limit |
integer | Standaard 50. |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
items |
object[] | ja | |
items[].id |
string | ja | |
items[].entity_type |
"recipe" | "ingredient" | "product" | "location" | "device" | "company" |
ja | |
items[].entity_id |
string | ja | |
items[].op_name |
string | ja | |
items[].actor_type |
string | ja | |
items[].actor_id |
string | ja | |
items[].via |
"app" | "mcp" | "import" |
ja | |
items[].reason |
string | null | ja | |
items[].restored_from_id |
string | null | ja | |
items[].meta |
object | Standaard null. |
|
items[].meta |
object | Variant | |
items[].meta.suggestions |
object[] | Suggestions of Adorea accepted in this edit | |
items[].meta.suggestions[].title |
string | ja | |
items[].meta.commands |
object[] | Typed instructions Adorea carried out in this edit | |
items[].meta.commands[].title |
string | ja | |
items[].meta.recipe_version_id |
string | On a product changed in a recipe edit: that recipe version | |
items[].created_at |
string | ja | |
items[].actor_name |
string | null | ja | Member or device name, when it still exists |
items[].changes |
object[] | ja | What changed, from the before and after snapshots; empty for a creation |
items[].changes[].kind |
"line" | "step" | "field" |
ja | |
items[].changes[].label |
string | ja | Ingredient or component name, “stap 4”, or the field name |
items[].changes[].change |
"added" | "removed" | "changed" |
ja | |
items[].changes[].before |
string | number | boolean | null | ja | |
items[].changes[].after |
string | number | boolean | null | ja |
version_get
Section titled “version_get”Get one version with the full before and after, and for recipes the effect on dough, hydration and pieces.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
id |
string | ja |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
id |
string | ja | |
entity_type |
"recipe" | "ingredient" | "product" | "location" | "device" | "company" |
ja | |
entity_id |
string | ja | |
op_name |
string | ja | |
actor_type |
string | ja | |
actor_id |
string | ja | |
via |
"app" | "mcp" | "import" |
ja | |
reason |
string | null | ja | |
restored_from_id |
string | null | ja | |
meta |
object | Standaard null. |
|
meta |
object | Variant | |
meta.suggestions |
object[] | Suggestions of Adorea accepted in this edit | |
meta.suggestions[].title |
string | ja | |
meta.commands |
object[] | Typed instructions Adorea carried out in this edit | |
meta.commands[].title |
string | ja | |
meta.recipe_version_id |
string | On a product changed in a recipe edit: that recipe version | |
created_at |
string | ja | |
actor_name |
string | null | ja | Member or device name, when it still exists |
changes |
object[] | ja | What changed, from the before and after snapshots; empty for a creation |
changes[].kind |
"line" | "step" | "field" |
ja | |
changes[].label |
string | ja | Ingredient or component name, “stap 4”, or the field name |
changes[].change |
"added" | "removed" | "changed" |
ja | |
changes[].before |
string | number | boolean | null | ja | |
changes[].after |
string | number | boolean | null | ja | |
before |
any | ja | |
after |
any | ja | |
effect |
object | ja | For recipes: dough, flour, hydration and pieces before and after |
effect |
object | Variant | |
effect.before |
object | ja | |
effect.before |
object | Variant | |
effect.before.dough_total_g |
number | ja | |
effect.before.flour_total_g |
number | ja | |
effect.before.hydration_pct |
number | null | ja | |
effect.before.pieces |
object[] | ja | |
effect.before.pieces[].product_id |
string | ja | |
effect.before.pieces[].name |
string | ja | |
effect.before.pieces[].pieces_per_batch |
integer | null | ja | |
effect.after |
object | ja | |
effect.after.dough_total_g |
number | ja | |
effect.after.flour_total_g |
number | ja | |
effect.after.hydration_pct |
number | null | ja | |
effect.after.pieces |
object[] | ja | |
effect.after.pieces[].product_id |
string | ja | |
effect.after.pieces[].name |
string | ja | |
effect.after.pieces[].pieces_per_batch |
integer | null | ja |
version_restore
Section titled “version_restore”Put an entity back as it was at a version. Writes a new version; history is never overwritten.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
id |
string | ja | Version to go back to |
state |
"after" | "before" |
“after”: as it was right after that change. “before”: undo that change Standaard "after". |
|
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
any | ja | |
after |
any | ja | |
version_id |
string | ja |
Voorbeeld
Section titled “Voorbeeld”“before” undoes that change.
{ "id": "01JD3Y8Q2W5V7K9M1N3P5R7T9V", "state": "before", "reason": "Wijziging terugdraaien"}Documentatie
Section titled “Documentatie”docs_search
Section titled “docs_search”Search the documentation for how the app and the tools work. Returns matching sections with a link; read a whole page with docs_get.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
query |
string | ja | Words to look for, Dutch or English (tool names work too) |
limit |
integer | Standaard 8. |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
results |
object[] | ja | |
results[].slug |
string | ja | Page to read with docs_get |
results[].title |
string | ja | |
results[].heading |
string | null | ja | Section on the page, or null for its introduction |
results[].url |
string | ja | |
results[].snippet |
string | ja | |
results[].score |
number | ja |
Voorbeeld
Section titled “Voorbeeld”{ "query": "schalen naar aantal stuks"}docs_get
Section titled “docs_get”Get one documentation page as Markdown, with the list of all pages.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
slug |
string | ja | Page path from docs_search, e.g. “app/recepten”; “” is the home page |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
slug |
string | ja | |
title |
string | ja | |
description |
string | ja | |
url |
string | ja | |
text_url |
string | ja | The same page as plain text |
text |
string | ja | The page as Markdown |
pages |
object[] | ja | Every page, to find the next one to read |
pages[].slug |
string | ja | |
pages[].title |
string | ja |
Voorbeeld
Section titled “Voorbeeld”{ "slug": "concepten/grammen-en-percentages"}Overig
Section titled “Overig”device_list
Section titled “device_list”List the paired devices (bakery iPads), with their location and when they were last used.
Toegang: lezen read
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
include_revoked |
boolean | Standaard false. |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
items |
object[] | ja | |
items[].id |
string | ja | |
items[].location_id |
string | ja | |
items[].name |
string | ja | |
items[].paired_at |
string | ja | |
items[].last_seen_at |
string | null | ja | |
items[].revoked_at |
string | null | ja | |
items[].location_name |
string | ja |
device_create_pairing_code
Section titled “device_create_pairing_code”Create a one-time code to pair an iPad with a location. Valid 10 minutes; enter it on the iPad. Short-lived secret, so no version; the device it creates gets one.
Toegang: beheer admin
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
location |
string | Defaults to the caller’s location |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
code |
string | ja | Six characters to type on the iPad at /koppelen |
expires_at |
string | ja | |
location |
object | ja | |
location.id |
string | ja | |
location.name |
string | ja |
device_revoke
Section titled “device_revoke”Unpair a device. It loses access on its next request and has to be paired again with a new code.
Toegang: beheer admin
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
device |
string | ja | Device id |
reason |
string | Why this change is made; shown as “Waarom” in the version history |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
object | ja | |
before |
object | Variant | |
before.id |
string | ja | |
before.location_id |
string | ja | |
before.name |
string | ja | |
before.paired_at |
string | ja | |
before.last_seen_at |
string | null | ja | |
before.revoked_at |
string | null | ja | |
after |
object | ja | |
after.id |
string | ja | |
after.location_id |
string | ja | |
after.name |
string | ja | |
after.paired_at |
string | ja | |
after.last_seen_at |
string | null | ja | |
after.revoked_at |
string | null | ja | |
version_id |
string | ja |
company_settings_update
Section titled “company_settings_update”Change company settings, such as whether suggestions of Adorea are on in the recipe editor.
Toegang: beheer admin
Invoer
Section titled “Invoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
ai_suggestions |
boolean | “Voorstellen van Adorea” in the recipe editor; off hides the command bar and the suggestions, checks stay | |
suggest_model |
string | null | Model for suggestions instead of the default; “@test/fixed” answers the same every time (tests). null goes back to the default | |
reason |
string |
Uitvoer
Section titled “Uitvoer”| Veld | Type | Verplicht | Toelichting |
|---|---|---|---|
before |
record | ja | |
after |
record | ja | |
version_id |
string | ja |