Zum Hauptinhalt springen
POST
/
api
/
v1
/
UsageConfig
Nutzungskonfiguration einrichten
curl --request POST \
  --url https://server.codeium.com/api/v1/UsageConfig \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_key": "<string>",
  "clear_add_on_credit_cap": true,
  "set_add_on_credit_cap": 123,
  "team_level": true,
  "group_id": "<string>",
  "user_email": "<string>"
}
'

​
Übersicht

Legen Sie nutzerspezifische Nutzungslimits für Add-on-Guthaben in Ihrer Organisation fest oder setzen Sie sie zurück. Limits werden immer pro Nutzer angewendet. Wenn Sie den Geltungsbereich auf ein Team oder eine Gruppe festlegen, wird das Limit für jeden Nutzer innerhalb dieses Teams bzw. dieser Gruppe individuell angewendet – es definiert kein gemeinsames Limit für das gesamte Team oder die gesamte Gruppe.

​
Anfrage

​
service_key
string
erforderlich
Ihr Service-Schlüssel mit „Billing Write“-Berechtigungen

​
Konfiguration des Kreditlimits (eine Option wählen)

​
clear_add_on_credit_cap
boolean
Auf true setzen, um das bestehende Add-on-Kreditlimit zurückzusetzen
​
set_add_on_credit_cap
integer
Ein neues Add-on-Kreditlimit festlegen (Ganzzahl)
Sie müssen entweder clear_add_on_credit_cap oder set_add_on_credit_cap angeben, aber nicht beides.

​
Bereichskonfiguration (eine Option wählen)

​
team_level
boolean
Auf true setzen, um das Limit pro Benutzer auf alle Benutzer im Team anzuwenden
​
group_id
string
Das Limit pro Benutzer auf alle Benutzer in einer bestimmten Gruppe anwenden, indem Sie die Gruppen-ID angeben
​
user_email
string
Die Konfiguration auf einen bestimmten Benutzer anwenden, indem Sie dessen E‑Mail‑Adresse angeben
Sie müssen eines von team_level, group_id oder user_email angeben, um den Geltungsbereich festzulegen.

​
Beispielanfrage – Kreditlimit pro Benutzer für alle Teammitglieder festlegen

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "set_add_on_credit_cap": 10000,
  "team_level": true
}' \
https://server.codeium.com/api/v1/UsageConfig

​
Beispielanfrage – Pro-Benutzer-Kreditobergrenze für alle Nutzer in einer Gruppe festlegen

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "set_add_on_credit_cap": 5000,
  "group_id": "engineering_team"
}' \
https://server.codeium.com/api/v1/UsageConfig

​
Beispielanfrage – Kreditobergrenze für einen Benutzer festlegen

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "set_add_on_credit_cap": 1000,
  "user_email": "user@example.com"
}' \
https://server.codeium.com/api/v1/UsageConfig

​
Beispielanfrage – Credit-Limit aufheben

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "clear_add_on_credit_cap": true,
  "team_level": true
}' \
https://server.codeium.com/api/v1/UsageConfig

​
Antwort

Der Antwortinhalt ist leer. Ein 200-Statuscode weist darauf hin, dass der Vorgang erfolgreich war.

​
Fehlerantworten

Häufige Fehlerszenarien:
  • Ungültiger Service Key oder unzureichende Berechtigungen
  • Sowohl clear_add_on_credit_cap als auch set_add_on_credit_cap übergeben
  • Weder clear_add_on_credit_cap noch set_add_on_credit_cap übergeben
  • Mehrere Scope-Parameter übergeben
  • Kein Scope-Parameter übergeben
  • Ungültige Gruppen-ID oder Benutzer-E-Mail-Adresse
  • Ratenlimit überschritten