Plan carbonation (priming sugar or keg pressure)
Work out how to carbonate a brew and save the plan on its fermentation tab, calculated as the app does it. method "priming" (default): grams of priming sugar for the beer volume, from target CO2 volumes, sugar type and beer temperature (default: the peak fermentation temperature). method "force_carbonation": regulator pressure (psi and bar) for the target CO2 at the serving temperature. Without target_co2_volumes it keeps the saved target or uses the style's typical value. The beer volume is the packaged volume, else the measured fermenter volume minus losses, else the planned volume; send beer_volume_l to override. Temperatures default to °C. Calling it again with only some fields keeps the rest of the saved plan. Scope: `brews:write` (or `write`).
Work out how to carbonate a brew and save the plan on its fermentation tab, calculated as the app does it. method "priming" (default): grams of priming sugar for the beer volume, from target CO2 volumes, sugar type and beer temperature (default: the peak fermentation temperature). method "force_carbonation": regulator pressure (psi and bar) for the target CO2 at the serving temperature. Without target_co2_volumes it keeps the saved target or uses the style's typical value. The beer volume is the packaged volume, else the measured fermenter volume minus losses, else the planned volume; send beer_volume_l to override. Temperatures default to °C. Calling it again with only some fields keeps the rest of the saved 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.
"priming" (sugar in bottles/keg) or "force_carbonation" (CO2 from a regulator). Default: the saved method, else "priming".
"priming" | "force_carbonation"Target carbonation in volumes of CO2, e.g. 2.4.
1 <= value <= 5.1Priming sugar: "table_sugar" (default), "corn_sugar", "dme" or "honey".
"table_sugar" | "corn_sugar" | "dme" | "honey"Warmest temperature the beer reached after fermentation, for residual CO2 (priming), e.g. 20.
Serving/keg temperature (force carbonation), e.g. 4.
Unit of the temperatures you send: "c" (°C, default) or "f" (°F).
"c" | "f"Litres of beer to prime, e.g. 19. Default: from the brew (see description).
0 < value <= 5000Free text saved with the plan; null clears it.
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/plan_carbonation" \ -H "Content-Type: application/json" \ -d '{ "brew": "string" }'{
"brew": {
"id": "string",
"name": "string",
"status": "string",
"batch_number": 0
},
"method": "priming",
"target_co2_volumes": 0,
"style_range_co2_volumes": {
"min": 0,
"max": 0
},
"sugar_type": "string",
"sugar_g": 0,
"beer_volume_l": 0,
"beer_volume_source": "packaged",
"beer_temp_c": 0,
"serving_temp_c": 0,
"regulator_psi": 0,
"regulator_bar": 0,
"notes": "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": {}
}
}