BrewForge Docs

Fill in a BJCP or Lagerbernd scoresheet

Start or fill in a full tasting scoresheet for a brew. BJCP (default): section scores (aroma 0-12, appearance 0-3, flavor 0-20, mouthfeel 0-5, overall 0-10; total out of 50), comments per section and off-flavors. Lagerbernd (sheet: "lagerbernd"): nine-step scales in ratings (total out of 60, German school grade), intensities and notes. Without evaluation_id it creates a new sheet with what you send; with evaluation_id (from list_evaluations) it updates only the fields you send. Returns the total score. For a quick star rating use rate_brew. Needs a plan with evaluations (Pro). Needs the plan feature `bjcp_evaluations`. Scope: `brews:write` (or `write`).

POST
/api/v1/actions/save_scoresheet

Start or fill in a full tasting scoresheet for a brew. BJCP (default): section scores (aroma 0-12, appearance 0-3, flavor 0-20, mouthfeel 0-5, overall 0-10; total out of 50), comments per section and off-flavors. Lagerbernd (sheet: "lagerbernd"): nine-step scales in ratings (total out of 60, German school grade), intensities and notes. Without evaluation_id it creates a new sheet with what you send; with evaluation_id (from list_evaluations) it updates only the fields you send. Returns the total score. For a quick star rating use rate_brew. 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.

sheet?string

Kind of a new scoresheet: "bjcp" (default; 50 points) or "lagerbernd" (60 points, nine-step scales). Ignored with evaluation_id.

Value in"bjcp" | "lagerbernd"
evaluation_id?string

Id of the evaluation, from list_evaluations. Updates that sheet instead of starting a new one.

evaluator_name?string

Who tasted, e.g. "Anna". Default: empty (you).

Lengthlength <= 80
date?string

Tasting date, YYYY-MM-DD. Default: today for a new sheet.

Formatdate
aroma_score?integer

BJCP aroma score, 0-12.

Range0 <= value <= 12
appearance_score?integer

BJCP appearance score, 0-3.

Range0 <= value <= 3
flavor_score?integer

BJCP flavor score, 0-20.

Range0 <= value <= 20
mouthfeel_score?integer

BJCP mouthfeel score, 0-5.

Range0 <= value <= 5
overall_score?integer

BJCP overall impression score, 0-10.

Range0 <= value <= 10
aroma_comments?string

BJCP aroma comments.

Lengthlength <= 2000
appearance_comments?string

BJCP appearance comments.

Lengthlength <= 2000
flavor_comments?string

BJCP flavor comments.

Lengthlength <= 2000
mouthfeel_comments?string

BJCP mouthfeel comments.

Lengthlength <= 2000
overall_comments?string

BJCP overall impression comments.

Lengthlength <= 2000
off_flavors?array<>

BJCP off-flavors found (replaces the list), e.g. [{"name": "Diacetyl", "intensity": "low"}].

ratings?

Lagerbernd ratings, position 1-9 per scale. Fit scales (color, clarity, aroma, body, carbonation, maltiness, bitterness, hoppiness): 5 = just right, 1 too little, 9 too much. Quality (head_retention, head_texture, aromas, malt_character, hop_character, yeast_profile, balance, drinkability): 9 = best. Deductions (off_flavors, bitterness_quality): 9 = clean, 1 = severe.

intensities?

Lagerbernd descriptive intensities (not scored), 1 = low … 9 = high, per scale.

notes?

Lagerbernd free-text descriptors, e.g. {"aromas": "bready, floral", "overall": "Clean and crisp"}.

[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/save_scoresheet" \  -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,
  "unrated_scales": [
    "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": {}
  }
}