/
API-Dokumentation
Boo API v1

Maschinenwissen per Schnittstelle

Maschinen samt Anlagenstruktur anlegen und auslesen, Wartungen einplanen, Protokolle übermitteln, Boo fragen — alles über eine REST-API mit Bearer-Key. Die maschinenlesbare Spezifikation liegt unter boomki.app/openapi.yaml (OpenAPI 3.1) und lässt sich direkt in Postman oder einen Codegenerator importieren.

Schnellstart

1. API-Key erzeugen

In Boomki unter Einstellungen → „API & Chat-Bots“ (nur Firmen-Owner oder -Admin). Der Key beginnt mit bk_live_ und wird genau einmal angezeigt — direkt sicher ablegen. Er gilt für den gesamten Workspace.

2. Maschinen auflisten

Liefert alle Maschinen mit id, Standort und Anlagenstruktur (parentId/parentName = „ist Teil von“). Die id ist der stabile Schlüssel für alle weiteren Aufrufe.

curl https://boomki.app/api/v1/machines \
  -H "Authorization: Bearer bk_live_…"

3. Maschine anlegen

Mit parentId hängt die neue Maschine direkt in der Anlagenstruktur. Dubletten-Schutz ist Standard: existiert der Name schon, antwortet die API mit 409 und der bestehenden id — ein wiederholter Import-Lauf erzeugt keine Doppelgänger.

curl -X POST https://boomki.app/api/v1/machines \
  -H "Authorization: Bearer bk_live_…" \
  -H "Content-Type: application/json" \
  -d '{"name": "Verdichter V3", "location": "Halle 2", "parentId": "…"}'

4. Protokoll senden oder Boo fragen

POST /api/v1/protocols legt Wartungs- und Störungsprotokolle an (aus Freitext oder Feldwerten, Standard ist ein Entwurf). POST /api/v1/ask beantwortet Technikerfragen aus dem Maschinenwissen — mit Quellen und Konfidenz. Details und alle Felder stehen in der Referenz unten.

In der Referenz unten lässt sich jeder Endpunkt direkt ausprobieren: oben rechts Authorize wählen, den Key einfügen, dann bei einem Endpunkt „Try it out".

Referenz