API reference

GET /v1/usage

Returns metered usage for the current billing period, so you can check remaining quota before running a large batch.

GET/v1/usage

Headers

AuthorizationBearer <API_KEY>required

Response fields

Field	Meaning
plan	Current plan id, name, priority processing, and seat count.
periodStart / periodEnd	The current billing period boundaries (ISO 8601).
limits	Monthly word/post caps, per-request word cap, and requests/minute.
consumed	Usage so far this period.
remaining	Limits minus consumed, for the metered units your plan tracks.
metering	Which unit (word/post) and granularity (request/generation) is billed.
daily	Your per-API-key requests-per-day quota — the primary throughput lever on the Starter plan. Resets at UTC midnight.

curl example

shell

curl ${NEXT_PUBLIC_API_BASE_URL}/v1/usage \
  -H "Authorization: Bearer $KEYWORD_TO_BLOG_API_KEY"

Example response

json

{
  "plan": {
    "id": "growth",
    "name": "Growth",
    "priorityProcessing": false,
    "teamSeats": 3
  },
  "periodStart": "2026-09-01T00:00:00.000Z",
  "periodEnd": "2026-10-01T00:00:00.000Z",
  "metering": {
    "unit": "word",
    "granularity": "generation"
  },
  "limits": {
    "monthlyWords": 200000,
    "maxWordsPerRequest": 2000,
    "requestsPerMinute": 15
  },
  "consumed": {
    "words": 42300,
    "posts": 51,
    "requests": 58
  },
  "remaining": {
    "words": 157700
  },
  "daily": {
    "limit": 500,
    "used": 12,
    "remaining": 488,
    "resetAt": "2026-09-15T00:00:00.000Z"
  }
}

After running one more generation (890 words consumed)

Note consumed.words and remaining.words both shift accordingly:

json

{
  "plan": {
    "id": "growth",
    "name": "Growth",
    "priorityProcessing": false,
    "teamSeats": 3
  },
  "periodStart": "2026-09-01T00:00:00.000Z",
  "periodEnd": "2026-10-01T00:00:00.000Z",
  "metering": {
    "unit": "word",
    "granularity": "generation"
  },
  "limits": {
    "monthlyWords": 200000,
    "maxWordsPerRequest": 2000,
    "requestsPerMinute": 15
  },
  "consumed": {
    "words": 43190,
    "posts": 52,
    "requests": 59
  },
  "remaining": {
    "words": 156810
  },
  "daily": {
    "limit": 500,
    "used": 12,
    "remaining": 488,
    "resetAt": "2026-09-15T00:00:00.000Z"
  }
}