Saltar al contenido principal
GET
/
v1
/
balance
curl --request GET \
  --url 'https://api.apimart.ai/v1/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "unlimited_quota": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.apimart.ai/llms.txt

Use this file to discover all available pages before exploring further.

Obtiene el saldo restante y utilizado de la API Key (token) actual. Este endpoint se utiliza para monitorear el uso de un único token. 
curl --request GET \
  --url 'https://api.apimart.ai/v1/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "unlimited_quota": false
}

​
Autorización

​
Authorization
string
requerido
Todos los endpoints de la API requieren autenticación mediante Bearer TokenObtenga su API Key:Visite la página de gestión de API Keys para obtener su API KeyAñádala al encabezado de la solicitud:
Authorization: Bearer YOUR_API_KEY

​
Endpoints

GET /v1/balance
GET /balance
Ambos endpoints tienen la misma funcionalidad; puede utilizar cualquiera de ellos.

​
Respuesta

​
success
boolean
Indica si la solicitud fue exitosa
​
message
string
Mensaje de error (solo se devuelve en caso de fallo)
​
remain_balance
float
Saldo restante del token (se devuelve en caso de éxito). Devuelve -1 cuando unlimited_quota es true
​
used_balance
float
Saldo utilizado del token (se devuelve en caso de éxito)
​
unlimited_quota
boolean
Indica si el token tiene cuota ilimitada. true significa ilimitada, false significa limitada

​
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
Información sobre la unidad del saldoLa unidad del valor del saldo depende de la configuración del sistema:
  • USD - Dólares estadounidenses
  • CNY - Yuanes chinos
  • Tokens - Cantidad de tokens
Token con cuota ilimitadaCuando un token se configura con cuota ilimitada:
  • El campo unlimited_quota devuelve true
  • El campo remain_balance devuelve -1
  • El token no tiene restricciones de cuota y puede usarse sin límites

​
Errores comunes

Mensaje de errorCausaSolución
No Authorization headerNo se proporcionó el encabezado AuthorizationAñada el encabezado Authorization: Bearer sk-xxxxx
Failed to get token infoEl token no existe o ha sido eliminadoCompruebe si la clave del token es correcta
Nota de seguridadSu API Key es como una contraseña. Manténgala segura y no la comparta con nadie. Utilice siempre HTTPS en producción.