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:in für Ihre Organisation ab. Limits sind immer pro Benutzer:in. Wenn Sie Konfigurationen auf Team- oder Gruppenebene abfragen, gibt die Antwort das pro Benutzer:in geltende Limit zurück, das auf Benutzer:innen innerhalb dieses Teams oder dieser Gruppe angewendet wurde.

​
Anfrage

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

​
Bereichskonfiguration (eine Option auswählen)

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

​
Beispielanfrage – Benutzerspezifische Obergrenze für alle Teammitglieder 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 – Limit 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 abfragen

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
Die konfigurierte Obergrenze für Add-on-Guthaben. Wenn dieses Feld in der Antwort nicht vorhanden ist, ist im angeforderten Geltungsbereich keine Obergrenze konfiguriert.

​
Beispielantwort – mit konfiguriertem Cap

{
  "addOnCreditCap": 10000
}

​
Beispielantwort – Kein Limit konfiguriert

{}

​
Fehlerantworten

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