Plan a brew's path through the cellar
Plans where a brew will sit in the cellar, as planned stays. Without steps it builds the plan from the brew's fermentation profile, like the app's 'Plan in cellar': one step per stage (primary, cold crash, conditioning ...) back to back from start_date (default: the brew day or planned brew day), each in the best free vessel that allows its role and holds the batch. Call with dry_run: true first to show the suggestion, then again without it to save. Pass steps to choose vessels and dates yourself. Saving replaces the brew's stays that have not started yet; stays that started are kept. Dates YYYY-MM-DD, end_date exclusive. For a single stay use save_stay; to move the brew day with its plan use move_brew_day. Needs the plan feature `cellar`. Scope: `cellar:write` (or `write`).
Plans where a brew will sit in the cellar, as planned stays. Without steps it builds the plan from the brew's fermentation profile, like the app's 'Plan in cellar': one step per stage (primary, cold crash, conditioning ...) back to back from start_date (default: the brew day or planned brew day), each in the best free vessel that allows its role and holds the batch. Call with dry_run: true first to show the suggestion, then again without it to save. Pass steps to choose vessels and dates yourself. Saving replaces the brew's stays that have not started yet; stays that started are kept. Dates YYYY-MM-DD, end_date exclusive. For a single stay use save_stay; to move the brew day with its plan use move_brew_day.
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 brew: its id, its batch number (e.g. 12 or "#12") or its exact name (e.g. "Citra Pale Ale"). Case does not matter.
Profile plans only: day the first step starts, YYYY-MM-DD. Default: the brew day, else the planned brew day.
^\d{4}-\d{2}-\d{2}$Your own plan instead of the profile's, e.g. [{"vessel":"Fermenter 2","role":"fermenting","start_date":"2026-12-01","end_date":"2026-12-15","name":"Primary"}]. Omit to plan from the fermentation profile; start_date is then ignored.
1 <= items <= 20true = only show the plan, save nothing.
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/plan_brew_cellar" \ -H "Content-Type: application/json" \ -d '{ "brew": "string" }'{
"saved": true,
"brew": {
"id": "string",
"name": "string",
"volume_l": 0
},
"steps": [
{
"name": "string",
"role": "string",
"start_date": "string",
"end_date": "string",
"vessel": "string",
"other_fitting_vessels": [
"string"
],
"why_not_planned": "string"
}
],
"replaces_planned_stays": 0,
"message": "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": {}
}
}