Espresso dialing: log a shot, say how it tasted, get one change in your grinder's own clicks.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Compute a bag's age in days off roast and its resting/staling verdict, for the coffee's current bag by default or for the bag named.
A bag of that coffee (from list_beans' bags[]); null = its current bag
Compute a bag's age in days off roast and its resting/staling verdict, for the coffee's current bag by default or for the bag named.
| Argument | Type | Description |
|---|---|---|
| bag_id | integer | null | A bag of that coffee (from list_beans' bags[]); null = its current bag |
| bean_id* | integer |
{
"type": "object",
"required": [
"bean_id"
],
"properties": {
"bag_id": {
"type": [
"integer",
"null"
],
"description": "A bag of that coffee (from list_beans' bags[]); null = its current bag"
},
"bean_id": {
"type": "integer"
}
}
}Delete a logged shot from history. Restores the bean's remaining weight (which is derived from logged doses). Hard delete: there is no undo. To fix a mistake on an otherwise-valid shot, prefer update_shot over delete-and-relog.
| Argument | Type | Description |
|---|---|---|
| shot_id* | integer | ID of the shot to delete |
{
"type": "object",
"required": [
"shot_id"
],
"properties": {
"shot_id": {
"type": "integer",
"description": "ID of the shot to delete"
}
}
}Sandbox-only diagnosis, writes nothing (no verdict, no recommendation-trail entry). Two modes: pass shot_id to dry-run a LOGGED shot (optionally overriding its sensory_tags, for the "what would this read as?" preview; the shot's own bean and its age at pulled_at are used), or pass the full metric set (bean_id, grinder_id, machine_id, grind_label, dose_g, yield_g, time_s, source) for a hypothetical shot. Identical output shape to diagnose_shot, including bean_context.
| Argument | Type | Description |
|---|---|---|
| dose_g | number | Dose in grams |
| source | string | Grinder position source. Affects G1 warning (raw mode only) |
| time_s | number | Extraction time in seconds |
| bean_id | integer | Coffee bean ID (must belong to this account) |
| shot_id | integer | Preview a logged shot by ID (dry-run; ignores the metric params below) |
| yield_g | number | Yield in grams |
| grinder_id | integer | Grinder ID (must belong to this account) |
| machine_id | integer | Machine ID (must belong to this account) |
Evaluate shot metrics to provide ranked hypotheses (C6) and warn on flip-flops (G2) or fatigue (G6). Resolves the SHOT's own bean (age computed at the shot's pulled_at), never the active profile, and echoes it as bean_context, so diagnosing an older or differently-filed shot is always safe. The engine reads metrics and sensory tags, NOT free-text notes, so make sure taste feedback is recorded as sensory_tags on the shot (via log_shot or update_shot) before diagnosing; otherwise an in-range shot that tastes bad will come back "balanced".
| Argument | Type | Description |
|---|---|---|
| shot_id | integer | Optional shot ID; defaults to last pulled shot. |
{
"type": "object",
"properties": {
"shot_id": {
"type": "integer",
"description": "Optional shot ID; defaults to last pulled shot."
}
}
}Retrieve current dialing state, active context, recent shots, recommendations, and locked recipes.
No arguments.
{
"type": "object",
"properties": {}
}Retrieve the current version of the knowledge base.
No arguments.
{
"type": "object",
"properties": {}
}Step-by-step maintenance guides: tools, supplies, steps and warnings, in our own words with the maker's documents as sources. With no arguments, every guide for the user's current grinders and machines (and the water filter fitted in each). With guide_ids, those guides; the ids come from maintenance.tasks[].guide.id in list_grinders and list_machines. Ids that match no guide are listed under missing.
| Argument | Type | Description |
|---|---|---|
| guide_ids | array | Optional: the guides to fetch. Omit for every guide the user's equipment can use |
{
"type": "object",
"properties": {
"guide_ids": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 50,
"description": "Optional: the guides to fetch. Omit for every guide the user's equipment can use"
}
}
}Retrieve the detailed text of a specific rule from the knowledge base by its rule ID.
| Argument | Type | Description |
|---|---|---|
| rule_id* | string | The ID of the rule to fetch, e.g. CAT.DARK |
{
"type": "object",
"required": [
"rule_id"
],
"properties": {
"rule_id": {
"type": "string",
"description": "The ID of the rule to fetch, e.g. CAT.DARK"
}
}
}Get compact flat usage stats for a grinder, machine, or bean.
| Argument | Type | Description |
|---|---|---|
| id* | integer | The entity ID |
| scope* | string | The stats scope |
{
"type": "object",
"required": [
"scope",
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The entity ID"
},
"scope": {
"enum": [
"grinder",
"machine",
"bean"
],
"type": "string",
"description": "The stats scope"
}
}
}Determine steps/clicks difference and directions between setting labels (C3).
| Argument | Type | Description |
|---|---|---|
| to_label* | string | |
| from_label* | string | |
| grinder_id* | integer |
{
"type": "object",
"required": [
"grinder_id",
"from_label",
"to_label"
],
"properties": {
"to_label": {
"type": "string"
},
"from_label": {
"type": "string"
},
"grinder_id": {
"type": "integer"
}
}
}Retrieve the changelog showing updates and version differences for the knowledge base.
No arguments.
{
"type": "object",
"properties": {}
}List the coffees registered for the account, with status filter. Each coffee carries its bags[] (every purchase, with its own freshness and grams left) and current_bag_id; the row's top-level roast_date, state, grams_remaining and age fields are the current bag's. The `id` on each row is the number this account knows that coffee by, counting from 1: safe to show, and what other tools expect back; bag ids are a separate series.
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by status: current, archived, or all. Defaults to current. |
{
"type": "object",
"properties": {
"status": {
"enum": [
"current",
"archived",
"all"
],
"type": "string",
"description": "Filter by status: current, archived, or all. Defaults to current."
}
}
}List grinders registered for the account, with status filter. The `id` on each row is the number this account knows that record by, counting from 1: safe to show, and what other tools expect back. Each row carries its maintenance block: every task with its class (S schedule, H habit, Y symptom, A the machine signals it, T technician, N never, U unstated, E event), due state, and the guide to follow.
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by status: current, archived, or all. Defaults to current. |
| maintenance | string | How much of each row's maintenance block to include. compact (default): every task with its class, due state, schedule and guide. full: also the maker's own words (quote, source, alternates, the interval as written). |
{
"type": "object",
"properties": {
"status": {
"enum": [
"current",
"archived",
"all"
],
"type": "string",
"description": "Filter by status: current, archived, or all. Defaults to current."
},
"maintenance": {
"enum": [
"compact",
"full"
],
"type": "string",
"description": "How much of each row's maintenance block to include. compact (default): every task with its class, due state, schedule and guide. full: also the maker's own words (quote, source, alternates, the interval as written)."
}
}
}List machines registered for the account, with status filter. The `id` on each row is the number this account knows that record by, counting from 1: safe to show, and what other tools expect back. Each row carries its maintenance block, researched per model: every task with its class, due state, what the maker forbids, and the guide to follow. `settings` lists the selectors its model has and where each stands (null: unknown model, or none).
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by status: current, archived, or all. Defaults to current. |
| maintenance | string | How much of each row's maintenance block to include. compact (default): every task with its class, due state, schedule and guide. full: also the maker's own words (quote, source, alternates, the interval as written). |
{
"type": "object",
"properties": {
"status": {
"enum": [
"current",
"archived",
"all"
],
"type": "string",
"description": "Filter by status: current, archived, or all. Defaults to current."
},
"maintenance": {
"enum": [
"compact",
"full"
],
"type": "string",
"description": "How much of each row's maintenance block to include. compact (default): every task with its class, due state, schedule and guide. full: also the maker's own words (quote, source, alternates, the interval as written)."
}
}
}What maintenance is due across the user's current grinders and machines, most urgent first. Use it for "is anything due?". Only tasks with an interval compete: a task the machine counts and signals itself, one done by habit or when a symptom shows, and one the maker advises against never appear. Each item says how far along it is (ratio, done of every, on which basis), whether it is coming up (soon), and whether the interval is the user's, the maker's or ShotPulled's default.
| Argument | Type | Description |
|---|---|---|
| status | string | due (default): due or overdue, and not muted. all: every scheduled task, muted ones last |
{
"type": "object",
"properties": {
"status": {
"enum": [
"due",
"all"
],
"type": "string",
"description": "due (default): due or overdue, and not muted. all: every scheduled task, muted ones last"
}
}
}List recipes (all or filtered by equipment and status). The `id` on each row is the number this account knows that record by, counting from 1: safe to show, and what other tools expect back.
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by status: current, archived, or all. Defaults to current. |
| bean_id | integer | |
| grinder_id | integer | |
| machine_id | integer |
{
"type": "object",
"properties": {
"status": {
"enum": [
"current",
"archived",
"all"
],
"type": "string",
"description": "Filter by status: current, archived, or all. Defaults to current."
},
"bean_id": {
"type": "integer"
},
"grinder_id": {
"type": "integer"
},
"machine_id": {
"type": "integer"
}
}
}List registered scales for the account. The `id` on each row is the number this account knows that record by, counting from 1: safe to show, and what other tools expect back.
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by status: current (unarchived), archived, or all. Defaults to current. |
{
"type": "object",
"properties": {
"status": {
"enum": [
"current",
"archived",
"all"
],
"type": "string",
"description": "Filter by status: current (unarchived), archived, or all. Defaults to current."
}
}
}List shot history with support for pagination and filtering. Every shot carries a derived taste_pending flag (1 = logged with no sensory tags, no rating, and no tasted flip: the tasting is still owed and can be backfilled with update_shot).
| Argument | Type | Description |
|---|---|---|
| limit | integer | Number of records to return (1-500) |
| offset | integer | Offset for pagination |
| filters | object |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"default": 50,
"maximum": 500,
"minimum": 1,
"description": "Number of records to return (1-500)"
},
"offset": {
"type": "integer",
"default": 0,
"minimum": 0,
"description": "Offset for pagination"
},
"filters": {
"type": "object",
"properties": {
"best": {
"enum": [
0,
1
],
"type": "integer",
"description": "Filter by best brew status"
},
"bag_id": {
"type": "integer",
"description": "Filter by bag number (one purchase of a coffee)"
},
"bean_id": {
"type": "integer",
"description": "Filter by coffee bean ID"
},
"date_to": {
"type": "string",
"description": "Filter shots pulled on or before YYYY-MM-DD"
},
"date_from": {
"type": "string",
"description": "Filter shots pulled on or after YYYY-MM-DD"
},
"favourite": {
"enum": [
0,
1
],
"type": "integer",
"description": "Filter by favourite status"
},
"grinder_id": {
"type": "integer",
"description": "Filter by grinder ID"
},
"machine_id": {
"type": "integer",
"description": "Filter by machine ID"
},
"taste_pending": {
"enum": [
0,
1
],
"type": "integer",
"description": "1 = shots logged without sensory tags, a rating, or the tasted flip (tasting still owed); 0 = tasted shots"
}
}
}
}
}List registered waters for the account. The `id` on each row is the number this account knows that record by, counting from 1: safe to show, and what other tools expect back.
| Argument | Type | Description |
|---|---|---|
| status | string | Filter by status: current (unarchived), archived, or all. Defaults to current. |
{
"type": "object",
"properties": {
"status": {
"enum": [
"current",
"archived",
"all"
],
"type": "string",
"description": "Filter by status: current (unarchived), archived, or all. Defaults to current."
}
}
}Lock a successful shot as the reference dialing recipe for this equipment profile. It overwrites the recipe already locked for the same coffee, grinder, machine, program and drink intent, which keeps its recipe_id.
| Argument | Type | Description |
|---|---|---|
| drink_intent* | string | |
| from_shot_id* | integer |
{
"type": "object",
"required": [
"from_shot_id",
"drink_intent"
],
"properties": {
"drink_intent": {
"enum": [
"straight",
"milk"
],
"type": "string"
},
"from_shot_id": {
"type": "integer"
}
}
}Log a cleaning or maintenance job against a piece of equipment. A task that takes the thing apart opens a calibration epoch, and every recipe locked before it is read through that epoch's offset. Record the offset here if you counted the clicks while reassembling, which is the one moment anybody actually knows it. Any task in the maintenance vocabulary can be logged against a grinder or machine it belongs to, including one the maker advises against, because the log records what was done. Read each piece of equipment's tasks, their intervals and their due state from list_grinders and list_machines.
| Argument | Type | Description |
|---|---|---|
| note | string | Optional: what you did, and anything that surprised you |
| task* | string | Which maintenance job was performed |
| details | object | Fields specific to this task. Which ones a task takes is published as details_fields on each task; a burr clean takes none |
| evidence | string | One line recording what the measurement rested on, e.g. "Counted 6 clicks coarser at reassembly." |
| guide_id | string | Optional: the id of the maintenance guide that was followed. Must be a guide for this task |
| equipment_id* | integer | The ID of that piece of equipment |
| offset_value | number |
Log a recommended dialing change to allow contradiction/oscillation checking (G2).
| Argument | Type | Description |
|---|---|---|
| lever* | string | |
| direction* | string | |
| rationale* | string | |
| confidence* | string | |
| cited_rules | array | |
| based_on_shot | integer |
{
"type": "object",
"required": [
"lever",
"direction",
"rationale",
"confidence"
],
"properties": {
"lever": {
"enum": [
"grind",
"yield",
"temp",
"program",
"prep",
"none"
],
"type": "string"
},
"direction": {
"enum": [
"finer",
"coarser",
"more",
"less",
"same"
],
"type": "string"
},
"rationale": {
"type": "string"
},
"confidence": {
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
"cited_rules": {
"type": "array",
"items": {
"type": "string"
}
},
"based_on_shot": {
"type": "integer"
}
}
}Log an espresso or alternative shot/brew attempt. Uses the active context (bean/grinder/machine/program) unless overridden via bean_id/grinder_id/machine_id/program_id. ALWAYS pass bean_id explicitly when the user names a specific coffee, so the shot cannot land on the wrong bag. Backdate with pulled_at when the shot happened earlier. When the user reports taste (bitter, sour, harsh, hollow…), include matching sensory_tags: the diagnosis engine reads tags and metrics, not free-text flavor_notes. When the user tasted the shot and reports it as GOOD/clean (no defects), pass tasted=1 with no sensory_tags. Otherwise a tag-less, rating-less shot is filed taste-pending as if never tasted.
| Argument | Type | Description |
|---|---|---|
| tds | number | Total Dissolved Solids percentage (e.g. 9.1 or 1.35) |
| bag_id | integer | null | Which bag of the coffee the shot came from; defaults to its current (open) bag. Bag numbers are on list_beans' bags[] |
| dose_g* | number | |
| rating | integer | |
| tasted | integer | 1 = the shot was tasted at log time. The explicit way to record a CLEAN tasting: sensory tags all describe defects, so a good shot has none. Without this flag (or a rating) it would be filed taste-pending. Tags or a rating also mark a shot as tasted; 0 (default) = taste later. |
| time_s* | number | |
| bean_id |
Fold one coffee into another when the same coffee was registered twice. Every bag, shot, recipe and recommendation of from_bean_id moves to into_bean_id; the active coffee follows if it was the one merged away; origins move only if the target has none. Where both hold a locked recipe for the same grinder, machine, program and drink, the newer lock wins and the older is deleted. The source coffee is archived, never deleted. Irreversible: confirm both numbers with the user first (list_beans shows them).
| Argument | Type | Description |
|---|---|---|
| reason | string | Optional note, recorded on the surviving coffee's notes with the merge |
| from_bean_id* | integer | The duplicate: the coffee number that will be emptied and archived |
| into_bean_id* | integer | The coffee number that keeps everything |
{
"type": "object",
"required": [
"from_bean_id",
"into_bean_id"
],
"properties": {
"reason": {
"type": "string",
"description": "Optional note, recorded on the surviving coffee's notes with the merge"
},
"from_bean_id": {
"type": "integer",
"description": "The duplicate: the coffee number that will be emptied and archived"
},
"into_bean_id": {
"type": "integer",
"description": "The coffee number that keeps everything"
}
}
}Register another bag of a coffee that is already in list_beans: the same roaster's product, bought again. It keeps the coffee's recipes, notes and history; only the purchase facts (roast date, weight, price, state) are new. Does not change the active coffee. Returns a bag_id: bag numbers are their own series, separate from bean numbers. For a coffee that is not in list_beans yet, call register_coffee instead.
| Argument | Type | Description |
|---|---|---|
| ean | string | |
| cost | number | |
| state | string | Defaults to sealed; the first log_shot against it opens it |
| bean_id* | integer | This account's own coffee number, from list_beans. Never guess one. |
| qr_code | string | |
| storage | string | |
| buy_date | string | Calendar day in YYYY-MM-DD format: a day, not a timestamp |
| currency | string | |
| bag_notes | string | Notes about THIS bag (a batch note, where it was bought). The coffee's own description lives on the coffee, in notes. |
Register a coffee that is NOT yet in list_beans, together with its first bag. It does not switch a coffee in use: it becomes active only when no coffee is in use (none active, or the active one archived or with every bag finished); otherwise call set_active with its bean_id when the user starts brewing it. The `active` field of the reply says which. The coffee is the roaster's product (roaster, origins, variety, process, roast level, roasting type, cupping score, aromatics, roaster notes, rest window); the bag is this purchase (roast date, weight, price, state). For another bag of a coffee already on file call register_bag instead: it keeps the recipes and notes. Returns bean_id and the first bag's bag_id.
| Argument | Type | Description |
|---|---|---|
| ean | string | |
| url | string | |
| body | string | Free text; roasters usually say low, medium or high |
| cost | number | |
| name* | string | |
| notes | string | The coffee's own description: the roaster's tasting notes, the dialing approach that worked. Per bag notes go in bag_notes. |
| state | string | |
| origin | string | |
Register a manual or electric grinder with its dial settings scheme. It becomes the active grinder only when no grinder is in use (none active, or the active one archived); otherwise call set_active with its grinder_id to switch to it. The `active` field of the reply says which.
| Argument | Type | Description |
|---|---|---|
| name* | string | The name/model of the grinder, e.g. Kinu M47 |
| notes | string | Additional notes |
| photo | string | Photo path or URL |
| archived | integer | 1 if archived, 0 if active |
| burr_type* | string | |
| max_value | number | null | Optional travel max bounds |
| min_value | number | null | Optional travel min bounds |
| catalog_id | string | Optional: the maintenance catalog model this is (the `id` of a catalog row, e.g. rancilio-silvia), when it was registered from the catalog. Its maintenance then comes from that model's researched record. "none" says it is not in the catalog. |
| motor_type* |
Register an espresso or alternative preparation machine. It becomes the active machine only when no machine is in use (none active, or the active one archived); otherwise call set_active with its machine_id to switch to it. The `active` field of the reply says which.
| Argument | Type | Description |
|---|---|---|
| name* | string | Machine name/model, e.g. Dedica EC685 |
| notes | string | |
| photo | string | Photo path or URL |
| tools | string | null | JSON or comma-separated tools, e.g., paper filters, flow control, metal mesh |
| archived | integer | 1 if archived, 0 if active |
| prep_type | string | Preparation equipment type. One of: espresso_machine, lever_press, moka_pot, aeropress, french_press, v60_dripper, cold_brew. Lower snake_case. |
| catalog_id | string | Optional: the maintenance catalog model this is (the `id` of a catalog row, e.g. rancilio-silvia), when it was registered from the catalog. Its maintenance then comes from that model's researched record. "none" says it is not in the catalog. |
| prep_style | string | Preparation style. One of: espresso, filter, immersion, percolation. Only "espresso" is diagnosed by the dialing engine (G8). Anything else is recorded but never dialed, so do not guess this field. |
Register a programmed shot button on a machine. A program cuts the shot off either by weight (program_type "volumetric", set target_volume_g) or by time (program_type "timed", set target_time_s). One machine can have a mix of both. A program_number the machine already has is overwritten with these settings; shots logged on it keep pointing at it.
| Argument | Type | Description |
|---|---|---|
| machine_id* | integer | |
| description | string | null | |
| program_type | string | Cutoff method: "volumetric" (weight) or "timed" (duration). Defaults to volumetric. |
| target_time_s | number | null | Target shot duration cutoff in seconds (required for timed programs) |
| volume_source | string | Confidence in the stored cutoff value, for either type |
| program_number* | integer | Program number / button index (e.g. 1 or 2) |
| target_volume_g | number | null | Target yield cutoff in grams (required for volumetric programs) |
Register a brewing scale: the instrument that weighs the dose and the yield.
| Argument | Type | Description |
|---|---|---|
| name* | string | Scale name/model, e.g. Acaia Lunar, Timemore Black Mirror Basic 2 |
| notes | string | Additional notes |
| power | string | How it is powered or recharged |
| depth_mm | number | null | Platform depth in mm |
| width_mm | number | null | Platform width in mm. Measure your drip tray |
| auto_tare | integer | null | 1 if it zeroes itself when a vessel is set down, 0 if not, null if unstated |
| height_mm | number | null | Overall height in mm: the dimension that decides whether it fits under a group head |
| auto_timer | integer | null | 1 if the timer starts on first flow, 0 if not, null if unstated |
| capacity_g | number | null | Maximum weight in grams. The cup or portafilter counts against it |
| scale_type |
Register a custom or commercial water formulation.
| Argument | Type | Description |
|---|---|---|
| gh | number | null | General hardness (GH) in ppm |
| kh | number | null | Karbonate hardness (KH) in ppm |
| tds | number | null | TDS in ppm |
| name* | string | Water formulation name, e.g. Lotus Light & Bright, Third Wave Water |
| type | string | Type, e.g., mineralized, tap, distilled, RO |
| notes | string | Additional notes |
| sodium | number | null | Sodium concentration in ppm |
| calcium | number | null | Calcium concentration in ppm |
| magnesium | number | null | Magnesium concentration in ppm |
{
"type": "object",
"required": [
"name"
],
"properties": {
"gh": {
"type": [
"number",
"null"
],
"description": "General hardness (GH) in ppm"
},
"kh": {
"type": [
"number",
"null"
],
"description": "Karbonate hardness (KH) in ppm"
},
"tds": {
"type": [
"number",
"null"
],
"description": "TDS in ppm"
},
"name": {
"type": "string",
"description": "Water formulation name, e.g. Lotus Light & Bright, Third Wave Water"
},
"type": {
"type": "string",
"description": "Type, e.g., mineralized, tap, distilled, RO"
},
"notes": {
"type": "string",
"description": "Additional notes"
},
"sodium": {
"type": [
"number",
"null"
],
"description": "Sodium concentration in ppm"
},
"calcium": {
"type": [
"number",
"null"
],
"description": "Calcium concentration in ppm"
},
"magnesium": {
"type": [
"number",
"null"
],
"description": "Magnesium concentration in ppm"
}
}
}Switch the active bean, grinder or machine for this account. The numbers come from list_beans, list_grinders and list_machines. Registering a coffee, grinder or machine makes it active only when nothing of that kind is in use (the `active` field of the reply says which), so call this to start using something new as well as to switch back.
| Argument | Type | Description |
|---|---|---|
| bean_id | integer | null | This account's own bean number, as returned by list_beans. Never guess one; null = leave unchanged |
| grinder_id | integer | null | This account's own grinder number, as returned by list_grinders. Never guess one; null = leave unchanged |
| machine_id | integer | null | This account's own machine number, as returned by list_machines. Never guess one; null = leave unchanged |
| program_id | integer | null | A program number from the active machine's list; switching machines clears it. null = leave unchanged |
{
"type": "object",
"properties": {
"bean_id": {
"type": [
"integer",
"null"
],
"description": "This account's own bean number, as returned by list_beans. Never guess one; null = leave unchanged"
},
"grinder_id": {
"type": [
"integer",
"null"
],
"description": "This account's own grinder number, as returned by list_grinders. Never guess one; null = leave unchanged"
},
"machine_id": {
"type": [
"integer",
"null"
],
"description": "This account's own machine number, as returned by list_machines. Never guess one; null = leave unchanged"
},
"program_id": {
"type": [
"integer",
"null"
],
"description": "A program number from the active machine's list; switching machines clears it. null = leave unchanged"
}
}
}Archive or restore a grinder, machine, water, or scale.
| Argument | Type | Description |
|---|---|---|
| id* | integer | The ID of the equipment |
| kind* | string | The kind of equipment to archive/restore |
| archived* | integer | 1 to archive, 0 to restore |
{
"type": "object",
"required": [
"kind",
"id",
"archived"
],
"properties": {
"id": {
"type": "integer",
"description": "The ID of the equipment"
},
"kind": {
"enum": [
"grinder",
"machine",
"water",
"scale"
],
"type": "string",
"description": "The kind of equipment to archive/restore"
},
"archived": {
"enum": [
0,
1
],
"type": "integer",
"description": "1 to archive, 0 to restore"
}
}
}Set the current grinder collar position. source="measured" resets verification freshness. It replaces the stored position; no history of earlier positions is kept.
| Argument | Type | Description |
|---|---|---|
| source* | string | Whether setting is verified ("measured") or guess ("recalled"/"assumed") |
| grinder_id* | integer | |
| setting_label* | string | Verbatim display label, e.g. "1.1.2" |
{
"type": "object",
"required": [
"grinder_id",
"setting_label",
"source"
],
"properties": {
"source": {
"enum": [
"measured",
"recalled",
"assumed"
],
"type": "string",
"description": "Whether setting is verified (\"measured\") or guess (\"recalled\"/\"assumed\")"
},
"grinder_id": {
"type": "integer"
},
"setting_label": {
"type": "string",
"description": "Verbatim display label, e.g. \"1.1.2\""
}
}
}Record how far a maintenance job moved the reference, on an entry that opened a calibration epoch. Takes an ENTRY, not a piece of equipment: the offset belongs to the event that caused it, which is what lets several of them compose for a recipe locked before all of them. Zero is a legitimate measurement and means "measured, and it had not moved". Omit offset_value entirely to clear it back to unmeasured.
| Argument | Type | Description |
|---|---|---|
| source | string | How it was arrived at: pull, counted, or typed |
| entry_id* | integer | The maintenance entry that opened the epoch, from list_grinders |
| evidence | string | One line recording what it rested on, e.g. "Reference pull 1.38 g/s against 1.74 g/s locked." |
| offset_value | number | Clicks to ADD to a pre-clean reading to get the same grind today, signed along the collar's own number direction. 0 records "unchanged"; omit to clear the measurement |
{
"type": "object",
"required": [
"entry_id"
],
"properties": {
"source": {
"enum": [
"pull",
"counted",
"typed"
],
"type": "string",
"description": "How it was arrived at: pull, counted, or typed"
},
"entry_id": {
"type": "integer",
"description": "The maintenance entry that opened the epoch, from list_grinders"
},
"evidence": {
"type": "string",
"description": "One line recording what it rested on, e.g. \"Reference pull 1.38 g/s against 1.74 g/s locked.\""
},
"offset_value": {
"type": "number",
"description": "Clicks to ADD to a pre-clean reading to get the same grind today, signed along the collar's own number direction. 0 records \"unchanged\"; omit to clear the measurement"
}
}
}Set the user's own schedule for one maintenance task on one grinder or machine: their own interval, switching it off, or muting the reminder until a date. Only the keys you send in fields change; send every: null to go back to the maker's guidance and muted_until: null to unmute. Use it when the user states how often they do a task or asks to be left alone about one, never to invent an interval. The task's class, interval and due state are read back from list_grinders and list_machines.
| Argument | Type | Description |
|---|---|---|
| task* | string | The task, as its value in that equipment's maintenance.tasks |
| fields | object | |
| changed_at | string | Optional: when the user made this change (ISO 8601, UTC). An app sending a queued edit passes it, so an older edit never overwrites a newer one; it is then answered with applied: false |
| equipment_id* | integer | This account's own grinder or machine number, from list_grinders or list_machines |
| equipment_kind* | string | Which kind of equipment the task is on |
{
"type": "object",
"required": [
"equipment_kind",
"equipment_id",
"task"
],
"properties": {
"task": {
"enum": [
"burr_clean",
"backflush_water",
"backflush_detergent",
"descale",
"group_gasket_replace",
"shower_screen_clean",
"shower_screen_replace",
"group_head_wipe",
"basket_portafilter_soak",
"steam_wand_purge",
"steam_wand_soak",
"drip_tray_clean",
"water_tank_clean",
"water_filter_replace",
"boiler_water_change",
"lever_piston_seal_replace",
"lever_lubricate",
"milk_system_clean",
"professional_service",
"builtin_grinder_burr_clean",
"builtin_grinder_burr_replace",
"grinder_quick_clean",
"grinder_cleaning_tablets",
"burr_replace",
"hopper_clean",
"grounds_cup_clean",
"bearing_lubricate",
"gasket_seal_replace",
"idle_rinse",
"water_wash",
"dishwasher",
"filter_prime",
"softener_regenerate",
"other"
],
"type": "string",
"description": "The task, as its value in that equipment's maintenance.tasks"
},
"fields": {
"type": "object",
"properties": {
"every": {
"type": [
"object",
"null"
],
"properties": {
"days": {
"type": [
"number",
"null"
],
"description": "Whole days"
},
"grams": {
"type": [
"number",
"null"
],
"description": "Grams of coffee through a grinder"
},
"shots": {
"type": [
"number",
"null"
],
"description": "Whole shots"
},
"litres": {
"type": [
"number",
"null"
],
"description": "Litres through a machine's group"
}
},
"description": "The user's interval: whichever basis arrives first makes it due. A grinder counts days, shots and grams; a machine days, shots and litres. null returns to the maker's guidance"
},
"enabled": {
"type": "boolean",
"description": "false sets the user's interval aside (the maker's applies again) without forgetting it"
},
"muted_until": {
"type": [
"string",
"null"
],
"description": "Silence the reminder until this date or time (ISO 8601, UTC); null unmutes"
}
}
},
"changed_at": {
"type": "string",
"description": "Optional: when the user made this change (ISO 8601, UTC). An app sending a queued edit passes it, so an older edit never overwrites a newer one; it is then answered with applied: false"
},
"equipment_id": {
"type": "integer",
"description": "This account's own grinder or machine number, from list_grinders or list_machines"
},
"equipment_kind": {
"enum": [
"grinder",
"machine"
],
"type": "string",
"description": "Which kind of equipment the task is on"
}
}
}Retrieve the single next experiment step from the reasoning engine.
| Argument | Type | Description |
|---|---|---|
| bean_id* | integer |
{
"type": "object",
"required": [
"bean_id"
],
"properties": {
"bean_id": {
"type": "integer"
}
}
}Change bag-level facts on one bag of a coffee: open, seal, freeze, thaw or finish it, correct its roast date, weight, grams left or price. Bag numbers come from the bags[] on list_beans (or current_bag_id). For the coffee itself (roaster, origin, roast level, rest window, notes), use update_bean.
| Argument | Type | Description |
|---|---|---|
| bag_id* | integer | This account's own bag number, from list_beans' bags[]. Never guess one. |
| fields* | object | |
| reason | string | Optional free-text note, appended to this bag's notes as an ordinary line. Omit it and nothing is written. |
{
"type": "object",
"required": [
"bag_id",
"fields"
],
"properties": {
"bag_id": {
"type": "integer",
"description": "This account's own bag number, from list_beans' bags[]. Never guess one."
},
"fields": {
"type": "object",
"properties": {
"ean": {
"type": "string"
},
"cost": {
"type": "number"
},
"state": {
"enum": [
"sealed",
"open",
"frozen",
"finished"
],
"type": "string"
},
"qr_code": {
"type": "string"
},
"storage": {
"type": "string"
},
"buy_date": {
"type": "string",
"description": "Calendar day in YYYY-MM-DD format: a day, not a timestamp"
},
"currency": {
"type": "string"
},
"finished": {
"type": "integer",
"description": "1 if finished, 0 otherwise"
},
"bag_notes": {
"type": "string",
"maxLength": 4096
},
"frozen_at": {
"type": "string",
"description": "Calendar day the bag went into the freezer, YYYY-MM-DD: a day, not a timestamp"
},
"roast_date": {
"type": "string",
"description": "Calendar day in YYYY-MM-DD format: a day, not a timestamp"
},
"frozen_note": {
"type": "string"
},
"opened_date": {
"type": "string",
"description": "Calendar day in YYYY-MM-DD format: a day, not a timestamp"
},
"unfrozen_at": {
"type": "string",
"description": "Calendar day the bag came out, YYYY-MM-DD: a day, not a timestamp"
},
"bag_weight_g": {
"type": "number",
"description": "Bag weight in grams"
},
"best_by_date": {
"type": "string",
"description": "Calendar day in YYYY-MM-DD format: a day, not a timestamp"
},
"frozen_storage": {
"type": "string"
},
"grams_remaining": {
"type": "number",
"description": "Override the computed grams left in the bag (weigh the bag, set what is actually there). Translated into weight_adjustment_g so bag_weight_g keeps recording the true bag size. 0 marks the bag finished; a positive value on a finished bag un-finishes it."
},
"weight_adjustment_g": {
"type": "number",
"description": "Grams consumed or lost OUTSIDE logged shots (spillage, unlogged brews). grams_remaining = bag_weight_g − logged doses − this. Negative adds weight back."
}
}
},
"reason": {
"type": "string",
"description": "Optional free-text note, appended to this bag's notes as an ordinary line. Omit it and nothing is written."
}
}
}Update a coffee's own fields (roaster, origins, roast level, rest window, notes, rating…). Bag-shaped fields sent here (state, roast_date, bag_weight_g, grams_remaining, cost…) land on the coffee's CURRENT bag. Use update_bag when it has more than one. Changing dial_category changes what the engine advises (G5, C10), so say why in the optional note.
| Argument | Type | Description |
|---|---|---|
| fields* | object | |
| reason | string | Optional free-text note, appended as an ordinary line to the coffee's notes, or to the current bag's bag_notes when the call changed only bag fields. Omit it and nothing is written. |
| bean_id* | integer |
{
"type": "object",
"required": [
"bean_id",
"fields"
],
"properties": {
"fields": {
"type": "object",
"properties": {
"ean": {
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string",
"description": "Free text; roasters usually say low, medium or high"
},
"cost": {
"type": "number"
},
"name": {
"type": "string"
},
"notes": {
"type": "string",
"maxLength": 4096,
"description": "The coffee's own description: roaster tasting notes, the dialing approach. Replaces the stored value; the optional reason is appended instead."
},
"state": {
"enum": [
"sealed",
"open",
"frozen",
"finished"
],
"type": "string"
},
"origin": {
"type": "string"
},
"rating": {
"type": "integer",
"maximum": 5,
"minimum": 0,
"description": "1-5 stars; 0 clears the rating (unrated)"
},
"acidity": {
"type": "string",
"description": "Free text; roasters usually say low, medium or high"
},
"co2e_kg": {
"type": "number"
},
"origins": {
"type": "array",
"items": {
"type": "object",
"properties": {
"farm": {
"type": "string"
},
"farmer": {
"type": "string"
},
"region": {
"type": "string"
},
"country": {
"type": "string"
},
"harvest": {
"type": "string"
},
"variety": {
"type": "string"
},
"percentage": {
"type": "number"
},
"processing": {
"type": "string"
},
"elevation_m": {
"type": "number"
},
"elevation_max_m": {
"type": "number",
"description": "Upper end of an elevation range; elevation_m is the lower end"
}
}
},
"description": "List of bean origin details"
},
"qr_code": {
"type": "string"
},
"roaster": {
"type": "string"
},
"storage": {
"type": "string"
},
"variety": {
"type": "string"
},
"archived": {
"type": "integer",
"description": "1 if archived, 0 otherwise"
},
"bean_mix": {
"type": "string",
"description": "E.g. blend details"
},
"buy_date": {
"type": "string",
"description": "Calendar day in YYYY-MM-DD format: a day, not a timestamp"
},
"currency": {
"type": "string"
},
"finished": {
"type": "integer",
"description": "1 if finished, 0 otherwise"
},
"aromatics": {
"type": "string",
"maxLength": 1024
},
"bag_notes": {
"type": "string",
"maxLength": 4096
},
"favourite": {
"type": "integer",
"description": "1 if favourite, 0 otherwise"
},
"frozen_at": {
"type": "string",
"description": "Calendar day the bag went into the freezer, YYYY-MM-DD: a day, not a timestamp"
},
"sweetness": {
"type": "string",
"description": "Free text; roasters usually say low, medium or high"
},
"roast_date": {
"type": "string",
"description": "Calendar day in YYYY-MM-DD format: a day, not a timestamp"
},
"arabica_pct": {
"type": "number",
"maximum": 100,
"minimum": 0
},
"attachments": {
"type": "string",
"maxLength": 1024,
"description": "JSON or comma-separated list of attachments"
},
"frozen_note": {
"type": "string"
},
"opened_date": {
"type": "string",
"description": "Calendar day in YYYY-MM-DD format: a day, not a timestamp"
},
"roast_level": {
"enum": [
"ultra-light",
"light",
"medium",
"medium-dark",
"dark"
],
"type": "string"
},
"roast_range": {
"type": "string"
},
"unfrozen_at": {
"type": "string",
"description": "Calendar day the bag came out, YYYY-MM-DD: a day, not a timestamp"
},
"bag_weight_g": {
"type": "number",
"description": "Bag weight in grams"
},
"best_by_date": {
"type": "string",
"description": "Calendar day in YYYY-MM-DD format: a day, not a timestamp"
},
"process_type": {
"enum": [
"washed",
"natural",
"honey",
"anaerobic",
"aerobic-extended",
"co-fermented",
"bioreactor",
"other"
],
"type": "string"
},
"roast_custom": {
"type": "string"
},
"decaffeinated": {
"type": "integer",
"description": "1 if decaf, 0 if regular"
},
"dial_category": {
"enum": [
"nordic-light",
"ultra-light",
"classic",
"processed",
"dark",
"aged"
],
"type": "string",
"description": "Dialing behavior class: classic = medium/traditional espresso roasts (chocolate/nut, balanced); dark = genuinely dark/roasty; the light categories cover Nordic and ultra-light styles."
},
"roasting_type": {
"enum": [
"filter",
"espresso",
"omni"
],
"type": "string"
},
"cupping_points": {
"type": "number"
},
"frozen_storage": {
"type": "string"
},
"grams_remaining": {
"type": "number",
"description": "Override the computed grams left in the bag (weigh the bag, set what is actually there). Translated into weight_adjustment_g so bag_weight_g keeps recording the true bag size. 0 marks the bag finished; a positive value on a finished bag un-finishes it."
},
"weight_adjustment_g": {
"type": "number",
"description": "Grams consumed or lost OUTSIDE logged shots (spillage, unlogged brews). grams_remaining = bag_weight_g − logged doses − this. To force remaining to a known value X, set this to bag_weight_g − logged doses − X. Negative adds weight back."
},
"rest_window_days_max": {
"type": "integer"
},
"rest_window_days_min": {
"type": "integer"
}
}
},
"reason": {
"type": "string",
"description": "Optional free-text note, appended as an ordinary line to the coffee's notes, or to the current bag's bag_notes when the call changed only bag fields. Omit it and nothing is written."
},
"bean_id": {
"type": "integer"
}
}
}Correct a registered grinder: its name, burrs, collar scheme, nominal step, layout, range or notes. Only the keys you send in fields change; send null to clear an optional field (an empty string also clears a text field, but not a number or a closed list). Required fields can be changed but not cleared. fields may be omitted when only reason is sent. setting_scheme, nominal_step and components_spec describe the collar every recorded grind label is read through: call with dry_run first to see which recorded settings would read as a different position, and tell the user before saving. Saving records the change in the grinder's maintenance history; when a locked recipe's setting moves it also opens an unmeasured calibration epoch (set_maintenance_offset resolves it). The collar's current setting is marked assumed when it reads differently, or cleared when the new collar cannot read it, and measured offsets are converted when a click changes worth. Changing direction_convention is a correction: it moves no number, but every finer/coarser said about this grinder was the wrong way round.
| Argument | Type | Description |
|---|---|---|
| fields | object | |
| reason | string | Optional note, appended to this record's own notes as an ordinary line. Omit it and nothing is written. |
| dry_run | boolean | true: write nothing, and answer with what the edit would do to the settings already recorded (moved[], checked, epoch, position_moved, position_cleared, rescaled_offsets, resigned_offsets, step_ignored, direction_flipped, recipe_count) |
| grinder_id* | integer | This account's own grinder number, from list_grinders. Never guess one. |
Correct a registered machine (its name, control type, prep type and style, basket, boiler, accessories or notes), or record where its selectors stand (settings). Only the keys you send in fields change; send null to clear an optional field (an empty string also clears a text field, but not a number or a closed list). Required fields can be changed but not cleared. fields may be omitted when only reason is sent. prep_style decides whether shots on this machine are diagnosed at all: only "espresso" is. Programs are edited with register_program, the built-in grinder link is not editable here, and archiving is set_equipment_archived.
| Argument | Type | Description |
|---|---|---|
| fields | object | |
| reason | string | Optional note, appended to this record's own notes as an ordinary line. Omit it and nothing is written. |
| machine_id* | integer | This account's own machine number, from list_machines. Never guess one. |
{
"type": "object",
"required": [
"machine_id"
],
"properties": {
"fields": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"notes": {
"type": [
"string",
"null"
]
},
"photo": {
"type": [
"string",
"null"
]
},
"tools": {
"type": [
"string",
"null"
],
"description": "Comma-separated accessories. list_machines reads them back as tools_list"
},
"settings": {
"type": [
"object",
"null"
],
"description": "Where the machine's selectors now stand, as {key: position} from list_machines settings, e.g. {\"brew_temperature\": \"ii\"}. Only the keys given change; a null position clears one, null clears all. Shots are stamped with these."
},
"prep_type": {
"type": "string",
"description": "One of: espresso_machine, lever_press, moka_pot, aeropress, french_press, v60_dripper, cold_brew."
},
"catalog_id": {
"type": [
"string",
"null"
],
"description": "The maintenance catalog model this machine is; \"none\" if it is not listed; null to unbind. list_machines proposes one from the name under maintenance.catalog.match"
},
"prep_style": {
"type": "string",
"description": "One of: espresso, filter, immersion, percolation. Only \"espresso\" is diagnosed by the dialing engine (G8)."
},
"boiler_type": {
"type": [
"string",
"null"
]
},
"hardness_dh": {
"type": [
"number",
"null"
],
"description": "The total hardness (GH) of the water this machine runs on, in °dH; null to fall back to the water of its last shot"
},
"control_type": {
"enum": [
"volumetric",
"manual",
"lever"
],
"type": "string"
},
"connected_device": {
"type": [
"string",
"null"
]
},
"basket_size_grams": {
"type": [
"number",
"null"
]
}
}
},
"reason": {
"type": "string",
"description": "Optional note, appended to this record's own notes as an ordinary line. Omit it and nothing is written."
},
"machine_id": {
"type": "integer",
"description": "This account's own machine number, from list_machines. Never guess one."
}
}
}Correct a registered scale: its type, resolution, capacity, capabilities, build or notes. Only the keys you send in fields change; send null to clear an optional field (an empty string also clears a text field, but not a number or a closed list). Required fields can be changed but not cleared. fields may be omitted when only reason is sent. The three capabilities are 1, 0, or null for "the maker never said"; leave one out rather than sending 0 when nobody knows.
| Argument | Type | Description |
|---|---|---|
| fields | object | |
| reason | string | Optional note, appended to this record's own notes as an ordinary line. Omit it and nothing is written. |
| scale_id* | integer | This account's own scale number, from list_scales. Never guess one. |
{
"type": "object",
"required": [
"scale_id"
],
"properties": {
"fields": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"notes": {
"type": [
"string",
"null"
]
},
"power": {
"enum": [
"usb_c",
"micro_usb",
"aa",
"aaa",
"mains",
null
],
"type": [
"string",
"null"
]
},
"depth_mm": {
"type": [
"number",
"null"
]
},
"width_mm": {
"type": [
"number",
"null"
]
},
"auto_tare": {
"type": [
"integer",
"null"
]
},
"height_mm": {
"type": [
"number",
"null"
]
},
"auto_timer": {
"type": [
"integer",
"null"
]
},
"capacity_g": {
"type": [
"number",
"null"
]
},
"scale_type": {
"enum": [
"espresso",
"brew",
"dual",
"connected",
"dosing",
"training",
"bench"
],
"type": "string"
},
"connectivity": {
"enum": [
"none",
"bluetooth",
"usb",
"bluetooth_usb",
null
],
"type": [
"string",
"null"
]
},
"resolution_g": {
"type": [
"number",
"null"
]
},
"water_resistance": {
"type": [
"string",
"null"
]
},
"flow_rate_display": {
"type": [
"integer",
"null"
]
},
"resolution_banded": {
"type": [
"integer",
"null"
],
"description": "1 when resolution_g only holds in the lowest weight band"
}
}
},
"reason": {
"type": "string",
"description": "Optional note, appended to this record's own notes as an ordinary line. Omit it and nothing is written."
},
"scale_id": {
"type": "integer",
"description": "This account's own scale number, from list_scales. Never guess one."
}
}
}Correct fields on an already-logged shot in place, with no need to delete and re-log. Use for fixing a wrong dose/yield/time or grind label, re-filing a shot onto the right bean (bean_id), backfilling rating/tasting notes, or fixing the timestamp (pulled_at). Changing grind_label re-derives the numeric grind position from the shot's grinder; changing yield/time/dose/tds keeps flow rate and extraction yield consistent automatically.
| Argument | Type | Description |
|---|---|---|
| fields* | object | Only the fields to change |
| shot_id* | integer | ID of the shot to correct |
{
"type": "object",
"required": [
"shot_id",
"fields"
],
"properties": {
"fields": {
"type": "object",
"properties": {
"tds": {
"type": "number"
},
"bag_id": {
"type": "integer",
"description": "Re-file the shot onto this bag; must be a bag of the shot's bean"
},
"dose_g": {
"type": "number"
},
"rating": {
"type": [
"integer",
"null"
],
"maximum": 5,
"minimum": 1,
"description": "1-5; null clears the rating"
},
"tasted": {
"enum": [
0,
1
],
"type": "integer",
"description": "Backfill 1 to mark a pending shot as tasted-clean (tasted, no defect tags) so it leaves the taste-pending queue without inventing a tag or rating"
},
"time_s": {
"type": "number"
},
"bean_id": {
"type": "integer",
"description": "Re-file the shot onto this bean (its current bag, unless bag_id is also given)"
},
"verdict": {
"type": [
"string",
"null"
],
"description": "null clears the verdict"
},
"yield_g": {
"type": "number"
},
"water_id": {
"type": "integer"
},
"best_brew": {
"enum": [
0,
1
],
"type": "integer"
},
"favourite": {
"enum": [
0,
1
],
"type": "integer"
},
"pulled_at": {
"type": "string",
"description": "Corrected timestamp (ISO 8601 or \"YYYY-MM-DD HH:MM:SS\")"
},
"beverage_g": {
"type": "number"
},
"grinder_id": {
"type": "integer"
},
"machine_id": {
"type": "integer"
},
"program_id": {
"type": "integer"
},
"temp_taste": {
"enum": [
"hot",
"warm",
"cold"
],
"type": "string"
},
"grind_label": {
"type": "string",
"description": "Corrected grind setting label; numeric position is re-derived"
},
"vessel_name": {
"type": "string"
},
"drink_intent": {
"enum": [
"straight",
"milk"
],
"type": "string"
},
"flavor_notes": {
"type": [
"string",
"null"
],
"maxLength": 4096,
"description": "null clears the notes"
},
"observations": {
"type": "object",
"maxProperties": 64
},
"sensory_tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 64
},
"finish_action": {
"enum": [
"hard_stop",
"passive_drip"
],
"type": "string"
},
"temperature_c": {
"type": "number"
},
"data_confidence": {
"enum": [
"measured",
"recalled",
"estimated"
],
"type": "string",
"description": "estimated marks the metrics as a best guess instead of burying the caveat in notes"
},
"vessel_weight_g": {
"type": "number"
},
"machine_settings": {
"type": [
"object",
"null"
],
"description": "The machine's selector positions for this shot, {key: position}; replaces what was stamped, null clears it",
"maxProperties": 16
}
},
"description": "Only the fields to change"
},
"shot_id": {
"type": "integer",
"description": "ID of the shot to correct"
}
}
}Correct a registered water: its name, type, mineral figures or notes. Only the keys you send in fields change; send null to clear an optional field (an empty string also clears a text field, but not a number or a closed list). Required fields can be changed but not cleared. fields may be omitted when only reason is sent.
| Argument | Type | Description |
|---|---|---|
| fields | object | |
| reason | string | Optional note, appended to this record's own notes as an ordinary line. Omit it and nothing is written. |
| water_id* | integer | This account's own water number, from list_waters. Never guess one. |
{
"type": "object",
"required": [
"water_id"
],
"properties": {
"fields": {
"type": "object",
"properties": {
"gh": {
"type": [
"number",
"null"
]
},
"kh": {
"type": [
"number",
"null"
]
},
"tds": {
"type": [
"number",
"null"
]
},
"name": {
"type": "string"
},
"type": {
"type": [
"string",
"null"
]
},
"notes": {
"type": [
"string",
"null"
]
},
"sodium": {
"type": [
"number",
"null"
]
},
"calcium": {
"type": [
"number",
"null"
]
},
"magnesium": {
"type": [
"number",
"null"
]
}
}
},
"reason": {
"type": "string",
"description": "Optional note, appended to this record's own notes as an ordinary line. Omit it and nothing is written."
},
"water_id": {
"type": "integer",
"description": "This account's own water number, from list_waters. Never guess one."
}
}
}| grind_label | string | Grinder setting label, e.g. "1.1.3" |
| sensory_tags | array | Sensory observations, e.g. ["sour","bitter"]. With shot_id: replaces the stored tags for this preview (omit to use stored; [] = none). |
{
"type": "object",
"properties": {
"dose_g": {
"type": "number",
"description": "Dose in grams"
},
"source": {
"enum": [
"measured",
"recalled",
"assumed"
],
"type": "string",
"description": "Grinder position source. Affects G1 warning (raw mode only)"
},
"time_s": {
"type": "number",
"description": "Extraction time in seconds"
},
"bean_id": {
"type": "integer",
"description": "Coffee bean ID (must belong to this account)"
},
"shot_id": {
"type": "integer",
"description": "Preview a logged shot by ID (dry-run; ignores the metric params below)"
},
"yield_g": {
"type": "number",
"description": "Yield in grams"
},
"grinder_id": {
"type": "integer",
"description": "Grinder ID (must belong to this account)"
},
"machine_id": {
"type": "integer",
"description": "Machine ID (must belong to this account)"
},
"grind_label": {
"type": "string",
"description": "Grinder setting label, e.g. \"1.1.3\""
},
"sensory_tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sensory observations, e.g. [\"sour\",\"bitter\"]. With shot_id: replaces the stored tags for this preview (omit to use stored; [] = none)."
}
}
}| The correction, if you measured it now: clicks to ADD to a pre-clean reading to get the same grind today, signed along the collar's own number direction. Omit it and the epoch stays unmeasured, which is a state the app shows rather than a zero it assumes |
| performed_at | string | When it was done (ISO 8601 or YYYY-MM-DD HH:MM:SS, UTC). Defaults to now; backdating is fine |
| disturbs_zero | integer | Whether this job disturbed the reference the stored numbers are read against: for a burr clean, whether the burrs actually came out. Defaults to the task's own answer; send 0 for a wipe-down that left the collar alone |
| offset_source | string | How the offset was arrived at: pull (a reference shot), counted (clicks counted at reassembly), typed (asserted directly) |
| equipment_kind* | string | Which kind of equipment this job was done on |
{
"type": "object",
"required": [
"equipment_kind",
"equipment_id",
"task"
],
"properties": {
"note": {
"type": "string",
"description": "Optional: what you did, and anything that surprised you"
},
"task": {
"enum": [
"burr_clean",
"backflush_water",
"backflush_detergent",
"descale",
"group_gasket_replace",
"shower_screen_clean",
"shower_screen_replace",
"group_head_wipe",
"basket_portafilter_soak",
"steam_wand_purge",
"steam_wand_soak",
"drip_tray_clean",
"water_tank_clean",
"water_filter_replace",
"boiler_water_change",
"lever_piston_seal_replace",
"lever_lubricate",
"milk_system_clean",
"professional_service",
"builtin_grinder_burr_clean",
"builtin_grinder_burr_replace",
"grinder_quick_clean",
"grinder_cleaning_tablets",
"burr_replace",
"hopper_clean",
"grounds_cup_clean",
"bearing_lubricate",
"gasket_seal_replace",
"idle_rinse",
"water_wash",
"dishwasher",
"filter_prime",
"softener_regenerate",
"other"
],
"type": "string",
"description": "Which maintenance job was performed"
},
"details": {
"type": "object",
"description": "Fields specific to this task. Which ones a task takes is published as details_fields on each task; a burr clean takes none",
"additionalProperties": true
},
"evidence": {
"type": "string",
"description": "One line recording what the measurement rested on, e.g. \"Counted 6 clicks coarser at reassembly.\""
},
"guide_id": {
"type": "string",
"description": "Optional: the id of the maintenance guide that was followed. Must be a guide for this task"
},
"equipment_id": {
"type": "integer",
"description": "The ID of that piece of equipment"
},
"offset_value": {
"type": "number",
"description": "The correction, if you measured it now: clicks to ADD to a pre-clean reading to get the same grind today, signed along the collar's own number direction. Omit it and the epoch stays unmeasured, which is a state the app shows rather than a zero it assumes"
},
"performed_at": {
"type": "string",
"description": "When it was done (ISO 8601 or YYYY-MM-DD HH:MM:SS, UTC). Defaults to now; backdating is fine"
},
"disturbs_zero": {
"enum": [
0,
1
],
"type": "integer",
"description": "Whether this job disturbed the reference the stored numbers are read against: for a burr clean, whether the burrs actually came out. Defaults to the task's own answer; send 0 for a wipe-down that left the collar alone"
},
"offset_source": {
"enum": [
"pull",
"counted",
"typed"
],
"type": "string",
"description": "How the offset was arrived at: pull (a reference shot), counted (clicks counted at reassembly), typed (asserted directly)"
},
"equipment_kind": {
"enum": [
"grinder",
"machine"
],
"type": "string",
"description": "Which kind of equipment this job was done on"
}
}
}| integer | null |
| Override: log against this bean instead of the active one (null = active) |
| verdict | string |
| yield_g* | number |
| water_id | integer | Optional references to waters formulation |
| best_brew | integer | 1 if marked as best brew, 0 otherwise |
| favourite | integer | 1 if favourite, 0 otherwise |
| pulled_at | string | null | When the shot was actually pulled (ISO 8601 or "YYYY-MM-DD HH:MM:SS"), for backdated entries. Defaults to now (null = now). When backdating, pass the returned shot_id to diagnose_shot explicitly, because the default diagnosis target is the chronologically latest shot. |
| beverage_g | number | Yield mass excluding cup/vessel weight in grams |
| grinder_id | integer | null | Override: grinder used, if not the active one (null = active) |
| machine_id | integer | null | Override: machine used, if not the active one (null = active) |
| program_id | integer | null | Override: machine program used, if not the active one (null = active) |
| temp_taste | string |
| vessel_name | string | Cup/vessel name |
| bloom_time_s | number | Pre-wetting or bloom duration in seconds |
| drink_intent | string |
| flavor_notes | string |
| flow_profile | string | Opaque flow profile data (JSON/TEXT) |
| method_tools | string | JSON representation of method tools used (e.g., paper filters, screen) |
| observations | object |
| sensory_tags | array |
| finish_action* | string |
| temperature_c | number | Brew temperature in Celsius |
| data_confidence | string | measured = weighed/timed live; recalled = from memory; estimated = a best guess (e.g. "~25s" after missing the timer) |
| vessel_weight_g | number | Cup/vessel weight in grams |
| machine_settings | object | Only when this one shot was pulled with a selector somewhere other than the machine's recorded settings: {key: position}. The shot is otherwise stamped with those automatically; a lasting change goes through update_machine. |
| pressure_profile | string | Pressure profile description or values |
| first_drip_time_s | number | Time to first drip in seconds |
{
"type": "object",
"required": [
"dose_g",
"yield_g",
"time_s",
"finish_action"
],
"properties": {
"tds": {
"type": "number",
"description": "Total Dissolved Solids percentage (e.g. 9.1 or 1.35)"
},
"bag_id": {
"type": [
"integer",
"null"
],
"description": "Which bag of the coffee the shot came from; defaults to its current (open) bag. Bag numbers are on list_beans' bags[]"
},
"dose_g": {
"type": "number"
},
"rating": {
"type": "integer",
"maximum": 5,
"minimum": 1
},
"tasted": {
"enum": [
0,
1
],
"type": "integer",
"description": "1 = the shot was tasted at log time. The explicit way to record a CLEAN tasting: sensory tags all describe defects, so a good shot has none. Without this flag (or a rating) it would be filed taste-pending. Tags or a rating also mark a shot as tasted; 0 (default) = taste later."
},
"time_s": {
"type": "number"
},
"bean_id": {
"type": [
"integer",
"null"
],
"description": "Override: log against this bean instead of the active one (null = active)"
},
"verdict": {
"type": "string"
},
"yield_g": {
"type": "number"
},
"water_id": {
"type": "integer",
"description": "Optional references to waters formulation"
},
"best_brew": {
"enum": [
0,
1
],
"type": "integer",
"description": "1 if marked as best brew, 0 otherwise"
},
"favourite": {
"enum": [
0,
1
],
"type": "integer",
"description": "1 if favourite, 0 otherwise"
},
"pulled_at": {
"type": [
"string",
"null"
],
"description": "When the shot was actually pulled (ISO 8601 or \"YYYY-MM-DD HH:MM:SS\"), for backdated entries. Defaults to now (null = now). When backdating, pass the returned shot_id to diagnose_shot explicitly, because the default diagnosis target is the chronologically latest shot."
},
"beverage_g": {
"type": "number",
"description": "Yield mass excluding cup/vessel weight in grams"
},
"grinder_id": {
"type": [
"integer",
"null"
],
"description": "Override: grinder used, if not the active one (null = active)"
},
"machine_id": {
"type": [
"integer",
"null"
],
"description": "Override: machine used, if not the active one (null = active)"
},
"program_id": {
"type": [
"integer",
"null"
],
"description": "Override: machine program used, if not the active one (null = active)"
},
"temp_taste": {
"enum": [
"hot",
"warm",
"cold"
],
"type": "string"
},
"vessel_name": {
"type": "string",
"description": "Cup/vessel name"
},
"bloom_time_s": {
"type": "number",
"description": "Pre-wetting or bloom duration in seconds"
},
"drink_intent": {
"enum": [
"straight",
"milk"
],
"type": "string"
},
"flavor_notes": {
"type": "string",
"maxLength": 4096
},
"flow_profile": {
"type": "string",
"maxLength": 16384,
"description": "Opaque flow profile data (JSON/TEXT)"
},
"method_tools": {
"type": "string",
"maxLength": 4096,
"description": "JSON representation of method tools used (e.g., paper filters, screen)"
},
"observations": {
"type": "object",
"maxProperties": 64
},
"sensory_tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128
},
"maxItems": 64
},
"finish_action": {
"enum": [
"hard_stop",
"passive_drip"
],
"type": "string"
},
"temperature_c": {
"type": "number",
"description": "Brew temperature in Celsius"
},
"data_confidence": {
"enum": [
"measured",
"recalled",
"estimated"
],
"type": "string",
"description": "measured = weighed/timed live; recalled = from memory; estimated = a best guess (e.g. \"~25s\" after missing the timer)"
},
"vessel_weight_g": {
"type": "number",
"description": "Cup/vessel weight in grams"
},
"machine_settings": {
"type": "object",
"description": "Only when this one shot was pulled with a selector somewhere other than the machine's recorded settings: {key: position}. The shot is otherwise stamped with those automatically; a lasting change goes through update_machine.",
"maxProperties": 16
},
"pressure_profile": {
"type": "string",
"maxLength": 16384,
"description": "Pressure profile description or values"
},
"first_drip_time_s": {
"type": "number",
"description": "Time to first drip in seconds"
}
}
}| product_id | string | Set by the apps. Leave out. |
| roast_date* | string | Calendar day in YYYY-MM-DD format: a day, not a timestamp |
| opened_date | string | Calendar day in YYYY-MM-DD format: a day, not a timestamp |
| bag_weight_g | number | Bag weight in grams |
| best_by_date | string | Calendar day in YYYY-MM-DD format: a day, not a timestamp |
| lot_revision_id | string | Set by the apps. Leave out. |
| catalog_coffee_id | string | Set by the apps. Leave out. |
{
"type": "object",
"required": [
"bean_id",
"roast_date"
],
"properties": {
"ean": {
"type": "string"
},
"cost": {
"type": "number"
},
"state": {
"enum": [
"sealed",
"open",
"frozen",
"finished"
],
"type": "string",
"description": "Defaults to sealed; the first log_shot against it opens it"
},
"bean_id": {
"type": "integer",
"description": "This account's own coffee number, from list_beans. Never guess one."
},
"qr_code": {
"type": "string"
},
"storage": {
"type": "string"
},
"buy_date": {
"type": "string",
"description": "Calendar day in YYYY-MM-DD format: a day, not a timestamp"
},
"currency": {
"type": "string"
},
"bag_notes": {
"type": "string",
"maxLength": 4096,
"description": "Notes about THIS bag (a batch note, where it was bought). The coffee's own description lives on the coffee, in notes."
},
"product_id": {
"type": "string",
"description": "Set by the apps. Leave out."
},
"roast_date": {
"type": "string",
"description": "Calendar day in YYYY-MM-DD format: a day, not a timestamp"
},
"opened_date": {
"type": "string",
"description": "Calendar day in YYYY-MM-DD format: a day, not a timestamp"
},
"bag_weight_g": {
"type": "number",
"description": "Bag weight in grams"
},
"best_by_date": {
"type": "string",
"description": "Calendar day in YYYY-MM-DD format: a day, not a timestamp"
},
"lot_revision_id": {
"type": "string",
"description": "Set by the apps. Leave out."
},
"catalog_coffee_id": {
"type": "string",
"description": "Set by the apps. Leave out."
}
}
}| rating |
| integer |
| acidity | string | Free text; roasters usually say low, medium or high |
| co2e_kg | number |
| origins | array | List of bean origin details |
| qr_code | string |
| roaster | string |
| storage | string |
| variety | string |
| archived | integer | 1 if archived, 0 otherwise |
| bean_mix | string | E.g. blend details |
| buy_date | string | Calendar day in YYYY-MM-DD format: a day, not a timestamp |
| currency | string |
| finished | integer | 1 if finished, 0 otherwise |
| aromatics | string |
| bag_notes | string |
| favourite | integer | 1 if favourite, 0 otherwise |
| frozen_at | string | Calendar day the bag went into the freezer, YYYY-MM-DD: a day, not a timestamp |
| sweetness | string | Free text; roasters usually say low, medium or high |
| product_id | string | Set by the apps. Leave out. |
| roast_date* | string | Calendar day in YYYY-MM-DD format: a day, not a timestamp |
| arabica_pct | number | Percent arabica, 100 for a pure arabica; the rest robusta |
| attachments | string | JSON or comma-separated list of attachments |
| frozen_note | string |
| opened_date | string | Calendar day in YYYY-MM-DD format: a day, not a timestamp |
| roast_level* | string |
| roast_range | string |
| unfrozen_at | string | Calendar day the bag came out, YYYY-MM-DD: a day, not a timestamp |
| bag_weight_g | number | Bag weight in grams |
| best_by_date | string | Calendar day in YYYY-MM-DD format: a day, not a timestamp |
| process_type* | string |
| roast_custom | string |
| decaffeinated | integer | 1 if decaf, 0 if regular |
| dial_category | string | Dialing behavior class: classic = medium/traditional espresso roasts (chocolate/nut, balanced); dark = genuinely dark/roasty; the light categories cover Nordic and ultra-light styles. |
| roasting_type | string |
| cupping_points | number |
| frozen_storage | string |
| lot_revision_id | string | Set by the apps. Leave out. |
| catalog_coffee_id | string | Set by the apps. Leave out. |
| rest_window_days_max | integer |
| rest_window_days_min | integer |
{
"type": "object",
"required": [
"name",
"roast_date",
"roast_level",
"process_type"
],
"properties": {
"ean": {
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string",
"description": "Free text; roasters usually say low, medium or high"
},
"cost": {
"type": "number"
},
"name": {
"type": "string"
},
"notes": {
"type": "string",
"maxLength": 4096,
"description": "The coffee's own description: the roaster's tasting notes, the dialing approach that worked. Per bag notes go in bag_notes."
},
"state": {
"enum": [
"sealed",
"open",
"frozen",
"finished"
],
"type": "string"
},
"origin": {
"type": "string"
},
"rating": {
"type": "integer",
"maximum": 5,
"minimum": 1
},
"acidity": {
"type": "string",
"description": "Free text; roasters usually say low, medium or high"
},
"co2e_kg": {
"type": "number"
},
"origins": {
"type": "array",
"items": {
"type": "object",
"properties": {
"farm": {
"type": "string"
},
"farmer": {
"type": "string"
},
"region": {
"type": "string"
},
"country": {
"type": "string"
},
"harvest": {
"type": "string"
},
"variety": {
"type": "string"
},
"percentage": {
"type": "number"
},
"processing": {
"type": "string"
},
"elevation_m": {
"type": "number"
},
"elevation_max_m": {
"type": "number",
"description": "Upper end of an elevation range, e.g. 1980 for \"1800–1980 m\"; elevation_m is the lower end"
}
}
},
"description": "List of bean origin details"
},
"qr_code": {
"type": "string"
},
"roaster": {
"type": "string"
},
"storage": {
"type": "string"
},
"variety": {
"type": "string"
},
"archived": {
"type": "integer",
"description": "1 if archived, 0 otherwise"
},
"bean_mix": {
"type": "string",
"description": "E.g. blend details"
},
"buy_date": {
"type": "string",
"description": "Calendar day in YYYY-MM-DD format: a day, not a timestamp"
},
"currency": {
"type": "string"
},
"finished": {
"type": "integer",
"description": "1 if finished, 0 otherwise"
},
"aromatics": {
"type": "string",
"maxLength": 1024
},
"bag_notes": {
"type": "string",
"maxLength": 4096
},
"favourite": {
"type": "integer",
"description": "1 if favourite, 0 otherwise"
},
"frozen_at": {
"type": "string",
"description": "Calendar day the bag went into the freezer, YYYY-MM-DD: a day, not a timestamp"
},
"sweetness": {
"type": "string",
"description": "Free text; roasters usually say low, medium or high"
},
"product_id": {
"type": "string",
"description": "Set by the apps. Leave out."
},
"roast_date": {
"type": "string",
"description": "Calendar day in YYYY-MM-DD format: a day, not a timestamp"
},
"arabica_pct": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "Percent arabica, 100 for a pure arabica; the rest robusta"
},
"attachments": {
"type": "string",
"maxLength": 1024,
"description": "JSON or comma-separated list of attachments"
},
"frozen_note": {
"type": "string"
},
"opened_date": {
"type": "string",
"description": "Calendar day in YYYY-MM-DD format: a day, not a timestamp"
},
"roast_level": {
"enum": [
"ultra-light",
"light",
"medium",
"medium-dark",
"dark"
],
"type": "string"
},
"roast_range": {
"type": "string"
},
"unfrozen_at": {
"type": "string",
"description": "Calendar day the bag came out, YYYY-MM-DD: a day, not a timestamp"
},
"bag_weight_g": {
"type": "number",
"description": "Bag weight in grams"
},
"best_by_date": {
"type": "string",
"description": "Calendar day in YYYY-MM-DD format: a day, not a timestamp"
},
"process_type": {
"enum": [
"washed",
"natural",
"honey",
"anaerobic",
"aerobic-extended",
"co-fermented",
"bioreactor",
"other"
],
"type": "string"
},
"roast_custom": {
"type": "string"
},
"decaffeinated": {
"type": "integer",
"description": "1 if decaf, 0 if regular"
},
"dial_category": {
"enum": [
"nordic-light",
"ultra-light",
"classic",
"processed",
"dark",
"aged"
],
"type": "string",
"description": "Dialing behavior class: classic = medium/traditional espresso roasts (chocolate/nut, balanced); dark = genuinely dark/roasty; the light categories cover Nordic and ultra-light styles."
},
"roasting_type": {
"enum": [
"filter",
"espresso",
"omni"
],
"type": "string"
},
"cupping_points": {
"type": "number"
},
"frozen_storage": {
"type": "string"
},
"lot_revision_id": {
"type": "string",
"description": "Set by the apps. Leave out."
},
"catalog_coffee_id": {
"type": "string",
"description": "Set by the apps. Leave out."
},
"rest_window_days_max": {
"type": "integer"
},
"rest_window_days_min": {
"type": "integer"
}
}
}| string |
| nominal_step* | number | Smallest adjustment increment (e.g. 1 click or 0.1collar units) |
| setting_scheme* | string | Collar mark style: single clicks or compound (rotation.number.clicks) |
| components_spec | string | JSON mapping string representing compound adjustment math |
| microns_per_step | number | null | Optional mechanical burr travel microns per nominal step |
| direction_convention* | string |
{
"type": "object",
"required": [
"name",
"motor_type",
"burr_type",
"setting_scheme",
"direction_convention",
"nominal_step"
],
"properties": {
"name": {
"type": "string",
"description": "The name/model of the grinder, e.g. Kinu M47"
},
"notes": {
"type": "string",
"description": "Additional notes"
},
"photo": {
"type": "string",
"description": "Photo path or URL"
},
"archived": {
"type": "integer",
"description": "1 if archived, 0 if active"
},
"burr_type": {
"enum": [
"conical",
"flat"
],
"type": "string"
},
"max_value": {
"type": [
"number",
"null"
],
"description": "Optional travel max bounds"
},
"min_value": {
"type": [
"number",
"null"
],
"description": "Optional travel min bounds"
},
"catalog_id": {
"type": "string",
"description": "Optional: the maintenance catalog model this is (the `id` of a catalog row, e.g. rancilio-silvia), when it was registered from the catalog. Its maintenance then comes from that model's researched record. \"none\" says it is not in the catalog."
},
"motor_type": {
"enum": [
"manual",
"electric"
],
"type": "string"
},
"nominal_step": {
"type": "number",
"description": "Smallest adjustment increment (e.g. 1 click or 0.1collar units)"
},
"setting_scheme": {
"enum": [
"numeric_stepless",
"numeric_stepped",
"clicks_single",
"compound",
"named"
],
"type": "string",
"description": "Collar mark style: single clicks or compound (rotation.number.clicks)"
},
"components_spec": {
"type": "string",
"maxLength": 4096,
"description": "JSON mapping string representing compound adjustment math"
},
"microns_per_step": {
"type": [
"number",
"null"
],
"description": "Optional mechanical burr travel microns per nominal step"
},
"direction_convention": {
"enum": [
"lower_is_finer",
"higher_is_finer"
],
"type": "string"
}
}
}| boiler_type | string |
| hardness_dh | number | null | Optional: the TOTAL hardness (GH) of the water this machine runs on, in °dH (German degrees; ppm as CaCO3 ÷ 17.85), as a test strip reports it. Picks the band of a maker's hardness table for descaling and filter life |
| control_type* | string |
| connected_device | string | Metadata mapping to smart hardware APIs |
| basket_size_grams | number |
| built_in_grinder_id | integer | id of a grinder built into this machine (bean-to-cup / integrated grinder) |
{
"type": "object",
"required": [
"name",
"control_type"
],
"properties": {
"name": {
"type": "string",
"description": "Machine name/model, e.g. Dedica EC685"
},
"notes": {
"type": "string"
},
"photo": {
"type": "string",
"description": "Photo path or URL"
},
"tools": {
"type": [
"string",
"null"
],
"description": "JSON or comma-separated tools, e.g., paper filters, flow control, metal mesh"
},
"archived": {
"type": "integer",
"description": "1 if archived, 0 if active"
},
"prep_type": {
"type": "string",
"description": "Preparation equipment type. One of: espresso_machine, lever_press, moka_pot, aeropress, french_press, v60_dripper, cold_brew. Lower snake_case."
},
"catalog_id": {
"type": "string",
"description": "Optional: the maintenance catalog model this is (the `id` of a catalog row, e.g. rancilio-silvia), when it was registered from the catalog. Its maintenance then comes from that model's researched record. \"none\" says it is not in the catalog."
},
"prep_style": {
"type": "string",
"description": "Preparation style. One of: espresso, filter, immersion, percolation. Only \"espresso\" is diagnosed by the dialing engine (G8). Anything else is recorded but never dialed, so do not guess this field."
},
"boiler_type": {
"type": "string"
},
"hardness_dh": {
"type": [
"number",
"null"
],
"description": "Optional: the TOTAL hardness (GH) of the water this machine runs on, in °dH (German degrees; ppm as CaCO3 ÷ 17.85), as a test strip reports it. Picks the band of a maker's hardness table for descaling and filter life"
},
"control_type": {
"enum": [
"volumetric",
"manual",
"lever"
],
"type": "string"
},
"connected_device": {
"type": "string",
"description": "Metadata mapping to smart hardware APIs"
},
"basket_size_grams": {
"type": "number"
},
"built_in_grinder_id": {
"type": "integer",
"description": "id of a grinder built into this machine (bean-to-cup / integrated grinder)"
}
}
}{
"type": "object",
"required": [
"machine_id",
"program_number"
],
"properties": {
"machine_id": {
"type": "integer"
},
"description": {
"type": [
"string",
"null"
]
},
"program_type": {
"enum": [
"volumetric",
"timed"
],
"type": "string",
"description": "Cutoff method: \"volumetric\" (weight) or \"timed\" (duration). Defaults to volumetric."
},
"target_time_s": {
"type": [
"number",
"null"
],
"description": "Target shot duration cutoff in seconds (required for timed programs)"
},
"volume_source": {
"enum": [
"measured",
"recalled"
],
"type": "string",
"description": "Confidence in the stored cutoff value, for either type"
},
"program_number": {
"type": "integer",
"description": "Program number / button index (e.g. 1 or 2)"
},
"target_volume_g": {
"type": [
"number",
"null"
],
"description": "Target yield cutoff in grams (required for volumetric programs)"
}
}
}| string |
| What the scale is built for: espresso (drip-tray footprint), brew (pour-over platform), dual (both modes), connected (app/controller integration), dosing (gravimetric dispensing), training, bench (high capacity, coarse) |
| connectivity | string | How the scale talks to an app or a machine controller |
| resolution_g | number | null | Finest published readability in grams. Leave null unless the maker states it |
| water_resistance | string | null | IEC 60529 ingress code as published, e.g. IPX4, IPX6, IP67, or none |
| flow_rate_display | integer | null | 1 if the scale shows live flow rate in g/s, 0 if it does not, null if the maker never said |
| resolution_banded | integer | null | 1 when resolution_g only holds in the lowest weight band and coarsens with load. Put the ladder in notes |
{
"type": "object",
"required": [
"name",
"scale_type"
],
"properties": {
"name": {
"type": "string",
"description": "Scale name/model, e.g. Acaia Lunar, Timemore Black Mirror Basic 2"
},
"notes": {
"type": "string",
"description": "Additional notes"
},
"power": {
"enum": [
"usb_c",
"micro_usb",
"aa",
"aaa",
"mains"
],
"type": "string",
"description": "How it is powered or recharged"
},
"depth_mm": {
"type": [
"number",
"null"
],
"description": "Platform depth in mm"
},
"width_mm": {
"type": [
"number",
"null"
],
"description": "Platform width in mm. Measure your drip tray"
},
"auto_tare": {
"type": [
"integer",
"null"
],
"description": "1 if it zeroes itself when a vessel is set down, 0 if not, null if unstated"
},
"height_mm": {
"type": [
"number",
"null"
],
"description": "Overall height in mm: the dimension that decides whether it fits under a group head"
},
"auto_timer": {
"type": [
"integer",
"null"
],
"description": "1 if the timer starts on first flow, 0 if not, null if unstated"
},
"capacity_g": {
"type": [
"number",
"null"
],
"description": "Maximum weight in grams. The cup or portafilter counts against it"
},
"scale_type": {
"enum": [
"espresso",
"brew",
"dual",
"connected",
"dosing",
"training",
"bench"
],
"type": "string",
"description": "What the scale is built for: espresso (drip-tray footprint), brew (pour-over platform), dual (both modes), connected (app/controller integration), dosing (gravimetric dispensing), training, bench (high capacity, coarse)"
},
"connectivity": {
"enum": [
"none",
"bluetooth",
"usb",
"bluetooth_usb"
],
"type": "string",
"description": "How the scale talks to an app or a machine controller"
},
"resolution_g": {
"type": [
"number",
"null"
],
"description": "Finest published readability in grams. Leave null unless the maker states it"
},
"water_resistance": {
"type": [
"string",
"null"
],
"description": "IEC 60529 ingress code as published, e.g. IPX4, IPX6, IP67, or none"
},
"flow_rate_display": {
"type": [
"integer",
"null"
],
"description": "1 if the scale shows live flow rate in g/s, 0 if it does not, null if the maker never said"
},
"resolution_banded": {
"type": [
"integer",
"null"
],
"description": "1 when resolution_g only holds in the lowest weight band and coarsens with load. Put the ladder in notes"
}
}
}{
"type": "object",
"required": [
"grinder_id"
],
"properties": {
"fields": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"notes": {
"type": [
"string",
"null"
]
},
"photo": {
"type": [
"string",
"null"
]
},
"burr_type": {
"enum": [
"conical",
"flat"
],
"type": "string"
},
"max_value": {
"type": [
"number",
"null"
]
},
"min_value": {
"type": [
"number",
"null"
]
},
"catalog_id": {
"type": [
"string",
"null"
],
"description": "The maintenance catalog model this grinder is; \"none\" if it is not listed; null to unbind. list_grinders proposes one from the name under maintenance.catalog.match"
},
"motor_type": {
"enum": [
"manual",
"electric"
],
"type": "string"
},
"nominal_step": {
"type": "number",
"description": "Smallest adjustment increment. On a numeric_stepless collar it is the precision labels are recorded in (0.1 records tenths) and the size of one click. numeric_stepped and clicks_single collars record whole steps whatever it says. To record tenths, set setting_scheme numeric_stepless as well"
},
"setting_scheme": {
"enum": [
"numeric_stepless",
"numeric_stepped",
"clicks_single",
"compound",
"named"
],
"type": "string"
},
"components_spec": {
"type": [
"string",
"null"
],
"maxLength": 4096,
"description": "JSON array of {name, per_step}, coarsest first: the ring arithmetic of a compound collar, or the ordered settings of a named one"
},
"microns_per_step": {
"type": [
"number",
"null"
]
},
"direction_convention": {
"enum": [
"lower_is_finer",
"higher_is_finer"
],
"type": "string"
}
}
},
"reason": {
"type": "string",
"description": "Optional note, appended to this record's own notes as an ordinary line. Omit it and nothing is written."
},
"dry_run": {
"type": "boolean",
"description": "true: write nothing, and answer with what the edit would do to the settings already recorded (moved[], checked, epoch, position_moved, position_cleared, rescaled_offsets, resigned_offsets, step_ignored, direction_flipped, recipe_count)"
},
"grinder_id": {
"type": "integer",
"description": "This account's own grinder number, from list_grinders. Never guess one."
}
}
}