Zum Hauptinhalt springen
GET
Read USD workspace settings
Lies und ändere die Workspace-Limits und Planbudgets für den Modus bring-your-own-keys. Beträge sind US-Dollar. Der Aufruf läuft über den BILLING_API Scope des Workspace-API-Schlüssels. Schreibzugriffe laufen als der Service Account, dem der Schlüssel gehört.

Basis-URL

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

Voraussetzungen

  • API-Schlüssel mit dem Scope BILLING_API
  • Der Besitzer ist ein Service Account, der nicht gelöscht ist und eine aktive Admin-Mitgliedschaft hat

Einstellungen lesen

GET /billing/v1/bring-your-own-keys/settings liefert die aktuellen Einstellungen.
workspaceUsageLimit deckelt enthaltene und Extra-Nutzung von Chat und Agenten in usagePeriod. Persönliche API-Nutzung zählt auf dieses Limit, ebenso Agent-API-Aufrufe mit einem Workspace-Schlüssel, wenn das Agent-Budget always mit einem begrenzten Betrag ist. Andere Workspace-API-Nutzung, Workflow-Ausführungen und die Nutzung des Backbone-Modells zählen nicht mit. usagePeriodSpend ist die Nutzung, die auf dieses Limit angerechnet wird. monthlyBudgetPerPlan ist das enthaltene Kontingent für Standard (standard) und Power User (power_user). Wochen- und Session-Budgets werden abgeleitet. Du kannst sie nicht schreiben. Die Woche ist das Monatsbudget geteilt durch 4. Die Session ist das Wochenbudget geteilt durch 3. Ein unbegrenztes Monatsbudget bleibt in diesen Fenstern unbegrenzt. sessionBudgetPerPlan ist null, wenn Session-Limits aus sind. Das Monatsbudget setzt diese Fenster. Extra Usage kann starten, sobald das enthaltene Wochen- oder Session-Kontingent aufgebraucht ist. Es ist keine Zusage, dass Extra Usage erst nach einem Kalendermonat beginnt. usageRequestsEnabled erlaubt Mitgliedern, einen Admin um mehr Nutzung zu bitten. agentLimitBehavior.forced legt fest, was nach einem Nutzer- oder Agent-Limit passiert:
  • null überlässt die Wahl dem Agent-Besitzer (Agent-Besitzer entscheidet).
  • switch_model wechselt auf das Fallback-Modell (Modell wechseln). Dafür brauchst du ein gültiges Fallback.
  • block_usage stoppt den Agenten (Nutzung blockieren).
fallbackModelId ist das konfigurierte Fallback. null nutzt das Backbone-Modell des Workspace. switch_model braucht auch dann ein gültiges Modell.
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.

Autorisierungen

Authorization
string
header
erforderlich

API key as Bearer token. Format "Bearer YOUR_API_KEY"

Antwort

Successful response.

USD included and extra chat/agent usage; excludes workflow, API, and backbone-model usage. Weekly budgets are monthly / 4; session budgets are weekly / 3 and null when disabled. PATCH returns null spending; GET retrieves spending.

currency
enum<string>
erforderlich
Verfügbare Optionen:
USD
usageRequestsEnabled
boolean
erforderlich
workspaceUsageLimit
object
erforderlich
monthlyBudgetPerPlan
object
erforderlich
sessionLimitsEnabled
boolean
erforderlich
agentLimitBehavior
object
erforderlich

Forcing switch_model requires a valid fallback model. null forced uses each agent setting. fallbackModelId is the configured override; null uses the workspace backbone fallback.

weeklyBudgetPerPlan
object
erforderlich
sessionBudgetPerPlan
object | null
erforderlich
usagePeriod
object
erforderlich
usagePeriodSpend
number | null
erforderlich
Erforderlicher Bereich: x >= 0