Salt la conținutul principal
POST
/
api
/
v1
/
UsageConfig
Setați configurarea utilizării
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>"
}'

​
Prezentare generală

Setați sau eliminați plafoanele de utilizare pentru creditele add-on ale organizației dvs. Puteți aplica aceste configurații la nivel de echipă, pentru grupuri specifice sau pentru utilizatori individuali.

​
Solicitare

​
service_key
string
required
Cheia dvs. de serviciu, cu permisiunile corespunzătoare

​
Configurare plafon de credit (Alegeți una)

​
clear_add_on_credit_cap
boolean
Setați la true pentru a elimina plafonul de credit suplimentar existent
​
set_add_on_credit_cap
integer
Setați un nou plafon de credit suplimentar (valoare întreagă)
Trebuie să furnizați fie clear_add_on_credit_cap, fie set_add_on_credit_cap, dar nu pe ambele.

​
Configurarea ariei de aplicare (Alegeți una)

​
team_level
boolean
Setați la true pentru a aplica configurarea la nivelul echipei
​
group_id
string
Aplicați configurarea unui anumit grup, furnizând ID-ul grupului
​
user_email
string
Aplicați configurarea unui anumit utilizator, furnizând adresa sa de email
Trebuie să furnizați unul dintre team_level, group_id sau user_email pentru a defini aria de aplicare.

​
Exemplu de solicitare – Stabilirea plafonului de credite pentru echipă

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "cheia_dumneavoastră_de_serviciu_aici",
  "set_add_on_credit_cap": 10000,
  "team_level": true
}' \
https://server.codeium.com/api/v1/UsageConfig

​
Exemplu de solicitare – setare plafon de credite pentru grup

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "cheia_dvs_de_serviciu_aici",
  "set_add_on_credit_cap": 5000,
  "group_id": "echipa_de_inginerie"
}' \
https://server.codeium.com/api/v1/UsageConfig

​
Exemplu de solicitare – stabilirea plafonului de credite pentru un utilizator

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "cheia_dvs_de_serviciu_aici",
  "set_add_on_credit_cap": 1000,
  "user_email": "utilizator@exemplu.com"
}' \
https://server.codeium.com/api/v1/UsageConfig

​
Exemplu de solicitare – Clarificarea plafonului de credite

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

​
Răspuns

Corpul răspunsului este gol. Un cod de stare 200 indică faptul că operațiunea a fost realizată cu succes.

​
Răspunsuri la erori

Scenarii de eroare frecvente:
  • Cheie de serviciu invalidă sau permisiuni insuficiente
  • Atât clear_add_on_credit_cap, cât și set_add_on_credit_cap sunt furnizate
  • Nici clear_add_on_credit_cap, nici set_add_on_credit_cap nu sunt furnizate
  • Sunt furnizați mai mulți parametri de scope
  • Nu este furnizat niciun parametru de scope
  • ID de grup invalid sau adresa de email a utilizatorului invalidă
  • Limită de rate depășită