Nexscope

Account credits

Read the committed account credit balance and gross ledger consumption.

Coste0 credits / call
Probar en línea

Casos de uso de Account credits

Plan API Gastos

Un desarrollador de aplicaciones comprueba el saldo de crédito de la cuenta comprometida antes de planificar más pagado API El resultado muestra el saldo de la cuenta y el consumo registrado para el período solicitado.

Consumo registrado de la revisión

Un analista financiero recupera el consumo de crédito para una ventana de tiempo definida y lo compara con registros internos. El analista utiliza los campos de balance documentados para distinguir los saldos del consumo.

Construir un tablero de cuentas

Un desarrollador llama al punto final de Créditos de Cuenta desde un panel interno usando un usuario API clave. El panel muestra la información de la cuenta devuelta sin necesidad de una exportación manual.

Preguntas frecuentes sobre Account credits

¿Qué devuelve la consulta de créditos?

Devuelve el saldo de créditos de Nexscope y el consumo registrado en la cuenta. Los resultados corresponden al período solicitado. Consulta las tablas para conocer el significado de cada campo. Los cargos pendientes pueden aparecer más tarde y cada consulta usa su propia instantánea.

¿Cuántos créditos cuesta la consulta?

La consulta es gratuita y cuesta 0 créditos. Lee los datos contabilizados sin registrar una llamada de negocio. Puedes usar este GET gratuito con un saldo de cero o negativo. Los dos endpoints de cuenta comparten un límite de 60 solicitudes por cuenta cada 60 segundos.

¿Cómo se realiza la consulta?

Envía una solicitud GET a /api/skill-api/v1/account/credits con una clave API de usuario GENERAL en el encabezado Authorization: Bearer. Introduce las fechas opcionales como parámetros de consulta. La tabla describe el intervalo de tiempo en UTC. La consulta requiere una clave API de usuario. Los tokens de sesión y las claves de complementos carecen de autorización.

Ver planes y créditos

Related APIs

API de cuenta

Vista general de la API

Read the committed account credit balance and gross ledger consumption.

Endpoint
GET /api/skill-api/v1/account/credits

Autenticación

Envía una clave de API de usuario GENERAL en la cabecera Authorization Bearer. Los JWT del sitio web, las claves de plugins y los tokens de instalación no pueden llamar a este endpoint. Un saldo cero o negativo no bloquea este GET gratuito.

Authorization: Bearer YOUR_API_KEY

Ejecutar API

Lee datos confirmados de la cuenta sin consumir créditos ni añadir una llamada de API de negocio. Ambas consultas comparten un límite de 60 solicitudes por cuenta cada 60 segundos.

GET/api/skill-api/v1/account/credits

Ejecutar esta API

Endpoint

MétodoGET
Ruta/api/skill-api/v1/account/credits
AutenticaciónBearer API key
Cuerpo de la solicitudNinguno. Los parámetros opcionales son campos de consulta.

Ejemplo de código

2026-04-28T20:26:40.000Z → 1777408000000; 2026-05-28T20:26:40.000Z → 1780000000000.

curl -H "Authorization: Bearer YOUR_API_KEY" "https://api.nexscope.ai/api/skill-api/v1/account/credits?startTime=1777408000000&endTime=1780000000000"

Parámetros de la solicitud

La API usa milisegundos desde la época UTC. En la prueba en línea, introduce la fecha y hora UTC; el área de pruebas convierte esos campos UTC a milisegundos sin usar la zona horaria del navegador. Sin fechas, se usan los 30 días anteriores. Si se proporciona un solo límite, el otro se completa con un intervalo de 30 días o la hora actual. La ventana es [startTime, endTime), no puede superar 180 días ni terminar en el futuro.

NombreTipoObligatorioDescripción
endTimestringopcional
Optional UTC epoch milliseconds, exclusive. The window must end no later than the request time.
startTimestringopcional
Optional UTC epoch milliseconds, inclusive. Enter UTC date and time in the tester; the API receives a decimal millisecond string.

Ejemplo de respuesta

Sobre ResponseData completo. cost es el tiempo de procesamiento en milisegundos, no los créditos cobrados.

{
  "code": 0,
  "msg": null,
  "data": {
    "scope": "ACCOUNT",
    "observedAt": "1780000000000",
    "startTime": "1777408000000",
    "endTime": "1780000000000",
    "permanentCredit": "120",
    "cycleCredit": "30",
    "debt": "5",
    "netCredit": "145",
    "grossConsumedCredit": "40",
    "quota": null
  },
  "ts": "1780000000000",
  "time": "2026-05-28 20:26:40",
  "cost": "13",
  "traceId": null
}

Campos de respuesta

