BrewForge Docs

Before packaging: volume, free kegs, bottles

Call before package_beer. Shows where the beer comes from and how many litres are there (available_l; estimate: true means it is the recipe's estimate), which kegs are free to fill (only free kegs can be used), and the bottle/can containers with how many empties are available. Pass brew (e.g. the brew's name) or from_vessel (e.g. a keg to move into bottles). Volumes in litres. Needs the plan feature `cellar`. Scope: `cellar:read` (or `read`).

POST
/api/v1/actions/get_packaging_context

Call before package_beer. Shows where the beer comes from and how many litres are there (available_l; estimate: true means it is the recipe's estimate), which kegs are free to fill (only free kegs can be used), and the bottle/can containers with how many empties are available. Pass brew (e.g. the brew's name) or from_vessel (e.g. a keg to move into bottles). Volumes in litres.

Needs the plan feature cellar. Scope: cellar:read (or read).

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: cellar:read

Request Body

application/json

brew?string

Package this brew (from the tank it is in, or straight from the brew if it is in no vessel). 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.

from_vessel?string

Instead of brew: the vessel (or stay id) the beer comes out of, e.g. "Brite tank" or a keg "Corny 2" to move beer from a keg into bottles.

today?string

The brewer's local date today, YYYY-MM-DD (e.g. "2026-11-11"). Optional: defaults to today in UTC. Pass it when the brewer's day differs from UTC (late evening in America, early morning in Asia).

Match^\d{4}-\d{2}-\d{2}$
[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/get_packaging_context" \  -H "Content-Type: application/json" \  -d '{}'
{
  "today": "string",
  "source": {
    "beer": "string",
    "brew_id": "string",
    "from": "string",
    "available_l": 0,
    "estimate": true,
    "is_keg": true
  },
  "kegs": [
    {
      "name": "string",
      "capacity_l": 0,
      "free": true,
      "reason": "string"
    }
  ],
  "containers": [
    {
      "name": "string",
      "type": "string",
      "volume_l": 0,
      "empty_available": 0,
      "already_in_stock": 0
    }
  ]
}
{
  "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": {}
  }
}