> ## Documentation Index
> Fetch the complete documentation index at: https://gccai.heqingsong.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar saldo del token

>  - Consultar el crédito restante y utilizado de la API Key actual
- Monitorear el uso de un único token
- Soporte CORS para solicitudes de origen cruzado
- Monitoreo del saldo en tiempo real 

Obtiene el saldo restante y utilizado de la API Key (token) actual. Este endpoint se utiliza para monitorear el uso de un único token.

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://gccai.heqingsong.uk/v1/balance' \
    --header 'Authorization: Bearer <token>'
  ```

  ```python Python theme={null}
  import requests

  API_BASE = 'https://gccai.heqingsong.uk'
  API_KEY = 'sk-xxxxxxxxxxxxxxxxxxxxxx'

  headers = {
      'Authorization': f'Bearer {API_KEY}'
  }

  def get_token_balance():
      response = requests.get(f'{API_BASE}/v1/balance', headers=headers)
      data = response.json()
      
      if data.get('success'):
          if data.get('unlimited_quota'):
              print("Quota: Unlimited")
          else:
              print(f"Remaining balance: {data['remain_balance']}")
          print(f"Used balance: {data['used_balance']}")
      else:
          print(f"Query failed: {data.get('message')}")
      
      return data

  get_token_balance()
  ```

  ```javascript JavaScript theme={null}
  const API_BASE = 'https://gccai.heqingsong.uk';
  const API_KEY = 'sk-xxxxxxxxxxxxxxxxxxxxxx';

  async function getTokenBalance() {
    const response = await fetch(`${API_BASE}/v1/balance`, {
      headers: {
        'Authorization': `Bearer ${API_KEY}`
      }
    });
    
    const data = await response.json();
    
    if (data.success) {
      if (data.unlimited_quota) {
        console.log('Quota: Unlimited');
      } else {
        console.log(`Remaining balance: ${data.remain_balance}`);
      }
      console.log(`Used balance: ${data.used_balance}`);
    } else {
      console.error('Query failed:', data.message);
    }
    
    return data;
  }

  getTokenBalance();
  ```

  ```go Go theme={null}
  package main

  import (
      "encoding/json"
      "fmt"
      "io/ioutil"
      "net/http"
  )

  type BalanceResponse struct {
      Success        bool    `json:"success"`
      Message        string  `json:"message,omitempty"`
      RemainBalance  float64 `json:"remain_balance"`
      UsedBalance    float64 `json:"used_balance"`
      UnlimitedQuota bool    `json:"unlimited_quota"`
  }

  func main() {
      url := "https://gccai.heqingsong.uk/v1/balance"

      req, _ := http.NewRequest("GET", url, nil)
      req.Header.Set("Authorization", "Bearer <token>")

      client := &http.Client{}
      resp, err := client.Do(req)
      if err != nil {
          panic(err)
      }
      defer resp.Body.Close()

      body, _ := ioutil.ReadAll(resp.Body)
      
      var result BalanceResponse
      json.Unmarshal(body, &result)
      
      if result.Success {
          if result.UnlimitedQuota {
              fmt.Println("Quota: Unlimited")
          } else {
              fmt.Printf("Remaining balance: %.2f\n", result.RemainBalance)
          }
          fmt.Printf("Used balance: %.2f\n", result.UsedBalance)
      }
  }
  ```

  ```java Java theme={null}
  import java.net.http.HttpClient;
  import java.net.http.HttpRequest;
  import java.net.http.HttpResponse;
  import java.net.URI;

  public class Main {
      public static void main(String[] args) throws Exception {
          String url = "https://gccai.heqingsong.uk/v1/balance";

          HttpClient client = HttpClient.newHttpClient();
          HttpRequest request = HttpRequest.newBuilder()
              .uri(URI.create(url))
              .header("Authorization", "Bearer <token>")
              .GET()
              .build();

          HttpResponse<String> response = client.send(request,
              HttpResponse.BodyHandlers.ofString());

          System.out.println(response.body());
      }
  }
  ```

  ```php PHP theme={null}
  <?php

  $api_key = 'sk-xxxxxxxxxxxxxxxxxxxxxx';

  $ch = curl_init('https://gccai.heqingsong.uk/v1/balance');
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_HTTPHEADER, [
      "Authorization: Bearer $api_key"
  ]);

  $response = curl_exec($ch);
  curl_close($ch);

  $data = json_decode($response, true);

  if ($data['success']) {
      if ($data['unlimited_quota']) {
          echo "Quota: Unlimited\n";
      } else {
          echo "Remaining balance: " . $data['remain_balance'] . "\n";
      }
      echo "Used balance: " . $data['used_balance'] . "\n";
  } else {
      echo "Query failed: " . $data['message'] . "\n";
  }
  ?>
  ```

  ```ruby Ruby theme={null}
  require 'net/http'
  require 'json'
  require 'uri'

  api_key = 'sk-xxxxxxxxxxxxxxxxxxxxxx'

  url = URI("https://gccai.heqingsong.uk/v1/balance")

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

  request = Net::HTTP::Get.new(url)
  request["Authorization"] = "Bearer #{api_key}"

  response = http.request(request)
  data = JSON.parse(response.body)

  if data['success']
    if data['unlimited_quota']
      puts "Quota: Unlimited"
    else
      puts "Remaining balance: #{data['remain_balance']}"
    end
    puts "Used balance: #{data['used_balance']}"
  else
    puts "Query failed: #{data['message']}"
  end
  ```

  ```swift Swift theme={null}
  import Foundation

  let apiKey = "sk-xxxxxxxxxxxxxxxxxxxxxx"
  let url = URL(string: "https://gccai.heqingsong.uk/v1/balance")!

  var request = URLRequest(url: url)
  request.httpMethod = "GET"
  request.setValue("Bearer \(apiKey)", forHTTPHeaderField: "Authorization")

  let task = URLSession.shared.dataTask(with: request) { data, response, error in
      if let error = error {
          print("Error: \(error)")
          return
      }
      
      if let data = data, let responseString = String(data: data, encoding: .utf8) {
          print(responseString)
      }
  }

  task.resume()
  ```

  ```csharp C# theme={null}
  using System;
  using System.Net.Http;
  using System.Threading.Tasks;

  class Program
  {
      static async Task Main(string[] args)
      {
          var apiKey = "sk-xxxxxxxxxxxxxxxxxxxxxx";
          var url = "https://gccai.heqingsong.uk/v1/balance";

          using var client = new HttpClient();
          client.DefaultRequestHeaders.Add("Authorization", $"Bearer {apiKey}");

          var response = await client.GetAsync(url);
          var result = await response.Content.ReadAsStringAsync();

          Console.WriteLine(result);
      }
  }
  ```
</RequestExample>

<ResponseExample>
  ```json 200 - Success theme={null}
  {
    "success": true,
    "remain_balance": 10.5,
    "remain_credits": 105,
    "used_balance": 2.3,
    "used_credits": 23,
    "unlimited_quota": false
  }
  ```

  ```json 200 - Unlimited Quota Token theme={null}
  {
    "success": true,
    "remain_balance": -1,
    "remain_credits": -1,
    "used_balance": 2.3,
    "used_credits": 23,
    "unlimited_quota": true
  }
  ```

  ```json 200 - Token Not Found theme={null}
  {
    "success": false,
    "message": "Failed to get token info: record not found"
  }
  ```

  ```json 401 theme={null}
  {
    "error": {
      "code": 401,
      "message": "Invalid authentication credentials",
      "type": "authentication_error"
    }
  }
  ```

  ```json 429 theme={null}
  {
    "error": {
      "code": 429,
      "message": "Rate limit exceeded. Please try again later",
      "type": "rate_limit_error"
    }
  }
  ```
</ResponseExample>

## Autorización

<ParamField header="Authorization" type="string" required>
  Todos los endpoints de la API requieren autenticación mediante Bearer Token

  Obtenga su API Key:

  Visite la [página de gestión de API Keys](https://gccai.heqingsong.uk/keys) para obtener su API Key

  Añádala al encabezado de la solicitud:

  ```
  Authorization: Bearer YOUR_API_KEY
  ```
</ParamField>

## Endpoints

```
GET /v1/balance
GET /balance
```

Ambos endpoints tienen la misma funcionalidad; puede utilizar cualquiera de ellos.

## Respuesta

<ResponseField name="success" type="boolean">
  Indica si la solicitud fue exitosa
</ResponseField>

<ResponseField name="message" type="string">
  Mensaje de error (solo se devuelve en caso de fallo)
</ResponseField>

<ResponseField name="remain_balance" type="float">
  Saldo restante del token (se devuelve en caso de éxito). Devuelve `-1` cuando `unlimited_quota` es `true`
</ResponseField>

<ResponseField name="remain_credits" type="integer">
  Créditos restantes del token (se devuelve en caso de éxito). Devuelve `-1` cuando `unlimited_quota` es `true`
</ResponseField>

<ResponseField name="used_balance" type="float">
  Saldo utilizado del token (se devuelve en caso de éxito)
</ResponseField>

<ResponseField name="used_credits" type="integer">
  Créditos utilizados del token (se devuelve en caso de éxito)
</ResponseField>

<ResponseField name="unlimited_quota" type="boolean">
  Indica si el token tiene cuota ilimitada. `true` significa ilimitada, `false` significa limitada
</ResponseField>

## Casos de uso

* Monitorear el consumo de una única API Key
* Mostrar el saldo actual del token en su aplicación
* Configurar alertas de saldo cuando este caiga por debajo de un umbral

<Note>
  **Información sobre la unidad del saldo**

  La unidad del valor del saldo depende de la configuración del sistema:

  * **USD** - Dólares estadounidenses
  * **Credits** - Créditos
</Note>

<Tip>
  **Token con cuota ilimitada**

  Cuando un token se configura con cuota ilimitada:

  * El campo `unlimited_quota` devuelve `true`
  * El campo `remain_balance` devuelve `-1`
  * El campo `remain_credits` devuelve `-1`
  * El token no tiene restricciones de cuota y puede usarse sin límites
</Tip>

## Errores comunes

| Mensaje de error         | Causa                                         | Solución                                             |
| ------------------------ | --------------------------------------------- | ---------------------------------------------------- |
| No Authorization header  | No se proporcionó el encabezado Authorization | Añada el encabezado `Authorization: Bearer sk-xxxxx` |
| Failed to get token info | El token no existe o ha sido eliminado        | Compruebe si la clave del token es correcta          |

<Warning>
  **Nota de seguridad**

  Su API Key es como una contraseña. Manténgala segura y no la comparta con nadie. Utilice siempre HTTPS en producción.
</Warning>