Salt la conținutul principal
POST
/
api
/
v1
/
GetUsageConfig
Obțineți configurația de utilizare
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
}

​
Prezentare generală

Preluați configurația curentă a plafonului de credite suplimentare per utilizator pentru organizația dvs. Plafoanele sunt întotdeauna stabilite per utilizator. Când interogați la nivel de echipă sau de grup, răspunsul returnează plafonul per utilizator care a fost aplicat utilizatorilor din acea echipă sau din acel grup.

​
Cerere

​
service_key
string
obligatoriu
Cheia dvs. de serviciu cu permisiunea „Plăți Read”

​
Configurare domeniu de aplicare (Alegeți una dintre opțiuni)

​
team_level
boolean
Setați valoarea la true pentru a obține limita per utilizator aplicată tuturor membrilor echipei
​
group_id
string
Obțineți limita per utilizator aplicată tuturor utilizatorilor dintr-un anumit grup, furnizând ID-ul grupului
​
user_email
string
Obțineți configurarea pentru un utilizator specific furnizând adresa sa de email
Trebuie să furnizați unul dintre team_level, group_id sau user_email pentru a defini domeniul de aplicare.

​
Exemplu de cerere - Obținerea limitei per utilizator pentru toți utilizatorii din cadrul echipei

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

​
Exemplu de cerere – Obținerea limitei per utilizator pentru toți utilizatorii unui grup

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

​
Exemplu de solicitare - Obținerea configurației utilizatorului

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

​
Răspuns

​
addOnCreditCap
integer
Valoarea configurată pentru limita de credite a add-on-ului. Dacă acest câmp nu este prezent în răspuns, nu există nicio limită configurată la nivelul de scope solicitat.

​
Exemplu de răspuns - cu limită setată

{
  "addOnCreditCap": 10000
}

​
Exemplu de răspuns - fără plafon configurat

{}

​
Răspunsuri de eroare

Scenarii de eroare frecvente:
  • cheie de serviciu invalidă sau permisiuni insuficiente
  • au fost furnizați mai mulți parametri scope
  • nu a fost furnizat niciun parametru scope
  • ID de grup sau email de utilizator invalid
  • limită de rată a cererilor depășită