Salt la conținutul principal
POST
https://server.codeium.com
/
api
/
v1
/
UsageConfig
Setați configurarea consumului
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 plafoane de utilizare pentru creditele de add-on ale organizației dvs. Puteți aplica aceste setări la nivel de echipă, pentru grupuri specifice sau pentru utilizatori individuali.

​
Cerere

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

​
Configurare plafon 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 ambele.

​
Configurarea ariei de aplicare (Alegeți una)

​
team_level
boolean
Setați la true pentru a aplica configurația la nivel de echipă
​
group_id
string
Aplicați configurația unui grup specific, furnizând ID-ul grupului
​
user_email
string
Aplicați configurația unui utilizator specific, furnizând adresa acestuia de e‑mail
Trebuie să furnizați unul dintre team_level, group_id sau user_email pentru a defini aria de aplicare.

​
Exemplu de solicitare – Setarea 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 cerere – Setarea plafonului de credite pentru 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 - Setarea plafonului de credite pentru un utilizator

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

​
Exemplu de solicitare – Eliminarea plafonului de credite

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 s-a încheiat cu succes.

​
Răspunsuri de eroare

Scenarii de eroare frecvente:
  • Cheie de serviciu nevalidă sau permisiuni insuficiente
  • Au fost furnizate atât clear_add_on_credit_cap, cât și set_add_on_credit_cap
  • Nu a fost furnizat nici clear_add_on_credit_cap, nici set_add_on_credit_cap
  • Au fost furnizați mai mulți parametri de scope
  • Nu a fost furnizat niciun parametru de scope
  • ID de grup sau e-mail de utilizator nevalid
  • Limită de rată depășită