Lexigen

API reference

GET /v1/usage

Returns your usage and remaining quota, so you can check headroom before running a large batch. Calling it does not count toward any limit.

GET/api/v1/usage

Headers

  • AuthorizationBearer <API_KEY> (or X-API-Key: <API_KEY>)required

Scope

Requires the usage:read scope (on by default for dashboard-created keys).

Response fields

FieldMeaning
planYour plan’s id, name, priorityProcessing flag and teamSeats (informational).
periodStart / periodEndThe current calendar month in UTC (ISO 8601). Monthly quotas reset at periodEnd.
meteringAlways { "unit": "word", "granularity": "generation" }: words are counted per successful generation.
limits.monthlyWordsWords your account may generate this month. Enforced: once reached, generation returns QUOTA_EXCEEDED.
limits.monthlyPostsSuccessful generations allowed this month (equal to the plan’s monthly request allowance). Enforced the same way.
limits.requestsPerMinutePer-API-key burst limit. Enforced: exceeding it returns RATE_LIMITED.
limits.maxWordsPerRequestA legacy plan value that is not enforced. There is no per-request word cap and article length isn’t limited. Don’t build logic on it.
consumedAccount-wide totals this month: words, posts and requests, counting successful generations only (sync and jobs).
remainingThe monthly allowances minus consumed, never below 0.
dailyThis API key’s requests-per-day window: limit, used, remaining and resetAt (next UTC midnight). Usually the first limit a Starter account hits.

Monthly figures are per account (all keys combined). Daily and per-minute figures are per API key. See plans & limits.

curl example

shell
curl https://lexigen.app/api/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,
    "monthlyPosts": 5000,
    "maxWordsPerRequest": 2000,
    "requestsPerMinute": 15
  },
  "consumed": {
    "words": 42300,
    "posts": 51,
    "requests": 51
  },
  "remaining": {
    "words": 157700,
    "posts": 4949,
    "requests": 4949
  },
  "daily": {
    "limit": 500,
    "used": 12,
    "remaining": 488,
    "resetAt": "2026-09-15T00:00:00.000Z"
  }
}

After one more successful generation (890 words)

consumed, remaining and daily.used move 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,
    "monthlyPosts": 5000,
    "maxWordsPerRequest": 2000,
    "requestsPerMinute": 15
  },
  "consumed": {
    "words": 43190,
    "posts": 52,
    "requests": 52
  },
  "remaining": {
    "words": 156810,
    "posts": 4948,
    "requests": 4948
  },
  "daily": {
    "limit": 500,
    "used": 13,
    "remaining": 487,
    "resetAt": "2026-09-15T00:00:00.000Z"
  }
}