BrewForge Docs

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`).

POST
/api/v1/actions/record_brew_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).

AuthorizationBearer <token>

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 brews
  • brews:write: Create, update, delete brews and notes
  • inventory:read: List inventory items
  • inventory:write: Create, update, delete inventory items
  • equipment:read: List equipment profiles
  • equipment:write: Create, update, delete equipment profiles
  • styles:read: List style profiles
  • styles:write: Create, update, delete style profiles
  • profiles:read: List mash, fermentation, and water profiles
  • custom-fields:read: List custom field definitions
  • custom-fields:write: Create, update, delete custom field definitions
  • profiles:write: Create, update, delete mash, fermentation, and water profiles
  • cellar:read: View cellar, packaged stock, tap lists, and labels
  • cellar:write: Manage cellar, packaging, stock, tap lists, and labels
  • settings:read: View preferences, imports, calculators, and your data export
  • settings:write: Change preferences and undo imports
  • community:read: View community, feedback, tickets, inbox, and account overview
  • community:write: Post, vote, and reply in community, feedback, and tickets

In: header

Scope: brews:write

Request Body

application/json

brew*string

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_temp?|

Strike water temperature, e.g. 72 (°C) or °F with temp_unit "f". Send null to clear a recorded value.

strike_water_volume_l?|

Strike water in litres, e.g. 18. Send null to clear a recorded value.

mash_ph?|

Mash pH, e.g. 5.4. Send null to clear a recorded value.

sparge_water_volume_l?|

Sparge water in litres, e.g. 12. Send null to clear a recorded value.

first_runnings_gravity?|

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?|

Pre-boil gravity, e.g. 1.044 (SG) or the °P value with gravity_unit "plato". Send null to clear a recorded value.

pre_boil_volume_l?|

Wort in the kettle before the boil in litres, e.g. 27. Send null to clear a recorded value.

boil_time_min?|

Actual boil time in minutes, e.g. 60. Send null to clear a recorded value.

post_boil_volume_l?|

Wort after the boil (hot) in litres, e.g. 23.5. Send null to clear a recorded value.

post_boil_ph?|

pH after the boil, e.g. 5.4. Send null to clear a recorded value.

pre_dilution_gravity?|

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.

pre_dilution_volume_l?|

Volume before topping up in litres, e.g. 18. Send null to clear a recorded value.

og?|

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.

fermenter_volume_l?|

Volume into the fermenter in litres, e.g. 21. Send null to clear a recorded value.

pitching_temp?|

Wort temperature when the yeast was pitched, e.g. 18 (°C) or °F with temp_unit "f". Send null to clear a recorded value.

fg?|

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.

fermentation_peak_temp?|

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.

gravity_unit?string

Unit of the gravity values you send: "sg" (specific gravity, e.g. 1.012; default) or "plato" (°P, e.g. 3.1).

Value in"sg" | "plato"
temp_unit?string

Unit of the temperatures you send: "c" (°C, default) or "f" (°F).

Value in"c" | "f"
[key: string]?never

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": {}
  }
}