Empty a vessel today (end a stay)
Ends a current stay today, so the vessel is free from today on: the fermenter was emptied, the keg is finished. Use it for 'the keg of porter is empty' or 'I emptied Fermenter 1'. The stay stays in the history. A stay that has not started yet, or started today, cannot be ended: delete it with delete_cellar_item (kind: stay) instead. Packaging with package_beer already empties the source tank, so do not call this after packaging. Ending a keg returns an undo_token. Needs the plan feature `cellar`. Scope: `cellar:write` (or `write`).
Ends a current stay today, so the vessel is free from today on: the fermenter was emptied, the keg is finished. Use it for 'the keg of porter is empty' or 'I emptied Fermenter 1'. The stay stays in the history. A stay that has not started yet, or started today, cannot be ended: delete it with delete_cellar_item (kind: stay) instead. Packaging with package_beer already empties the source tank, so do not call this after packaging. Ending a keg returns an undo_token.
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
The stay to end. The stay: its id, or the vessel it is in (e.g. "Fermenter 1": the current stay there, else its only upcoming one), or the brew in it (id, batch number or exact name). Ids come from get_cellar.
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).
^\d{4}-\d{2}-\d{2}$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/end_stay" \ -H "Content-Type: application/json" \ -d '{ "stay": "string" }'{
"ended": {
"id": "string",
"vessel": "string",
"vessel_id": "string",
"beer": "string",
"brew_id": "string",
"role": "string",
"name": "string",
"start_date": "string",
"end_date": "string",
"volume_l": 0,
"status": "planned",
"notes": "string"
},
"undo_token": "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": {}
}
}