BrewForge Docs

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

POST
/api/v1/actions/plan_carbonation

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

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.

method?string

"priming" (sugar in bottles/keg) or "force_carbonation" (CO2 from a regulator). Default: the saved method, else "priming".

Value in"priming" | "force_carbonation"
target_co2_volumes?number

Target carbonation in volumes of CO2, e.g. 2.4.

Range1 <= value <= 5.1
sugar_type?string

Priming sugar: "table_sugar" (default), "corn_sugar", "dme" or "honey".

Value in"table_sugar" | "corn_sugar" | "dme" | "honey"
beer_temp?number

Warmest temperature the beer reached after fermentation, for residual CO2 (priming), e.g. 20.

serving_temp?number

Serving/keg temperature (force carbonation), e.g. 4.

temp_unit?string

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

Value in"c" | "f"
beer_volume_l?number

Litres of beer to prime, e.g. 19. Default: from the brew (see description).

Range0 < value <= 5000
notes?|

Free text saved with the plan; null clears it.

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