Rate a brew (quick star rating)
Give a brew a quick rating: 1-5 stars (half stars allowed) with an optional comment, as the evaluations tab's star rating. Example: "rate the porter 4 stars, a bit thin" → {brew: "Porter", stars: 4, comment: "A bit thin"}. Each call adds a rating; send evaluation_id to change an existing one. For a full BJCP or Lagerbernd scoresheet use save_scoresheet. Needs a plan with evaluations (Pro). Needs the plan feature `bjcp_evaluations`. Scope: `brews:write` (or `write`).
Give a brew a quick rating: 1-5 stars (half stars allowed) with an optional comment, as the evaluations tab's star rating. Example: "rate the porter 4 stars, a bit thin" → {brew: "Porter", stars: 4, comment: "A bit thin"}. Each call adds a rating; send evaluation_id to change an existing one. For a full BJCP or Lagerbernd scoresheet use save_scoresheet. Needs a plan with evaluations (Pro).
Needs the plan feature bjcp_evaluations. Scope: brews: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: brews: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.
Rating from 1 to 5 in half steps, e.g. 4 or 3.5. Required for a new rating.
0.51 <= value <= 5Tasting comment, e.g. "Roasty, a bit thin".
length <= 2000Tasting date, YYYY-MM-DD. Default: today.
dateId of the evaluation, from list_evaluations. Changes that rating instead of adding one.
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/rate_brew" \ -H "Content-Type: application/json" \ -d '{ "brew": "string" }'{
"brew": {
"id": "string",
"name": "string",
"status": "string",
"batch_number": 0
},
"evaluation": {
"id": "string",
"kind": "rating",
"by": "string",
"date": "string",
"stars": 0,
"score": 0,
"max_score": 0,
"verdict": "string",
"submitted": true,
"comment": "string"
},
"created": true
}{
"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": {}
}
}