BrewForge Docs

API-Überblick

Die APIs von BrewForge: REST-API, Actions-API und MCP-Server für KI-Assistenten, um Sude, Bestand, Profile und mehr aus Skripten und anderen Apps zu lesen und zu ändern

Mit der REST-API von BrewForge lesen und ändern deine Skripte und andere Apps deine Braudaten: Sude mit Notizen und Gärungsmesswerten, Bestand, Profile und eigene Felder.

Drei Wege

Was es istGut für
REST-API (diese Seite)Ressourcen unter /api/v1: Sude, Notizen, Messwerte, Bestand, Profile, eigene FelderDatensätze mit einem anderen System abgleichen
Actions-APIEin POST /api/v1/actions/{name} pro Aufgabe, für alles in der App: Brautag, Keller, Taplisten, Bestellungen, Einstellungen, Feedback und mehrSkripte und Automationen, die wie ein Brauer handeln, Verweise per Name
MCP-ServerDieselben Actions als Tools für KI-Assistenten (Claude, ChatGPT, Cursor, VS Code) unter https://brewforge.sh/api/mcp, mit OAuth-AnmeldungMit deinen Braudaten in einem KI-Assistenten arbeiten

Alle drei nutzen dieselben API-Token und brauchen den Pro-Tarif. Die Tool-Referenz listet jede Action.

API-Referenz auf Englisch

Diese Seiten zur API gibt es auf Deutsch. Die API-Referenz mit allen Endpunkten, Parametern und Beispielantworten wird aus der OpenAPI-Beschreibung erzeugt und ist nur auf Englisch verfügbar.

Schnellstart

  1. Hol dir ein API-Token: Öffne in BrewForge Einstellungen → Integrationen → API-Token und klicke auf Token erstellen (siehe API-Token).
  2. Schicke deine erste Anfrage:
curl https://brewforge.sh/api/v1/brews \
  -H "Authorization: Bearer bfk_your_token_here"

Braurechnungen ohne Konto

Die Rechner (Alkoholgehalt, IBU, Hauptguss, Karbonisierungszucker, …) sind eine eigene, kostenlose API ohne Token: siehe Rechner-API.

Voraussetzungen

  • Pro-Tarif oder höher (Pro, AI oder Commercial). Konten im Free- und Basic-Tarif bekommen 403 mit TIER_REQUIRED.
  • Ein API-Token mit den Berechtigungen, die die Endpunkte brauchen.

Grundlagen

  • Basis-URL: https://brewforge.sh/api/v1
  • Format: JSON in beide Richtungen. Fehler kommen als { "error": { "code", "message", "details" } }.
  • Seiten: Listen-Endpunkte nehmen page (ab 1) und limit (Standard 20, höchstens 100) und liefern ein Objekt pagination mit page, limit, total, totalPages und hasMore.
  • Limits: 100 Anfragen pro Stunde und 1.000 pro 30 Tage je Konto, siehe Rate-Limits. Actions-API und MCP-Server haben ein eigenes, höheres Limit.

Endpunkte

Sude

MethodeEndpunktBeschreibungBerechtigung
GET/api/v1/brewsSude auflisten (seitenweise)brews:read
POST/api/v1/brewsSud anlegenbrews:write
GET/api/v1/brews/:idEinen Sud abrufenbrews:read
PATCH/api/v1/brews/:idSud ändernbrews:write
DELETE/api/v1/brews/:idSud löschenbrews:write
GET/api/v1/brews/:id/notesNotizen des Suds auflistenbrews:read
POST/api/v1/brews/:id/notesNotiz hinzufügenbrews:write
GET/api/v1/brews/:id/notes/:noteIdEine Notiz abrufenbrews:read
PATCH/api/v1/brews/:id/notes/:noteIdNotiz ändernbrews:write
DELETE/api/v1/brews/:id/notes/:noteIdNotiz löschenbrews:write
GET/api/v1/brews/:id/readingsGärungsmesswerte auflistenbrews:read
POST/api/v1/brews/:id/readingsGärungsmesswert hinzufügenbrews:write
GET/api/v1/brews/:id/custom-fieldsWerte der eigenen Felder eines Sudsbrews:read

Bestand

:type ist fermentables (Malze und Zucker), hops (Hopfen), yeasts (Hefen) oder miscs (Sonstiges).

MethodeEndpunktBeschreibungBerechtigung
GET/api/v1/inventoryGesamter Bestand, nach Art gruppiertinventory:read
GET/api/v1/inventory/:typeArtikel einer Art auflisten (seitenweise)inventory:read
POST/api/v1/inventory/:typeArtikel anlegeninventory:write
GET/api/v1/inventory/:type/:idEinen Artikel abrufeninventory:read
PATCH/api/v1/inventory/:type/:idArtikel änderninventory:write
DELETE/api/v1/inventory/:type/:idArtikel löscheninventory:write

Profile

MethodeEndpunktBeschreibungBerechtigung
GET/api/v1/profiles/equipmentAnlagenprofile auflistenequipment:read
POST/api/v1/profiles/equipmentAnlagenprofil anlegenequipment:write
GET PATCH DELETE/api/v1/profiles/equipment/:idAnlagenprofil abrufen, ändern oder löschenequipment:read / equipment:write
GET/api/v1/profiles/stylesBierstilprofile auflistenstyles:read
POST/api/v1/profiles/stylesBierstilprofil anlegenstyles:write
GET PATCH DELETE/api/v1/profiles/styles/:idBierstilprofil abrufen, ändern oder löschenstyles:read / styles:write
GET/api/v1/profiles/mash, /api/v1/profiles/mash/:idMaischprofile auflisten oder abrufenprofiles:read
GET/api/v1/profiles/fermentation, /api/v1/profiles/fermentation/:idGärprofile auflisten oder abrufenprofiles:read
GET/api/v1/profiles/water, /api/v1/profiles/water/:idWasserprofile auflisten oder abrufenprofiles:read

Eigene Felder

MethodeEndpunktBeschreibungBerechtigung
GET/api/v1/custom-fieldsDefinitionen der eigenen Felder auflistencustom-fields:read
GET/api/v1/custom-fields/:idDefinition eines eigenen Felds abrufencustom-fields:read

Feldnamen in Anfragen und Antworten sind Englisch (zum Beispiel readyByDate, originalGravity), Werte mit Dezimalpunkt. Welche Felder es gibt, steht in der API-Referenz (auf Englisch).

OpenAPI-Beschreibung

Die ganze API, REST-Endpunkte und Actions, ist in einem OpenAPI-3-Dokument unter docs.brewforge.sh/openapi.json beschrieben. Damit kannst du Clients erzeugen oder KI-Agenten und Tools eine maschinenlesbare Sicht auf alle Endpunkte geben. Actions tragen den Tag Actions: <Toolset>. Die Berechtigungen, die ein Token haben kann, stehen außerdem unter https://brewforge.sh/.well-known/oauth-protected-resource.

Weiter

Auf dieser Seite