Zum Hauptinhalt springen
PATCH
Update an agent budget in USD
Lies und ändere monatliche Agent-Budgets in US-Dollar. Für diesen Workspace-Modus nutzt du das Präfix bring-your-own-keys. Die Aufrufe laufen ü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

Budget ändern

PATCH /agents/{agentId} akzeptiert budget, budgetMode oder beides. Schick mindestens eines.
budget ist ein Monatsbetrag:
  • { "type": "limited", "amount": 40 } setzt eine Obergrenze. Der Betrag muss größer als null sein.
  • { "type": "unlimited" } behält ein eigenes Budget ohne Zahlenobergrenze. Ausgaben können weiter gemeldet werden. Das ist nicht dasselbe wie none.
  • { "type": "none" } entfernt das eigene Agent-Budget. Der Agent folgt dann den Workspace- und Mitgliederlimits.
budgetMode legt fest, wann dieses Budget gilt:
  • always (Immer) rechnet Nutzung sofort auf das Agent-Budget an, einschließlich API-Aufrufen, und verbraucht nicht das Kontingent des Mitglieds.
  • on_limit_hit (Nach Nutzerlimits) rechnet Nutzung zuerst auf die Limits des Mitglieds an. Erst wenn das Mitglied ein persönliches Limit erreicht, zählt die Nutzung auf das Agent-Budget.
Ein aktives Agent-Budget folgt weiter dem Workspace-Limit und dem Agent-Limit-Verhalten aus den Billing Workspace-Einstellungen. Ein Budget zu entfernen schaltet diese Kontrollen nicht ab. Die Antwort ist das Agent-Objekt mit budgetPeriodSpend auf null. Lies den Agenten erneut, um die Ausgaben zu bekommen.
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"

Pfadparameter

agentId
string<uuid>
erforderlich

Body

application/json
budget
object

Monthly budget in the mode currency. none follows workspace/member limits; unlimited keeps a separate budget without a numeric cap.

budgetMode
enum<string>
Verfügbare Optionen:
always,
on_limit_hit

Antwort

Updated resource. Spending is null; GET retrieves spending.

Monthly budget in mode currency, subject to workspace enforcement. always uses agent allowance; on_limit_hit uses it after the member allowance. Spend is null when user-level usage is hidden and always null on PATCH.

id
string<uuid>
erforderlich
name
string | null
erforderlich
budget
object
erforderlich

Monthly budget in the mode currency. none follows workspace/member limits; unlimited keeps a separate budget without a numeric cap.

budgetMode
enum<string>
erforderlich
Verfügbare Optionen:
always,
on_limit_hit
budgetPeriodSpend
number | null
erforderlich
Erforderlicher Bereich: x >= 0