betool betool

Dokumentation

Admin-API

Automatisieren Sie betool aus Ihren Systemen heraus — Pipeline-Erstellung, Ausführungshistorie, Organisationsverwaltung.

Admin-API

Die gesamte betool-Administration ist über eine authentifizierte REST-API zugänglich. Dies ist der Kanal für die Automatisierung: spontanes Provisioning von Organisationen, Pipeline-Synchronisierung aus Ihrem Git-Repository, individuelle Dashboards, ITSM-Integration.

Authentifizierung

Bearer-Token, ausgestellt unter Administration → Tokens innerhalb Ihrer Organisation.

curl -H "Authorization: Bearer $BETOOL_TOKEN" \
  https://platform.betool.ai/api/admin/me

Der Token ist auf eine Organisation und eine Rolle begrenzt. Die Rolle bestimmt, was Sie lesen und schreiben können.

Paginierung & Filterung

Alle Listen-Endpunkte folgen derselben Konvention:

  • ?limit=50 (Standard 25, Maximum 200)
  • ?offset=0
  • ?sort=-created_at (Präfix - für absteigend)
  • Ad-hoc-Filter: ?status=ok&created_after=2026-05-01

Die Antwort enthält einen Header X-Total-Count für eine cursorlose Paginierung.

Wichtige Endpunkte

EndpunktBeschreibung
GET /api/admin/meIdentität, aktuelle Organisation, Rolle
GET /api/admin/pipelinesPipelines auflisten
POST /api/admin/pipelinesEine Pipeline erstellen
PATCH /api/admin/pipelines/{id}Eine Pipeline aktualisieren
GET /api/admin/pipelines/{id}/executionsAusführungshistorie
GET /api/admin/billing/balanceGuthabenstand
POST /api/admin/billing/topupManuelle Aufladung
GET /api/admin/me/content-readsAudit-Protokoll mandantenübergreifender Zugriffe

Die vollständige OpenAPI-Dokumentation ist nach der Authentifizierung unter /api/admin/openapi.json verfügbar.

Idempotenz

POST-Endpunkte akzeptieren einen Header Idempotency-Key. Wenn Sie dieselbe Anfrage mit demselben Schlüssel erneut senden, erhalten Sie dieselbe Antwort — nützlich für aufruferseitige Retry-Strategien.

Ausgehende Webhooks

Konfigurieren Sie betool so, dass es Sie bei wichtigen Ereignissen benachrichtigt (fehlgeschlagene Ausführung, niedriges Guthaben, neuer Nutzer). Siehe Ausgehende Webhooks.

Rate-Limiting

Standardmäßig:

  • 1.000 Anfragen / Minute pro Token
  • 100 Anfragen / Minute für kostenintensive Schreib-Endpunkte (Pipeline-Erstellung, Batch-Import)

Im Enterprise-Plan sind die Limits konfigurierbar.

SDKs

Es gibt (noch) keine offiziellen SDKs. Die API ist einfach genug, um sie aus jeder Sprache mit einem HTTP-Client zu konsumieren.

Wenn Sie ein SDK für Ihre Organisation schreiben, sagen Sie uns Bescheid — wir listen es auf.