API Abierta

Consultar tu saldo con una clave de API

Consulta la cuota restante de la clave actual con una clave de API sk-: GET /v1/user/balance devuelve is_active / balance / unit, y GET /v1/credits devuelve total_credits / total_usage al estilo OpenRouter. Compatible con el sondeo de clientes de terceros como cc-switch.

Con una clave de API que empieza por sk- puedes consultar directamente la cuota restante y la disponibilidad de esa clave. Está pensado para clientes de terceros que muestran el saldo en su interfaz, o para scripts que vigilan el saldo.

Estos endpoints son de solo lectura: no se facturan ni consumen cuota. La autenticación solo valida la clave, así que puedes seguir leyendo la cuota restante incluso cuando la cuota esté agotada y las llamadas de negocio se rechacen (en ese caso is_active es false).


1. Resumen de endpoints

EndpointFormato de cliente que admiteDevuelve
GET /v1/user/balancePlantilla genérica de saldo de cc-switchis_active / balance / unit, más used / total si la clave tiene cuota total
GET /user/balanceIgual que el anterior, para una Base URL sin /v1Idéntico a la fila anterior
GET /v1/creditsEstilo OpenRouterdata.total_credits / data.total_usage
ElementoValor
Base URLhttps://api.lmuai.com
AutenticaciónAuthorization: Bearer <sk-...>
Formato de respuestaJSON
¿Requiere inicio de sesión?No, basta con la clave de API

/user/balance es un alias de /v1/user/balance (se usa cuando el Base URL del cliente está configurado sin /v1). /v1/credits no tiene alias en la ruta raíz y debe incluir /v1.


2. Qué saldo se devuelve

balance no es necesariamente el saldo de la cartera de la cuenta: es la cuota restante realmente disponible para la clave actual, resuelta en este orden:

OrdenSituación de la claveQué significa balance
1La clave tiene su propia cuota totalLa cuota restante de esa clave (total - used)
2La clave pertenece a un grupo de suscripciónLa cuota restante de la suscripción (unit es requests cuando se cuenta por petición)
3Ninguno de los anterioresEl saldo de la cartera de la cuenta

Además, is_active indica si la clave puede usarse ahora para llamadas de negocio: es true cuando la clave está activa, no ha caducado y su cuota total no está agotada; también es false cuando la clave pertenece a un grupo de suscripción sin suscripción activa.


3. GET /v1/user/balance

GET /v1/user/balance HTTP/1.1
Host: api.lmuai.com
Authorization: Bearer sk-xxxxxxxx

Respuesta — modo saldo de cartera (la clave no tiene cuota y no está en un grupo de suscripción):

{
  "is_active": true,
  "balance": 1575.13,
  "unit": "USD"
}

Respuesta — la clave tiene cuota total (en este caso también se devuelven used y total):

{
  "is_active": true,
  "balance": 6,
  "unit": "USD",
  "used": 4,
  "total": 10
}

Respuesta — grupo de suscripción contado por petición:

{
  "is_active": true,
  "balance": 842,
  "unit": "requests"
}

Campos de la respuesta

CampoTipoDescripción
is_activeboolSi la clave puede usarse ahora para llamadas de negocio
balancenumberCuota restante; consulta unit para la unidad
unitstringUSD (por defecto), o requests en grupos de suscripción contados por petición
usednumberSolo presente cuando la clave tiene cuota total: cuota ya usada por esta clave
totalnumberSolo presente cuando la clave tiene cuota total: cuota total de esta clave

used / total solo tienen valores significativos en el modo de cuota por clave. Los modos de saldo de cartera y de suscripción no devuelven estos campos: usa balance y no lo deduzcas de total - used.


4. GET /v1/credits

Formato de saldo estilo OpenRouter; los clientes muestran la cuota restante como total_credits - total_usage.

GET /v1/credits HTTP/1.1
Host: api.lmuai.com
Authorization: Bearer sk-xxxxxxxx

Respuesta:

{
  "data": {
    "total_credits": 20,
    "total_usage": 4
  }
}
CampoTipoDescripción
data.total_creditsnumberUsado + restante, de modo que total_credits - total_usage sea exactamente la cuota restante
data.total_usagenumberCuota ya usada

total_credits es un valor compuesto de «usado + restante»; no es el límite literal de la cuota. En el modo saldo de cartera total_usage es 0 y total_credits equivale al saldo; cuando la cuota se agota, la cuota restante se recorta a 0, así que en ese caso total_credits equivale a la cantidad usada.


5. Configuración en clientes de terceros

Cliente / escenarioCómo configurarlo
Plantilla genérica de saldo de cc-switchLa Base URL https://api.lmuai.com (sin /v1) o https://api.lmuai.com/v1 (con /v1) funcionan igual
Clientes compatibles con OpenRouter (Kelivo, RikkaHub, etc.)Base URL https://api.lmuai.com/v1; el cliente solicitará /v1/credits
Script propioLlama directamente a /v1/user/balance; sus campos son más fáciles de leer
curl -s https://api.lmuai.com/v1/user/balance \
  -H "Authorization: Bearer sk-xxxxxxxx"

6. Respuestas de error

La consulta de saldo usa la autenticación estándar por clave API de la puerta de enlace, así que los errores tienen el mismo formato que en las demás llamadas a la API. Cuando la solicitud no incluye clave:

{
  "code": "API_KEY_REQUIRED",
  "message": "API key is required in Authorization header (Bearer scheme), x-api-key header, or x-goog-api-key header"
}
Código de estadocodeEscenario
200—Respuesta normal; una cuota agotada, una clave caducada o una suscripción inexistente también devuelven 200, con is_active: false para indicar que la clave no se puede usar
401API_KEY_REQUIREDLa solicitud no incluye clave API
401INVALID_API_KEYLa clave no existe o tiene un formato incorrecto
401API_KEY_DISABLEDLa clave está desactivada
403ACCESS_DENIEDLa clave tiene una lista de IP permitidas / bloqueadas y la IP actual no está permitida

Para los errores generales, consulta Códigos de error.


7. Diferencia con «Exportar detalles de uso»

Los endpoints de saldo de esta páginaExportar detalles de uso
AutenticaciónClave de API sk-Cuenta y contraseña canjeadas por un JWT
GranularidadCuota restante de la clave actualDetalles por petición a nivel de cuenta
Caso de usoMostrar el saldo en un cliente, monitorización de saldoExportación de facturas, conciliación, carga en un BI

GET /v1/usage se sitúa entre ambos: también acepta una clave sk- y devuelve las estadísticas de uso de hoy y acumuladas junto con la información de cuota de la clave actual, con campos más detallados.

Última actualización:

京ICP备2020034311号-7

En esta página