Nutzungskonfiguration abrufen
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
}Nutzungs-API
Nutzungskonfiguration abrufen
Ruft die geltende Obergrenze für Add-on-Credits pro Nutzer für ein Team, eine Gruppe oder einen einzelnen Nutzer ab – einschließlich der Obergrenzen, die von übergeordneten Geltungsbereichen vererbt werden.
POST
/
api
/
v1
/
GetUsageConfig
Nutzungskonfiguration abrufen
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
}Überblick
Ruft die effektive Add-on-Credit-Obergrenze pro Nutzer für Ihre Organisation ab. Obergrenzen gelten immer pro Nutzer. Die Antwort enthält die Obergrenze, die für das angefragte Subjekt tatsächlich durchgesetzt wird, nachdem die Konfigurationen aus übergeordneten Geltungsbereichen zusammengeführt wurden – also nicht nur eine Obergrenze, die direkt im angefragten Geltungsbereich konfiguriert ist.Anfrage
string
erforderlich
Ihr Service-Schlüssel mit „Billing Read“-Berechtigungen
Konfiguration des Geltungsbereichs (eine Option wählen)
boolean
Auf
true setzen, um die Obergrenze pro Nutzer auf Teamebene abzurufenstring
Geben Sie die Gruppen-ID an, um die effektive Obergrenze pro Nutzer für eine bestimmte Gruppe abzurufen. Das Ergebnis kombiniert die Obergrenze auf Teamebene mit der Überschreibung dieser Gruppe (sofern vorhanden). Weitere Gruppen, denen ein Nutzer angehören kann, sowie Überschreibungen auf Nutzerebene werden dabei nicht berücksichtigt.
string
Geben Sie die E-Mail-Adresse eines Nutzers an, um die effektive Obergrenze pro Nutzer für diesen Nutzer abzurufen. Das Ergebnis kombiniert die Obergrenze auf Teamebene, die Überschreibungen aller Gruppen, denen der Nutzer angehört, sowie eine etwaige Überschreibung auf Nutzerebene.
Sie müssen entweder
team_level, group_id oder user_email angeben, um den Geltungsbereich festzulegen.Beispielanfrage – Obergrenze pro Nutzer auf Team-Ebene abrufen
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
Beispielanfrage - Die effektive Pro-Nutzer-Obergrenze für eine Gruppe abrufen
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
Beispielanfrage - Effektive Obergrenze pro Nutzer für einen Nutzer abrufen
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
Antwort
integer
Die effektive Obergrenze für Add-on-Credits für das angefragte Subjekt. Bei Gruppen- und Nutzer-Geltungsbereichen kann dieser Wert von einem übergeordneten Geltungsbereich vererbt sein. Fehlt dieses Feld in der Antwort, gilt weder im angefragten Geltungsbereich noch in einem der Geltungsbereiche, von denen er erbt, eine Obergrenze.
Dieser Endpunkt gibt nicht an, aus welchem Geltungsbereich die zurückgegebene Obergrenze stammt. Eine Abfrage für eine Gruppe oder einen Nutzer kann eine vom Team (bzw. bei einem Nutzer von einer seiner Gruppen) vererbte Obergrenze zurückgeben, auch wenn im angefragten Geltungsbereich keine Überschreibung konfiguriert ist.
Beispielantwort – Mit aktiver Obergrenze
{
"addOnCreditCap": 10000
}
Beispielantwort – Keine Obergrenze aktiv
{}
Fehlerantworten
Häufige Fehlerfälle:- Ungültiger Service-Schlüssel oder unzureichende Berechtigungen
- Mehrere Parameter für den Geltungsbereich angegeben
- Kein Parameter für den Geltungsbereich angegeben
- Ungültige Gruppen-ID oder Nutzer-E-Mail
- Rate-Limit überschritten

