Consultar saldo del usuario

Obtiene el saldo restante y utilizado de la cuenta de usuario actual. Este endpoint devuelve información del saldo a nivel de usuario, independiente de tokens específicos, para visualizar el saldo total de la cuenta.

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

{
  "success": true,
  "remain_balance": 100.0,
  "used_balance": 25.5,
  "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/user/balance
GET /user/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 usuario (se devuelve en caso de éxito). Devuelve -1 cuando unlimited_quota es true

used_balance

float

Saldo utilizado del usuario (se devuelve en caso de éxito)

unlimited_quota

boolean

Indica si el usuario tiene cuota ilimitada. true significa ilimitada, false significa limitada

Saldo del token vs. saldo del usuario

Comparación	Saldo del token (`/v1/balance`)	Saldo del usuario (`/v1/user/balance`)
Alcance	Un único token	Toda la cuenta del usuario
Fuente de datos	RemainQuota y UsedQuota del token	quota y used_quota del usuario
Caso de uso	Monitorear el uso de una única API Key	Ver el saldo total de la cuenta
Limitado por	Límites de cuota a nivel de token	Límites de cuota a nivel de usuario

Casos de uso

Ver el saldo total de la cuenta del usuario
Configurar recordatorios de recarga y alertas de saldo
Mostrar el saldo de la cuenta en el panel del usuario

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

Usuario con cuota ilimitadaCuando un usuario se configura con cuota ilimitada:

El campo unlimited_quota devuelve true
El campo remain_balance devuelve -1
El usuario no tiene restricciones de cuota y puede usar la API sin límites

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 user quota	El usuario no existe	Compruebe si existe el usuario asociado al token
Failed to get used quota	Error en la consulta a la base de datos	Contacte al administrador para verificar el estado del sistema

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.

Documentation Index

​Autorización

​Endpoints

​Respuesta

​Saldo del token vs. saldo del usuario

​Casos de uso