Create a profile
Create an equipment, mash, fermentation, water or hop stand profile. Three ways: (1) new, with the settings object of its kind (equipment needs only batch_volume_l, everything else gets the app defaults; mash needs steps; fermentation needs stages; hop_stand needs points; water takes the ions); (2) copy_from an own profile of the same kind (duplicate); (3) template: add a BrewForge template (see find_profiles { templates: true }). With copy_from or template, settings you send override the copy. is_default: true makes it the default for new brews. Example: {"kind": "water", "name": "Tap water", "water": {"calcium_ppm": 80, "magnesium_ppm": 12, "sodium_ppm": 20, "chloride_ppm": 60, "sulfate_ppm": 110, "bicarbonate_ppm": 150}}. Returns the profile with all settings (litres, °C, minutes, mg/L). Needs the plan feature `profiles`. Scope: `profiles:write` (or `write`).
Create an equipment, mash, fermentation, water or hop stand profile. Three ways: (1) new, with the settings object of its kind (equipment needs only batch_volume_l, everything else gets the app defaults; mash needs steps; fermentation needs stages; hop_stand needs points; water takes the ions); (2) copy_from an own profile of the same kind (duplicate); (3) template: add a BrewForge template (see find_profiles { templates: true }). With copy_from or template, settings you send override the copy. is_default: true makes it the default for new brews. Example: {"kind": "water", "name": "Tap water", "water": {"calcium_ppm": 80, "magnesium_ppm": 12, "sodium_ppm": 20, "chloride_ppm": 60, "sulfate_ppm": 110, "bicarbonate_ppm": 150}}. Returns the profile with all settings (litres, °C, minutes, mg/L).
Needs the plan feature profiles. Scope: profiles: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: profiles:write
Request Body
application/json
Profile kind: "equipment" (brewhouse volumes, losses, efficiency), "mash" (mash steps), "fermentation" (fermentation stages), "water" (water report ions) or "hop_stand" (temperature curve after flame-out).
"equipment" | "mash" | "fermentation" | "water" | "hop_stand"Name of the new profile. Required unless template is given (then the template's name). Example: "Grainfather G30 23 L".
1 <= length <= 100Free text note (optional).
true: use it as the default for new brews (not for hop_stand).
Duplicate this own profile of the same kind (id or exact name), then apply the settings you send.
Add this BrewForge template (id or exact name, e.g. "Grainfather G30"); find_profiles { templates: true } lists them.
Equipment settings (kind equipment), only what you set. Fields include batch_volume_l, boil_time_min, boil_off_rate + boil_off_rate_mode (volume=L/h, percentage=%/h), brewhouse_efficiency_pct, trub_chiller_loss_l, fermenter_loss_l, kettle_max_volume_l / mash_tun_max_volume_l (vessel sizes), water_calculation, hop_stand_curve (get_profile lists all).
Mash settings (kind mash): grain_temp_c and steps: [{name, temp_c, duration_min, type?: "temperature"|"infusion"|"decoction", ramp_min?}]. Example: {"steps": [{"name": "Saccharification", "temp_c": 67, "duration_min": 60}]}.
Fermentation settings (kind fermentation): stages: [{name, temp_c, duration_days, type?: primary|secondary|cold_crash|conditioning|..., pressure_psi?, spunding?}]. Example: {"stages": [{"name": "Primary", "temp_c": 19, "duration_days": 10}]}.
Water report (kind water), ions in mg/L (ppm): calcium_ppm, magnesium_ppm, sodium_ppm, chloride_ppm, sulfate_ppm, bicarbonate_ppm, ph, conductivity_us_cm. Example: {"calcium_ppm": 80, "sulfate_ppm": 110, "bicarbonate_ppm": 150}.
Hop stand curve (kind hop_stand): points: [{time_min, temp_c}], first at time_min 0. Example: {"points": [{"time_min": 0, "temp_c": 95}, {"time_min": 30, "temp_c": 70}]}.
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/create_profile" \ -H "Content-Type: application/json" \ -d '{ "kind": "equipment" }'{}{
"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": {}
}
}