Zum Hauptinhalt springen
POST
/
api
/
v1
/
UsageConfig
Nutzung konfigurieren
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 benutzerbezogene Limits für die Nutzung von Add-on-Guthaben in Ihrer Organisation fest oder heben Sie sie auf. Limits werden immer pro Benutzer angewendet. Wenn Sie den Geltungsbereich auf ein Team oder eine Gruppe festlegen, wird das Limit für jeden einzelnen Benutzer innerhalb dieses Teams oder dieser Gruppe individuell angewendet – es legt kein gemeinsames Limit für das gesamte Team oder die gesamte Gruppe fest.

​
Anfrage

​
service_key
string
erforderlich
Ihr Service Key mit „Billing Write“-Berechtigungen

​
Konfiguration des Kreditlimits (eine Option auswählen)

​
clear_add_on_credit_cap
boolean
Auf true setzen, um das bestehende Add-on-Kreditlimit zu zurückzusetzen
​
set_add_on_credit_cap
integer
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 auswählen)

​
team_level
boolean
Auf true setzen, um die benutzerspezifische Obergrenze für alle Benutzer im Team anzuwenden
​
group_id
string
Die benutzerspezifische Obergrenze auf alle Benutzer in einer bestimmten Gruppe anwenden, indem die Gruppen-ID angegeben wird
​
user_email
string
Die Konfiguration auf einen bestimmten Benutzer anwenden, indem dessen E-Mail-Adresse angegeben wird
Es muss eines von team_level, group_id oder user_email angegeben werden, um den Geltungsbereich festzulegen.

​
Beispielanfrage – Kreditlimit pro Nutzer 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 – Kreditobergrenze pro Benutzer für alle Benutzer 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 – Kreditlimit 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 – Guthabenlimit 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 Antworttext ist leer. Ein 200-Statuscode zeigt an, dass der Vorgang erfolgreich war.

​
Fehlerantworten

Häufige Fehlerfälle:
  • 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
  • Rate Limit überschritten