Los créditos Int64, los ID, los totales de páginas y las horas desde la época son cadenas decimales; los estados enteros y los campos de latencia siguen siendo números JSON. Los campos opcionales pueden ser null o estar ausentes si hay un error.

NombreTipoObligatorioDescripción
codeintegeropcional
Business result code. Only 0 means success, even when HTTP is 200.
coststringopcional
Request processing duration in milliseconds, not credits. -1 means non-Web context.
dataobject | nullopcional
Committed account credit snapshot on success; null on an error.
data.cycleCreditstringopcional
Currently valid cycle credits in the committed balance; decimal string.
data.debtstringopcional
Outstanding credit debt, decimal string.
data.endTimestringopcional
Actual exclusive UTC epoch-millisecond window end.
data.grossConsumedCreditstringopcional
Windowed settled account-ledger consumption before refunds; excludes top-ups, admin adjustments, expiry, and debt repayment. Decimal string.
data.netCreditstringopcional
permanentCredit + cycleCredit − debt; may be negative and does not guarantee a paid call.
data.observedAtstringopcional
UTC epoch milliseconds when this committed-data read was observed.
data.permanentCreditstringopcional
Permanent credits in the committed account balance; decimal string.
data.quotanullopcional
Always null: there is no unified business-call quota.
data.scopestringopcional
Account ledger scope.
Permitidos: ACCOUNT
data.startTimestringopcional
Actual inclusive UTC epoch-millisecond window start.
msgstring | nullopcional
Optional business message; may be null or omitted on success.
timestringopcional
Server-formatted response time (yyyy-MM-dd HH:mm:ss); its zone is not specified by this field.
traceIdstring | nullopcional
Optional error trace ID; may be null or omitted on success.
tsstringopcional
Server response timestamp, UTC epoch milliseconds as a decimal string.

Respuestas

HTTP 200Comprueba ResponseData.code: solo 0 indica un resultado de negocio correcto. Un código distinto de cero puede llegar con HTTP 200.
HTTP 400Una ventana de tiempo o parámetros de paginación no válidos devuelven un error de parámetros.
HTTP 401 / 403La clave falta, no es válida o no tiene acceso.
HTTP 429Protección de frecuencia compartida para consultas de cuenta; Retry-After: 60 segundos.
HTTP 5xxError del servicio o de una dependencia; reintenta según el estado devuelto.

netCredit = permanentCredit + cycleCredit − debt y puede ser negativo; no garantiza una llamada de pago. grossConsumedCredit es el consumo liquidado del libro de cuenta antes de reembolsos, excluyendo recargas, ajustes administrativos, caducidad y devolución de deuda. quota es null porque no existe una cuota unificada de llamadas de negocio.

observedAt indica la hora de lectura. Solo aparecen resultados confirmados; los cargos en curso pueden aparecer más tarde. Las consultas independientes no comparten una instantánea y las páginas de uso pueden cambiar al completarse las llamadas.

¿Qué puedes hacer con esta API?

Datos explicados y casos de uso prácticos

AI Guide

Question

What account credit data can the Account credits API provide, and how might I use it?

AI answer

This API returns a committed account credit snapshot and settled consumption for a reported time window. Its scope is the account ledger (ACCOUNT).

Data categoryDocumented fieldsWhat the values mean
Credit balancesdata.permanentCredit, data.cycleCreditPermanent and currently valid cycle credits in the committed balance.
Debt and net balancedata.debt, data.netCreditOutstanding debt and permanent plus cycle credits minus debt; net credit can be negative.
Settled consumptiondata.grossConsumedCreditAccount ledger consumption settled within the window before refunds; excludes top-ups, admin adjustments, expiry, and debt repayment.
Measurement windowdata.startTime, data.endTimeThe inclusive start and exclusive end of the UTC window used for consumption.
Snapshot contextdata.scope, data.observedAtThe ACCOUNT scope and when the committed-data read was observed.
Quotadata.quotaAlways null; no unified business-call quota is provided.
  • Display the account's committed permanent, cycle, debt, and net credit figures.
    • Prompt example: “Show my current permanent credits, cycle credits, debt, and net credits from the latest committed account snapshot. Include observedAt and leave any missing value unspecified.”
  • Track gross settled account consumption over the returned window.
    • Prompt example: “How many credits does my account show as gross settled consumption for the returned UTC window? State startTime and endTime and explain that the amount is before refunds.”
  • Reconcile a balance view with its observation time and exact window boundaries.
    • Prompt example: “Prepare a balance snapshot with net credits, observedAt, and the exact inclusive-start/exclusive-end UTC window. Flag any missing field instead of supplying a default.”
  • Flag a negative data.netCredit for review. A positive value does not guarantee that a paid call will succeed.
    • Prompt example: “Check whether my returned netCredit is negative. Show the balance and observation time, and do not assume that a positive balance guarantees a paid API call.”