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`).
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).
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: cellar:write
Request Body
application/json
"vessel" (fermenter/tank/keg, one at a time) or "container" (bottles/cans counted).
"vessel" | "container"Change this existing vessel/container: id or exact name. Omit to create a new one.
Name, e.g. "Fermenter 2" or "0.33 L cans". Required to create.
1 <= length <= 100Vessel: fermenter, tank, keg or other (default fermenter). Container: bottle, can, keg or other (default bottle).
"fermenter" | "tank" | "keg" | "other" | "bottle" | "can"Capacity in litres, e.g. 30 for a fermenter, 0.5 for a bottle. Required to create.
0 < valueVessel only: what it may hold, e.g. ["fermenting","conditioning"]. Default by type: keg → serving, tank → conditioning, else both.
1 <= itemsContainer only: how many you own (empty + filled), e.g. 48. null = not tracked.
Vessel only: serial or keg number.
Vessel only: empty weight in kg (for keg scales).
Vessel only: colour tag, e.g. amber, blue, green.
Free notes.
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": {}
}
}