BrewForge Docs

Add or edit a vessel or bottle/can container

Sets up the cellar. kind "vessel" = one named fermenter, tank or keg (e.g. "Fermenter 1", "Corny 3"); stays put beer in it. kind "container" = a pool of identical bottles, cans or small kegs counted by number (e.g. "0.5 L bottles", 48 owned). Omit ref to create; pass ref (id or exact name) to change only the fields you pass. Volumes in litres. Returns the saved item and, for a container, how many are filled and empty. Delete with delete_cellar_item. Needs the plan feature `cellar`. Scope: `cellar:write` (or `write`).

POST
/api/v1/actions/save_cellar_vessel

Sets up the cellar. kind "vessel" = one named fermenter, tank or keg (e.g. "Fermenter 1", "Corny 3"); stays put beer in it. kind "container" = a pool of identical bottles, cans or small kegs counted by number (e.g. "0.5 L bottles", 48 owned). Omit ref to create; pass ref (id or exact name) to change only the fields you pass. Volumes in litres. Returns the saved item and, for a container, how many are filled and empty. Delete with delete_cellar_item.

Needs the plan feature cellar. Scope: cellar: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: cellar:write

Request Body

application/json

kind*string

"vessel" (fermenter/tank/keg, one at a time) or "container" (bottles/cans counted).

Value in"vessel" | "container"
ref?string

Change this existing vessel/container: id or exact name. Omit to create a new one.

name?string

Name, e.g. "Fermenter 2" or "0.33 L cans". Required to create.

Length1 <= length <= 100
type?string

Vessel: fermenter, tank, keg or other (default fermenter). Container: bottle, can, keg or other (default bottle).

Value in"fermenter" | "tank" | "keg" | "other" | "bottle" | "can"
volume_l?number

Capacity in litres, e.g. 30 for a fermenter, 0.5 for a bottle. Required to create.

Range0 < value
roles?array<>

Vessel only: what it may hold, e.g. ["fermenting","conditioning"]. Default by type: keg → serving, tank → conditioning, else both.

Items1 <= items
quantity_owned?|

Container only: how many you own (empty + filled), e.g. 48. null = not tracked.

serial_number?|

Vessel only: serial or keg number.

tare_weight_kg?|

Vessel only: empty weight in kg (for keg scales).

color?|

Vessel only: colour tag, e.g. amber, blue, green.

notes?|

Free notes.

[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/save_cellar_vessel" \  -H "Content-Type: application/json" \  -d '{    "kind": "vessel"  }'
{
  "created": true,
  "vessel": {
    "id": "string",
    "name": "string",
    "type": "string",
    "capacity_l": 0,
    "roles": [
      "string"
    ]
  },
  "container": {
    "id": "string",
    "name": "string",
    "type": "string",
    "volume_l": 0,
    "quantity_owned": 0,
    "filled": 0,
    "empty": 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": {}
  }
}