Consulta de saldo

Devuelve el estado de saldo de la cuenta a la que pertenece la API key actual, incluyendo saldo disponible, créditos acumulados y gasto acumulado.

Endpoint

GET https://api.ofox.io/v1/user/balance

El mismo endpoint también está expuesto a través de las entradas Anthropic / Gemini para reutilización por clientes ya configurados con otra Base URL:

Las tres URLs devuelven exactamente la misma estructura de respuesta.

Autenticación

Pase cualquier API key válida de OfoxAI (sk-...) mediante la cabecera Authorization: Bearer:

Authorization: Bearer sk-xxx

Ejemplo de solicitud

curl https://api.ofox.io/v1/user/balance \
  -H "Authorization: Bearer $OFOX_API_KEY"

import os
import requests
 
resp = requests.get(
    "https://api.ofox.io/v1/user/balance",
    headers={"Authorization": f"Bearer {os.environ['OFOX_API_KEY']}"},
)
data = resp.json()
print(f"Saldo disponible: ${data['balance']:.4f} {data['currency']}")

const resp = await fetch('https://api.ofox.io/v1/user/balance', {
  headers: { Authorization: `Bearer ${process.env.OFOX_API_KEY}` },
})
const data = await resp.json()
console.log(`Saldo disponible: $${data.balance.toFixed(4)} ${data.currency}`)

Formato de respuesta

Respuesta exitosa 200 OK:

{
  "is_active": true,
  "balance": 42.1357,
  "total": 100.0000,
  "used": 57.8643,
  "currency": "USD"
}

Campos de respuesta

Respuesta de error

Ante fallo de autenticación o error del servicio, se devuelve un código distinto de 200 con cuerpo compatible con cc-switch:

{
  "error": "unauthenticated",
  "is_active": false
}

Compatibilidad con herramientas de terceros

La estructura de respuesta es compatible con la plantilla de consulta de saldo de cc-switch  y funciona como proveedor de saldo directo para cc-switch:

• is_active para verificación de estado
• balance se mapea al campo remaining de cc-switch
• total / used para mostrar progreso de uso