Pular para o conteúdo principal
POST
/
api
/
v1
/
GetTeamCreditBalance
Obter Saldo de Créditos da Equipe
curl --request POST \
  --url https://server.codeium.com/api/v1/GetTeamCreditBalance \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_key": "<string>"
}
'
import requests

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

payload = { "service_key": "<string>" }
headers = {"Content-Type": "application/json"}

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

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

fetch('https://server.codeium.com/api/v1/GetTeamCreditBalance', 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/GetTeamCreditBalance",
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>'
]),
CURLOPT_HTTPHEADER => [
"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/GetTeamCreditBalance"

payload := strings.NewReader("{\n \"service_key\": \"<string>\"\n}")

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

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/GetTeamCreditBalance")
.header("Content-Type", "application/json")
.body("{\n \"service_key\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"service_key\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "promptCreditsPerSeat": 123,
  "numSeats": 123,
  "addOnCreditsAvailable": 123,
  "addOnCreditsUsed": 123,
  "billingCycleStart": "<string>",
  "billingCycleEnd": "<string>"
}

Visão geral

Obtenha as informações sobre o saldo atual de créditos da sua equipe. Isso inclui os créditos de prompt alocados por usuário, o número de usuários, o uso de créditos adicionais e as datas do ciclo de cobrança.

Requisição

service_key
string
obrigatório
Sua Service Key com permissão “Cobrança Read”

Exemplo de solicitação

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here"
}' \
https://server.codeium.com/api/v1/GetTeamCreditBalance

Response

promptCreditsPerSeat
integer
Número de créditos de prompt alocados por licença para o ciclo de cobrança atual
numSeats
integer
Número de licenças na equipe
addOnCreditsAvailable
integer
Total de créditos adicionais disponíveis para a equipe
addOnCreditsUsed
integer
Créditos adicionais consumidos até agora no ciclo de cobrança atual
billingCycleStart
string
Início do ciclo de cobrança atual (carimbo de data e hora ISO 8601)
billingCycleEnd
string
Fim do ciclo de cobrança atual (carimbo de data e hora ISO 8601)

Exemplo de resposta

{
  "promptCreditsPerSeat": 500,
  "numSeats": 50,
  "addOnCreditsAvailable": 10000,
  "addOnCreditsUsed": 3500,
  "billingCycleStart": "2026-01-01T00:00:00Z",
  "billingCycleEnd": "2026-02-01T00:00:00Z"
}

Respostas de erro

Cenários de erro comuns:
  • Chave de serviço inválida ou permissões insuficientes
  • Recurso não disponível no seu plano (requer o plano Enterprise)
  • Limite de requisições excedido