Zum Hauptinhalt springen
GET
Read 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
name kann null sein. budgetPeriodSpend ist null, wenn der Workspace die Ausgaben pro Nutzer ausblendet. Sind die Ausgaben pro Nutzer ausgeblendet, fehlen Agenten, die nicht geteilt sind, in der Liste. Einen solchen Agenten zu lesen oder zu ändern gibt 404 zurück und ändert nichts. Geteilte Agenten bleiben in der Liste, mit budgetPeriodSpend auf null.
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

Antwort

Successful response.

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