GET
/api/skill-api/v1/account/creditsRun this API
Endpoint
| Method | GET |
| Path | /api/skill-api/v1/account/credits |
| Auth | Bearer API key |
| Request body | None. Optional parameters are query fields. |
Account credits
Read the committed account credit balance and gross ledger consumption.
Cost0 credits / call
Account Credits API use cases
Plan API spending
An app developer checks the committed account credit balance before planning more paid API requests. The result shows the account balance and recorded consumption for the requested period.
Review recorded consumption
A finance analyst retrieves credit consumption for a defined time window and compares it with internal records. The analyst uses the documented balance fields to distinguish balances from consumption.
Build an account dashboard
A developer calls the Account Credits endpoint from an internal dashboard using a user API key. The dashboard displays the returned account information without requiring a manual export.
Account Credits API FAQ
What does the Account Credits API return?
Check your Nexscope account credit balance and credit consumption from your own app. The response includes committed account information for the requested time window. Review the parameter and response tables for the precise meaning of each field. In-flight charges may appear later, and separate account queries do not share a single snapshot.
How many credits does the Account Credits API cost?
This account query is free: 0 credits per call. It reads committed account data without adding a business API call or spending credits. A zero or negative balance does not block the free GET request. Both account queries share a limit of 60 requests per account per 60 seconds.
How do I call the Account Credits API?
Send a GET request to /api/skill-api/v1/account/credits with a GENERAL user API key in the Authorization Bearer header. Supply optional dates and pagination as query parameters rather than a JSON body. The published parameter table describes the UTC time-window rules. Website session tokens and plugin keys cannot authorize this account query.
Related APIs
Account APIs
API overview
Read the committed account credit balance and gross ledger consumption.
Endpoint
GET /api/skill-api/v1/account/creditsAuthentication
Send a GENERAL user API key in the Authorization bearer header. Website JWTs, plugin keys, and installation tokens cannot call this endpoint. Zero or negative balance does not block this free GET.
Authorization: Bearer YOUR_API_KEYRun API
Read committed account data without spending credits or adding a business API call. Both queries share a limit of 60 requests per account per 60 seconds.
Code example
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"Request parameters
The API uses UTC epoch milliseconds. In Online test, enter UTC date and time; the tester converts those UTC fields to milliseconds without using your browser time zone. With no dates, the preceding 30 days is used. A single bound fills the other with a 30-day span or now. The window is [startTime, endTime), no more than 180 days, and cannot end in the future.
| Name | Type | Required | Description |
|---|---|---|---|
endTime | string | optional | Optional UTC epoch milliseconds, exclusive. The window must end no later than the request time. |
startTime | string | optional | Optional UTC epoch milliseconds, inclusive. Enter UTC date and time in the tester; the API receives a decimal millisecond string. |
Response example
Complete ResponseData envelope. cost is processing time in milliseconds, not charged credits.
{
"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
}Response fields
Int64 credits, IDs, page totals, and epoch times are decimal strings; integer status and latency fields remain JSON numbers. Optional fields may be null or absent on error.
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | optional | Business result code. Only 0 means success, even when HTTP is 200. |
cost | string | optional | Request processing duration in milliseconds, not credits. -1 means non-Web context. |
data | object | null | optional | Committed account credit snapshot on success; null on an error. |
data.cycleCredit | string | optional | Currently valid cycle credits in the committed balance; decimal string. |
data.debt | string | optional | Outstanding credit debt, decimal string. |
data.endTime | string | optional | Actual exclusive UTC epoch-millisecond window end. |
data.grossConsumedCredit | string | optional | Windowed settled account-ledger consumption before refunds; excludes top-ups, admin adjustments, expiry, and debt repayment. Decimal string. |
data.netCredit | string | optional | permanentCredit + cycleCredit − debt; may be negative and does not guarantee a paid call. |
data.observedAt | string | optional | UTC epoch milliseconds when this committed-data read was observed. |
data.permanentCredit | string | optional | Permanent credits in the committed account balance; decimal string. |
data.quota | null | optional | Always null: there is no unified business-call quota. |
data.scope | string | optional | Account ledger scope. Allowed: ACCOUNT |
data.startTime | string | optional | Actual inclusive UTC epoch-millisecond window start. |
msg | string | null | optional | Optional business message; may be null or omitted on success. |
time | string | optional | Server-formatted response time (yyyy-MM-dd HH:mm:ss); its zone is not specified by this field. |
traceId | string | null | optional | Optional error trace ID; may be null or omitted on success. |
ts | string | optional | Server response timestamp, UTC epoch milliseconds as a decimal string. |
Responses
| HTTP 200 | Inspect ResponseData.code: only 0 is a successful business result. A nonzero code may still arrive with HTTP 200. |
| HTTP 400 | Invalid time window or pagination parameters return a parameter error. |
| HTTP 401 / 403 | The key is missing, invalid, or lacks access. |
| HTTP 429 | Shared account-query rate protection; Retry-After: 60 seconds. |
| HTTP 5xx | Service or dependency error; retry according to the returned status. |
netCredit = permanentCredit + cycleCredit − debt and may be negative; it does not guarantee a paid call. grossConsumedCredit is settled account-ledger consumption before refunds, excluding top-ups, admin adjustments, expiry, and debt repayment. quota is null because no unified business-call quota exists.
observedAt marks the read time. Only committed results appear; in-flight charges may arrive later. Separate queries do not share a snapshot, and usage pages can shift as calls complete.
What can you do with this API?
Data explained and practical use cases
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 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. |
- 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.netCreditfor 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.”
Online test
Send one real, free account GET with your user API key. No request runs until you select Run API.