Record brew day measurements
Record what was measured on brew day or at the end of fermentation: strike water, mash pH, pre-boil gravity/volume, boil time, post-boil volume, OG, fermenter volume, pitching temperature, final gravity, peak fermentation temperature. Send only the values you have: a value you send replaces the stored one, the others stay as they are, null clears one. Gravities default to SG (gravity_unit "plato" for °P), temperatures to °C, volumes are litres. Returns the recorded values, how each compares with its target, and the batch values the app derives (mash/brewhouse efficiency %, ABV, attenuation). For gravity readings during fermentation use log_fermentation_reading instead; this does not change the brew status (set_brew_status moves it to fermenting). Targets: get_brew_day_plan. Scope: `brews:write` (or `write`).
Record what was measured on brew day or at the end of fermentation: strike water, mash pH, pre-boil gravity/volume, boil time, post-boil volume, OG, fermenter volume, pitching temperature, final gravity, peak fermentation temperature. Send only the values you have: a value you send replaces the stored one, the others stay as they are, null clears one. Gravities default to SG (gravity_unit "plato" for °P), temperatures to °C, volumes are litres. Returns the recorded values, how each compares with its target, and the batch values the app derives (mash/brewhouse efficiency %, ABV, attenuation). For gravity readings during fermentation use log_fermentation_reading instead; this does not change the brew status (set_brew_status moves it to fermenting). Targets: get_brew_day_plan.
Scope: brews:write (or write).
API token in format: bfk_. Each operation lists the token scope it requires (the scopes are listed below).
read: Read everything (all areas)write: Create, change and delete everything (all areas)brews:read: List and view brewsbrews:write: Create, update, delete brews and notesinventory:read: List inventory itemsinventory:write: Create, update, delete inventory itemsequipment:read: List equipment profilesequipment:write: Create, update, delete equipment profilesstyles:read: List style profilesstyles:write: Create, update, delete style profilesprofiles:read: List mash, fermentation, and water profilescustom-fields:read: List custom field definitionscustom-fields:write: Create, update, delete custom field definitionsprofiles:write: Create, update, delete mash, fermentation, and water profilescellar:read: View cellar, packaged stock, tap lists, and labelscellar:write: Manage cellar, packaging, stock, tap lists, and labelssettings:read: View preferences, imports, calculators, and your data exportsettings:write: Change preferences and undo importscommunity:read: View community, feedback, tickets, inbox, and account overviewcommunity:write: Post, vote, and reply in community, feedback, and tickets
In: header
Scope: brews:write
Request Body
application/json
The brew: its id, its batch number (e.g. 12 or "#12") or its exact name (e.g. "Citra Pale Ale"). Case does not matter.
Strike water temperature, e.g. 72 (°C) or °F with temp_unit "f". Send null to clear a recorded value.
Strike water in litres, e.g. 18. Send null to clear a recorded value.
Mash pH, e.g. 5.4. Send null to clear a recorded value.
Sparge water in litres, e.g. 12. Send null to clear a recorded value.
Gravity of the first runnings, e.g. 1.072 (SG) or the °P value with gravity_unit "plato". Send null to clear a recorded value.
Pre-boil gravity, e.g. 1.044 (SG) or the °P value with gravity_unit "plato". Send null to clear a recorded value.
Wort in the kettle before the boil in litres, e.g. 27. Send null to clear a recorded value.
Actual boil time in minutes, e.g. 60. Send null to clear a recorded value.
Wort after the boil (hot) in litres, e.g. 23.5. Send null to clear a recorded value.
pH after the boil, e.g. 5.4. Send null to clear a recorded value.
Gravity before topping up with water (recipes with a fermenter top-up), e.g. 1.060 (SG) or the °P value with gravity_unit "plato". Send null to clear a recorded value.
Volume before topping up in litres, e.g. 18. Send null to clear a recorded value.
Original gravity into the fermenter, e.g. 1.052 (SG) or the °P value with gravity_unit "plato". Send null to clear a recorded value.
Volume into the fermenter in litres, e.g. 21. Send null to clear a recorded value.
Wort temperature when the yeast was pitched, e.g. 18 (°C) or °F with temp_unit "f". Send null to clear a recorded value.
Final gravity at the end of fermentation, e.g. 1.011 (SG) or the °P value with gravity_unit "plato". Send null to clear a recorded value.
Highest beer temperature during fermentation (priming sugar uses it), e.g. 21 (°C) or °F with temp_unit "f". Send null to clear a recorded value.
Unit of the gravity values you send: "sg" (specific gravity, e.g. 1.012; default) or "plato" (°P, e.g. 3.1).
"sg" | "plato"Unit of the temperatures you send: "c" (°C, default) or "f" (°F).
"c" | "f"Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://brewforge.sh/api/v1/actions/record_brew_measurements" \ -H "Content-Type: application/json" \ -d '{ "brew": "string" }'{
"brew": {
"id": "string",
"name": "string",
"status": "string",
"batch_number": 0
},
"recorded": {
"property1": 0,
"property2": 0
},
"changes": [
{
"field": "string",
"value": 0,
"target": 0,
"on_target": true
}
],
"batch": {
"mash_efficiency_pct": 0,
"brewhouse_efficiency_pct": 0,
"sudhausausbeute_pct": 0,
"og_sg": 0,
"og_plato": 0,
"fg_sg": 0,
"fg_plato": 0,
"abv_pct": 0,
"apparent_attenuation_pct": 0,
"ibu": 0,
"boil_off_l_per_h": 0,
"packaged_volume_l": 0
},
"planned_efficiency": {
"mash_efficiency_pct": 0,
"brewhouse_efficiency_pct": 0,
"sudhausausbeute_pct": 0
},
"status_note": "string"
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}