ApiV1ProfilesEquipment
Create equipment profile
Authorization
bearerAuth AuthorizationBearer <token>
API token in format: bfk_
In: header
Request Body
application/json
name*string
Profile name
Length
1 <= length <= 200description?|
Length
length <= 2000isDefault?boolean
batchVolume*number
Target batch volume in liters (L)
Range
0 < valuebatchVolumeReference?string
Value in
"fermenter" | "kettle"boilTime?integer
Range
0 <= valuepreBoilVolume?|
boilOffRate?number
Range
0 <= valueboilOffRateMode?string
Value in
"volume" | "percentage"trubChillerLoss?|
Range
0 <= valuemashTunDeadSpace?|
Range
0 <= valuemashTunLoss?|
Range
0 <= valuefermenterLoss?|
Range
0 <= valuehltDeadSpace?|
Range
0 <= valuefermenterTopUp?|
Range
0 <= valuebrewHouseEfficiency?number
Range
0 <= value <= 100mashEfficiency?|
Range
0 <= value <= 100efficiencyDisplay?string
Value in
"brewhouse" | "mash"hopUtilization?|
Range
0 <= valuemashTunMaxVolume?|
kettleMaxVolume?|
grainAbsorptionRate?|
waterToGrainRatio?|
calculationMethod?string
Value in
"default" | "batch_sparge" | "no_sparge" | "custom"mashWaterMin?|
mashWaterMax?|
spargeWaterMin?|
spargeWaterMax?|
includeGrainVolume?boolean
overflowTarget?string
Value in
"top_up" | "mash"altitude?|
boilTemperature?|
hopstandTemperature?|
hopstandDuration?|
Range
0 <= valuegrainTemperature?|
mashTunHeatCapacity?|
Range
0 <= valuecoolingShrinkage?|
Range
0 <= valuecalculateStrikeTemp?boolean
spargeTemperature?|
Response Body
application/json
application/json
application/json
curl -X POST "https://brewforge.sh/api/v1/profiles/equipment" \ -H "Content-Type: application/json" \ -d '{ "name": "My BIAB Setup", "batchVolume": 20 }'{
"id": "string",
"name": "My Brew Kettle",
"description": "string",
"isDefault": true,
"batchVolume": 20,
"batchVolumeReference": "fermenter",
"boilTime": 60,
"preBoilVolume": 0,
"boilOffRate": 4,
"boilOffRateMode": "volume",
"trubChillerLoss": 0,
"mashTunDeadSpace": 0,
"mashTunLoss": 0,
"fermenterLoss": 0,
"hltDeadSpace": 0,
"fermenterTopUp": 0,
"brewHouseEfficiency": 72,
"mashEfficiency": 0,
"efficiencyDisplay": "brewhouse",
"hopUtilization": 0,
"mashTunMaxVolume": 0,
"kettleMaxVolume": 0,
"grainAbsorptionRate": 0,
"waterToGrainRatio": 0,
"calculationMethod": "default",
"mashWaterMin": 0,
"mashWaterMax": 0,
"spargeWaterMin": 0,
"spargeWaterMax": 0,
"includeGrainVolume": true,
"overflowTarget": "top_up",
"altitude": 0,
"boilTemperature": 0,
"hopstandTemperature": 0,
"hopstandDuration": 0,
"grainTemperature": 0,
"mashTunHeatCapacity": 0,
"coolingShrinkage": 0,
"calculateStrikeTemp": true,
"spargeTemperature": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "string",
"details": {
"property1": null,
"property2": null
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "string",
"details": {
"property1": null,
"property2": null
}
}
}