Vai al contenuto principale
POST
/
api
/
v1
/
GetUsageConfig
Recupera la configurazione di utilizzo
curl --request POST \
  --url https://server.codeium.com/api/v1/GetUsageConfig \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_key": "<string>",
  "team_level": true,
  "group_id": "<string>",
  "user_email": "<string>"
}
'
import requests

url = "https://server.codeium.com/api/v1/GetUsageConfig"

payload = {
"service_key": "<string>",
"team_level": True,
"group_id": "<string>",
"user_email": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
service_key: '<string>',
team_level: true,
group_id: '<string>',
user_email: '<string>'
})
};

fetch('https://server.codeium.com/api/v1/GetUsageConfig', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://server.codeium.com/api/v1/GetUsageConfig",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'service_key' => '<string>',
'team_level' => true,
'group_id' => '<string>',
'user_email' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://server.codeium.com/api/v1/GetUsageConfig"

payload := strings.NewReader("{\n \"service_key\": \"<string>\",\n \"team_level\": true,\n \"group_id\": \"<string>\",\n \"user_email\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://server.codeium.com/api/v1/GetUsageConfig")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"service_key\": \"<string>\",\n \"team_level\": true,\n \"group_id\": \"<string>\",\n \"user_email\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://server.codeium.com/api/v1/GetUsageConfig")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"service_key\": \"<string>\",\n \"team_level\": true,\n \"group_id\": \"<string>\",\n \"user_email\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "addOnCreditCap": 123
}

Panoramica

Recupera la configurazione attuale del limite dei crediti aggiuntivi per utente per la tua organizzazione. I limiti sono sempre per utente. Quando effettui una query con ambito team o gruppo, la risposta restituisce il limite per utente applicato agli utenti di quel team o gruppo.

Richiesta

service_key
string
obbligatorio
La tua chiave di servizio con autorizzazione “Billing Read”

Configurazione dell’ambito (scegline uno)

team_level
boolean
Imposta su true per recuperare il limite per utente applicato a tutti gli utenti del team
group_id
string
Recupera il limite per utente applicato a tutti gli utenti di un gruppo specifico fornendo l’ID del gruppo
user_email
string
Recupera la configurazione per un utente specifico fornendo il suo indirizzo email
Devi fornire uno tra team_level, group_id o user_email per definire l’ambito.

Richiesta di esempio - Recuperare il limite per utente per tutti gli utenti del team

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

Richiesta di esempio - GET del limite per utente per tutti gli utenti di un gruppo

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

Richiesta di esempio - Recuperare la configurazione dell’utente

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

Risposta

addOnCreditCap
integer
Il valore configurato del limite dei crediti aggiuntivi. Se questo campo non è presente nella risposta, non è configurato alcun limite nell’ambito richiesto.

Esempio di risposta - Con limite impostato

{
  "addOnCreditCap": 10000
}

Risposta di esempio - Nessun limite configurato

{}

Risposte di errore

Scenari di errore comuni:
  • Chiave del servizio non valida o autorizzazioni insufficienti
  • Sono stati forniti più parametri ambito
  • Non è stato fornito alcun parametro ambito
  • ID del gruppo o email dell’utente non validi
  • Limite di richieste superato