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

​
Überblick

Rufen Sie die aktuelle Konfiguration des Add-on‑Guthabenlimits pro Benutzer für Ihre Organisation ab. Limits gelten immer pro Benutzer. Wenn Sie im Team- oder Gruppenkontext abfragen, gibt die Antwort das pro Benutzer geltende Limit zurück, das für Benutzer innerhalb dieses Teams bzw. dieser Gruppe festgelegt wurde.

​
Anfrage

​
service_key
string
erforderlich
Ihr Service Key mit “Billing Read”-Berechtigungen

​
Scope-Konfiguration (eine Option auswählen)

​
team_level
boolean
Auf true setzen, um die pro Benutzer geltende Obergrenze für alle Benutzer im Team abzurufen
​
group_id
string
Die pro Benutzer geltende Obergrenze für alle Benutzer in einer bestimmten Gruppe abrufen, indem die Gruppen-ID angegeben wird
​
user_email
string
Die Konfiguration für einen bestimmten Benutzer abrufen, indem dessen E-Mail-Adresse angegeben wird
Sie müssen eines von team_level, group_id oder user_email angeben, um den Geltungsbereich zu definieren.

​
Beispielanfrage – Per-User-Limit für alle Benutzer des Teams abrufen

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

​
Beispielanfrage – Nutzungsgrenze pro Benutzer für alle Benutzer in einer Gruppe abrufen

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

​
Beispielanfrage – Benutzerkonfiguration abrufen

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

​
Antwort

​
addOnCreditCap
integer
Der konfigurierte Credit-Limit-Wert für Add-ons. Wenn dieses Feld in der Antwort nicht vorhanden ist, ist für den angeforderten Geltungsbereich kein Limit konfiguriert.

​
Beispielantwort – mit konfiguriertem Cap

{
  "addOnCreditCap": 10000
}

​
Beispielantwort – Kein Limit festgelegt

{}

​
Fehlerantworten

Häufige Fehlerszenarien:
  • Ungültiger Service Key oder unzureichende Berechtigungen
  • Mehrere Scope-Parameter übergeben
  • Kein Scope-Parameter übergeben
  • Ungültige Gruppen-ID oder Benutzer-E-Mail-Adresse
  • Rate-Limit überschritten