Zum Hauptinhalt springen
Mit der Billing API änderst du Nutzerpläne, Limits für den Workspace und für Gruppen und Budgets von Agenten aus deinen eigenen Systemen. Nutze sie, wenn die Änderung eines Admins Langdock aktualisieren soll, ohne dass jemand die Nutzungseinstellungen öffnet. Du kannst außerdem Nutzungslimit-Anfragen auflisten und eine Anfrage ablehnen, die noch offen ist. Die User Management API lädt Personen ein, ändert Rollen und deaktiviert Mitglieder. Die Billing API macht das nicht. Gruppenmitgliedschaften ändert sie ebenfalls nicht.
Starte mit GET /billing/v1/mode und rufe danach nur die Routen dieses Modus auf. Ein Dedicated Deployment liefert immer bring-your-own-keys, auch wenn Langdock die Modellschlüssel verwaltet. Ein Cloud-Workspace liefert ai-models-included, wenn Langdock die Modelle bereitstellt, und bring-your-own-keys, wenn der Workspace eigene Schlüssel mitbringt. Den Scope Billing API kannst du in der Cloud und in Dedicated Deployments vergeben. Die Routen des anderen Modus antworten mit 409.

Bevor du startest

  • API-Key-Scope: BILLING_API an einem Workspace-API-Schlüssel. In der Scope-Auswahl heißt der Scope Billing API und steht in der Gruppe Billing, nach User Management und vor Audit Log. Persönliche API-Schlüssel können den Scope nicht bekommen. Bestehende Workspace-Schlüssel erhalten ihn nicht von allein.
  • Besitzer: Der Schlüssel gehört einem Service Account, der nicht gelöscht ist und eine aktive Admin-Mitgliedschaft hat. Schreibzugriffe laufen als dieser Service Account. Fehlt die Mitgliedschaft, kommt 403 mit code BILLING_API_ADMIN_REQUIRED.
  • Namen und E-Mails: Nutzerobjekte enthalten immer id, den Plan und die Limits. email und name sind nur dabei, wenn derselbe Schlüssel auch USER_MANAGEMENT_API hat. Ein Filter auf email ohne diesen Scope gibt 403 mit code USER_MANAGEMENT_API_REQUIRED zurück.
Starte mit der Modusabfrage und rufe danach nur die Routen dieses Modus auf. Der andere Modus antwortet mit 409, code BILLING_MODE_MISMATCH und dem Workspace-Modus in details.mode.

Basis-URL

Dedicated DeploymentsErsetze api.langdock.com durch <your-deployment-url>/api/public in allen Anfragen.

Billing-Modus

bring-your-own-keys rechnet in US-Dollar:
Die Pläne sind standard (Standard) und power_user (Power User). Es gibt keine Seats-Route. ai-models-included rechnet in Euro:
Die Pläne sind business (Business) und business_max (Business Max). Es gibt keine Route, die Mitglieder pro Plan zählt. Bezahlte Seats stehen unter Seats abrufen. Ein Pfad, den es im Workspace-Modus nicht gibt, zum Beispiel Seats unter bring-your-own-keys oder die Planzählung unter ai-models-included, gibt 404 zurück.

Limits

Ein Limit schickst und liest du in einer dieser Formen. Nur limited enthält amount.
Ein begrenztes Workspace-Limit muss größer als null sein. Ein begrenzter Betrag an einem Plan, einem Mitglied oder einer Gruppe darf null sein. Ein begrenztes Agent-Budget muss größer als null sein. In bring-your-own-keys akzeptieren Extra-Usage-Budgets auch { "type": "none" }. none entfernt dieses Extra-Kontingent. Agent-Budgets akzeptieren none in beiden Modi. none entfernt das eigene Agent-Budget. In ai-models-included akzeptiert das Extra-Nutzungslimit eines Mitglieds auch { "type": "inherit" }. inherit nutzt die Vorgaben von Plan und Gruppe. Ein Gruppenlimit akzeptiert weder inherit noch none. Ein PATCH braucht mindestens ein Feld, das du schreiben darfst. Felder, die du weglässt, bleiben. In bring-your-own-keys behält ein Plan sein Budget, wenn du ihn in monthlyBudgetPerPlan nicht mitschickst. In ai-models-included behält ein Plan sein Limit, wenn du ihn in defaultExtraUsageLimitPerPlan nicht mitschickst. Unbekannte Felder werden abgelehnt.

Listen und Ausgaben

Listen liefern standardmäßig 50 Einträge. limit liegt zwischen 1 und 250. Gib cursor aus dem nextCursor der vorigen Seite zurück und behalte dieselben Filter. Auf der letzten Seite fehlt nextCursor. Gib den Cursor unverändert zurück. GET liefert Ausgaben, wenn der Workspace die Ausgaben pro Nutzer zeigt. Sind sie ausgeblendet, ist das Ausgabenfeld null. Schreibzugriffe auf Nutzer, Einstellungen und Agenten setzen die Ausgaben immer auf null, damit ein erfolgreicher Schreibzugriff nicht an einer nachgeladenen Summe scheitert. Lies die Ressource danach erneut, um die Ausgaben zu bekommen.

Bring your own keys

AI-Modelle inklusive

Beträge auf diesen Routen sind Euro. Ruf sie auf, wenn die Modusabfrage ai-models-included liefert.

Fehler

Langdock blockiert bewusst Browser-basierte Anfragen, um deinen API-Schlüssel zu schützen und die Sicherheit deiner Anwendungen zu gewährleisten. Weitere Informationen findest du in unserem Guide zu Best Practices für API-Schlüssel.