Search documentation

Search across all documentation pages

Get API Key
Endpoints

Usage

Check your usage and remaining allowance

Read your own consumption for the current billing period. Usage is metered in two independent classes — part records and AI tokens (see Rate limits & usage); this endpoint reports the running total in each so you can track an integration against its monthly allowance. Free to call.

any valid key

This endpoint reflects your own account usage, so it needs no special scope — any valid key (parts:read or ai:run) can read it.

Get usage

GEThttps://api.zenode.ai/v1/usageFree

Response

JSON
1{
2 "period": {
3 "start": "2026-06-01T00:00:00Z",
4 "end": "2026-07-01T00:00:00Z"
5 },
6 "usage": {
7 "part_records": {
8 "used": 8830,
9 "limit": 10000
10 },
11 "ai_tokens": {
12 "used": 1240,
13 "limit": 5000
14 }
15 },
16 "notes": [],
17 "request_id": "req_3e90..."
18}
ParameterTypeRequiredDescription
period
{ start, end }RequiredThe current billing period (ISO-8601 UTC); usage counts reset at start
usage
objectRequiredOne entry per metering class — part_records, ai_tokens
notes
string[]RequiredPlain-text explanations of the report, such as the account having no subscription, or why a class's used exceeds its limit. Often empty; don't depend on the exact wording
out_of_credits
object | nullOptionalPresent when AI credits or part lookups are used up: what ran out, when it resets and what helps — the same `details` a refused request carries (see Errors → What to do next)
request_id
stringRequiredFor support / tracing

Each class entry is { used, limit }, both always numbers:

ParameterTypeRequiredDescription
used
intRequiredConsumed in the current period — part records returned (part_records), or AI spend in cents (ai_tokens)
limit
intRequiredThe period allowance for this class, from your plan — or the free tier's when the account has no subscription

What limit counts differs per class:

  • part_records — your plan's monthly allowance, 0 on the free tier. Bonus part-record grants are not included, so used can go past limit; when it does, notes says so.
  • ai_tokens — all AI spend on the account, in the web app, the API and MCP alike, in cents. Its limit is your plan's monthly budget plus any bonus and top-up credits left at the start of the period.

Without an active subscription, limit shows the free tier's allowance and notes says that the paid API endpoints and the MCP server require a subscription: that allowance can be spent in the web app only. The per-minute throttle is separate and surfaced live on the X-RateLimit-* response headers (see Rate limits & usage).

Next