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ă

Obțineți configurația curentă a limitei de credite suplimentare per utilizator pentru organizația dvs. Aceste limite sunt întotdeauna per utilizator. Atunci când interogați la nivel de echipă sau grup, răspunsul returnează limita per utilizator care a fost aplicată utilizatorilor din acea echipă sau acel grup.

​
Solicitare

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

​
Configurare domeniu (alegeți una)

​
team_level
boolean
Setați valoarea la true pentru a prelua limita per utilizator care se aplică tuturor utilizatorilor din echipă
​
group_id
string
Preluați limita per utilizator care se aplică tuturor utilizatorilor dintr-un anumit grup, furnizând ID-ul grupului
​
user_email
string
Preluați configurarea pentru un anumit utilizator, indicând adresa de e-mail a acestuia
Trebuie să specificaț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 membrii 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ținere limită per utilizator pentru toți utilizatorii dintr-un 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 cerere – 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 plafonului configurat pentru creditele suplimentare. Dacă acest câmp nu este prezent în răspuns, nu există niciun plafon configurat la nivelul de aplicare solicitat.

​
Exemplu de răspuns - cu plafon configurat

{
  "addOnCreditCap": 10000
}

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

{}

​
Răspunsuri de eroare

Scenarii comune de eroare:
  • 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 adresă de email a utilizatorului invalidă
  • limită de rată depășită