/api/skill-api/v1/account/creditsEjecutar esta API
Endpoint
| Método | GET |
| Ruta | /api/skill-api/v1/account/credits |
| Autenticación | Bearer API key |
| Cuerpo de la solicitud | Ninguno. Los parámetros opcionales son campos de consulta. |
Read the committed account credit balance and gross ledger consumption.
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.
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.
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.
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.
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.
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.
Read the committed account credit balance and gross ledger consumption.
GET /api/skill-api/v1/account/creditsEnví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_KEYLee 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.
/api/skill-api/v1/account/credits| Método | GET |
| Ruta | /api/skill-api/v1/account/credits |
| Autenticación | Bearer API key |
| Cuerpo de la solicitud | Ninguno. Los parámetros opcionales son campos de consulta. |
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"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.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
endTime | string | opcional | Optional UTC epoch milliseconds, exclusive. The window must end no later than the request time. |
startTime | string | opcional | Optional UTC epoch milliseconds, inclusive. Enter UTC date and time in the tester; the API receives a decimal millisecond string. |
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
}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.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | integer | opcional | Business result code. Only 0 means success, even when HTTP is 200. |
cost | string | opcional | Request processing duration in milliseconds, not credits. -1 means non-Web context. |
data | object | null | opcional | Committed account credit snapshot on success; null on an error. |
data.cycleCredit | string | opcional | Currently valid cycle credits in the committed balance; decimal string. |
data.debt | string | opcional | Outstanding credit debt, decimal string. |
data.endTime | string | opcional | Actual exclusive UTC epoch-millisecond window end. |
data.grossConsumedCredit | string | opcional | Windowed settled account-ledger consumption before refunds; excludes top-ups, admin adjustments, expiry, and debt repayment. Decimal string. |
data.netCredit | string | opcional | permanentCredit + cycleCredit − debt; may be negative and does not guarantee a paid call. |
data.observedAt | string | opcional | UTC epoch milliseconds when this committed-data read was observed. |
data.permanentCredit | string | opcional | Permanent credits in the committed account balance; decimal string. |
data.quota | null | opcional | Always null: there is no unified business-call quota. |
data.scope | string | opcional | Account ledger scope. Permitidos: ACCOUNT |
data.startTime | string | opcional | Actual inclusive UTC epoch-millisecond window start. |
msg | string | null | opcional | Optional business message; may be null or omitted on success. |
time | string | opcional | Server-formatted response time (yyyy-MM-dd HH:mm:ss); its zone is not specified by this field. |
traceId | string | null | opcional | Optional error trace ID; may be null or omitted on success. |
ts | string | opcional | Server response timestamp, UTC epoch milliseconds as a decimal string. |
| HTTP 200 | Comprueba ResponseData.code: solo 0 indica un resultado de negocio correcto. Un código distinto de cero puede llegar con HTTP 200. |
| HTTP 400 | Una ventana de tiempo o parámetros de paginación no válidos devuelven un error de parámetros. |
| HTTP 401 / 403 | La clave falta, no es válida o no tiene acceso. |
| HTTP 429 | Protección de frecuencia compartida para consultas de cuenta; Retry-After: 60 segundos. |
| HTTP 5xx | Error 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.
Datos explicados y casos de uso prácticos
AI Guide
What account credit data can the Account credits API provide, and how might I use it?
This API returns a committed account credit snapshot and settled consumption for a reported time window. Its scope is the account ledger (ACCOUNT).
| Data category | Documented fields | What the values mean |
|---|---|---|
| Credit balances | data.permanentCredit, data.cycleCredit | Permanent and currently valid cycle credits in the committed balance. |
| Debt and net balance | data.debt, data.netCredit | Outstanding debt and permanent plus cycle credits minus debt; net credit can be negative. |
| Settled consumption | data.grossConsumedCredit | Account ledger consumption settled within the window before refunds; excludes top-ups, admin adjustments, expiry, and debt repayment. |
| Measurement window | data.startTime, data.endTime | The inclusive start and exclusive end of the UTC window used for consumption. |
| Snapshot context | data.scope, data.observedAt | The ACCOUNT scope and when the committed-data read was observed. |
| Quota | data.quota | Always null; no unified business-call quota is provided. |
data.netCredit for review. A positive value does not guarantee that a paid call will succeed.