BrewForge Docs

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`).

POST
/api/v1/actions/rate_brew

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).

AuthorizationBearer <token>

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 brews
  • brews:write: Create, update, delete brews and notes
  • inventory:read: List inventory items
  • inventory:write: Create, update, delete inventory items
  • equipment:read: List equipment profiles
  • equipment:write: Create, update, delete equipment profiles
  • styles:read: List style profiles
  • styles:write: Create, update, delete style profiles
  • profiles:read: List mash, fermentation, and water profiles
  • custom-fields:read: List custom field definitions
  • custom-fields:write: Create, update, delete custom field definitions
  • profiles:write: Create, update, delete mash, fermentation, and water profiles
  • cellar:read: View cellar, packaged stock, tap lists, and labels
  • cellar:write: Manage cellar, packaging, stock, tap lists, and labels
  • settings:read: View preferences, imports, calculators, and your data export
  • settings:write: Change preferences and undo imports
  • community:read: View community, feedback, tickets, inbox, and account overview
  • community:write: Post, vote, and reply in community, feedback, and tickets

In: header

Scope: brews:write

Request Body

application/json

brew*string

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.

stars?number

Rating from 1 to 5 in half steps, e.g. 4 or 3.5. Required for a new rating.

Multiple Of0.5
Range1 <= value <= 5
comment?string

Tasting comment, e.g. "Roasty, a bit thin".

Lengthlength <= 2000
date?string

Tasting date, YYYY-MM-DD. Default: today.

Formatdate
evaluation_id?string

Id of the evaluation, from list_evaluations. Changes that rating instead of adding one.

[key: string]?never

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": {}
  }
}