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 ist | Gut für | |
|---|---|---|
| REST-API (diese Seite) | Ressourcen unter /api/v1: Sude, Notizen, Messwerte, Bestand, Profile, eigene Felder | Datensätze mit einem anderen System abgleichen |
| Actions-API | Ein POST /api/v1/actions/{name} pro Aufgabe, für alles in der App: Brautag, Keller, Taplisten, Bestellungen, Einstellungen, Feedback und mehr | Skripte und Automationen, die wie ein Brauer handeln, Verweise per Name |
| MCP-Server | Dieselben Actions als Tools für KI-Assistenten (Claude, ChatGPT, Cursor, VS Code) unter https://brewforge.sh/api/mcp, mit OAuth-Anmeldung | Mit 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
- Hol dir ein API-Token: Öffne in BrewForge Einstellungen → Integrationen → API-Token und klicke auf Token erstellen (siehe API-Token).
- 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
403mitTIER_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) undlimit(Standard 20, höchstens 100) und liefern ein Objektpaginationmitpage,limit,total,totalPagesundhasMore. - 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
| Methode | Endpunkt | Beschreibung | Berechtigung |
|---|---|---|---|
GET | /api/v1/brews | Sude auflisten (seitenweise) | brews:read |
POST | /api/v1/brews | Sud anlegen | brews:write |
GET | /api/v1/brews/:id | Einen Sud abrufen | brews:read |
PATCH | /api/v1/brews/:id | Sud ändern | brews:write |
DELETE | /api/v1/brews/:id | Sud löschen | brews:write |
GET | /api/v1/brews/:id/notes | Notizen des Suds auflisten | brews:read |
POST | /api/v1/brews/:id/notes | Notiz hinzufügen | brews:write |
GET | /api/v1/brews/:id/notes/:noteId | Eine Notiz abrufen | brews:read |
PATCH | /api/v1/brews/:id/notes/:noteId | Notiz ändern | brews:write |
DELETE | /api/v1/brews/:id/notes/:noteId | Notiz löschen | brews:write |
GET | /api/v1/brews/:id/readings | Gärungsmesswerte auflisten | brews:read |
POST | /api/v1/brews/:id/readings | Gärungsmesswert hinzufügen | brews:write |
GET | /api/v1/brews/:id/custom-fields | Werte der eigenen Felder eines Suds | brews:read |
Bestand
:type ist fermentables (Malze und Zucker), hops (Hopfen), yeasts (Hefen) oder miscs (Sonstiges).
| Methode | Endpunkt | Beschreibung | Berechtigung |
|---|---|---|---|
GET | /api/v1/inventory | Gesamter Bestand, nach Art gruppiert | inventory:read |
GET | /api/v1/inventory/:type | Artikel einer Art auflisten (seitenweise) | inventory:read |
POST | /api/v1/inventory/:type | Artikel anlegen | inventory:write |
GET | /api/v1/inventory/:type/:id | Einen Artikel abrufen | inventory:read |
PATCH | /api/v1/inventory/:type/:id | Artikel ändern | inventory:write |
DELETE | /api/v1/inventory/:type/:id | Artikel löschen | inventory:write |
Profile
| Methode | Endpunkt | Beschreibung | Berechtigung |
|---|---|---|---|
GET | /api/v1/profiles/equipment | Anlagenprofile auflisten | equipment:read |
POST | /api/v1/profiles/equipment | Anlagenprofil anlegen | equipment:write |
GET PATCH DELETE | /api/v1/profiles/equipment/:id | Anlagenprofil abrufen, ändern oder löschen | equipment:read / equipment:write |
GET | /api/v1/profiles/styles | Bierstilprofile auflisten | styles:read |
POST | /api/v1/profiles/styles | Bierstilprofil anlegen | styles:write |
GET PATCH DELETE | /api/v1/profiles/styles/:id | Bierstilprofil abrufen, ändern oder löschen | styles:read / styles:write |
GET | /api/v1/profiles/mash, /api/v1/profiles/mash/:id | Maischprofile auflisten oder abrufen | profiles:read |
GET | /api/v1/profiles/fermentation, /api/v1/profiles/fermentation/:id | Gärprofile auflisten oder abrufen | profiles:read |
GET | /api/v1/profiles/water, /api/v1/profiles/water/:id | Wasserprofile auflisten oder abrufen | profiles:read |
Eigene Felder
| Methode | Endpunkt | Beschreibung | Berechtigung |
|---|---|---|---|
GET | /api/v1/custom-fields | Definitionen der eigenen Felder auflisten | custom-fields:read |
GET | /api/v1/custom-fields/:id | Definition eines eigenen Felds abrufen | custom-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
Rechner-API
Kostenlose Brau-Rechner-API für Alkoholgehalt, IBU (Tinseth), Bierfarbe, Hauptguss, Rastenplan, Karbonisierung, Hefe-Anstellrate und mehr. Ohne Konto und ohne API-Schlüssel, einfache GET-Anfragen mit JSON-Antworten.
MCP-ServerPro
Verbinde BrewForge mit Claude, ChatGPT, Cursor, VS Code und anderen KI-Assistenten über den BrewForge-MCP-Server: Einrichtung, Anmeldung per OAuth oder API-Token, Toolsets, Sicherheit und Fehlersuche.