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ă

Stabiliți sau eliminați limite de utilizare per utilizator pentru creditele suplimentare din organizația dvs. Limitele sunt întotdeauna aplicate la nivel de utilizator. Când specificați o sferă de aplicare la nivel de echipă sau grup, limita este aplicată individual fiecărui utilizator din acea echipă sau acel grup — nu stabilește o limită comună pentru întreaga echipă sau întregul grup.

​
Solicitare

​
service_key
string
obligatoriu
Cheia dvs. de serviciu, cu permisiuni „Plăți Write”

​
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 limita per utilizator tuturor utilizatorilor din echipă
​
group_id
string
Aplicați limita per utilizator tuturor utilizatorilor dintr-un 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 pe utilizator pentru toți membrii echipei

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

​
Exemplu de request - Stabilire limită de credit per utilizator pentru toți utilizatorii unui grup

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

​
Exemplu de cerere - Setare plafon de credit pentru utilizator

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

​
Exemplu de cerere - Eliminare plafon de credit

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "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 reușit.

​
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ă