Current key
Key name, spending limit and how much of it is used. Free.
apiKeyAuthorizationBearer <nlk_… (team API key)>The key this request was made with.
application/json- response
name?stringkeyPrefix?stringlimitValue?numberSpending limit in tokens per limitPeriod.
limitPeriod?stringTOTAL — for the key's whole lifetime; DAY/WEEK — renews every day/week.
"TOTAL""DAY""WEEK"usedValue?numberSpent in the current window.
remainingValue?numberStill available in the current window.
resetsOn?|When the limit renews. null for TOTAL.
dateexpiresAt?|date-timestatus?stringEXHAUSTED — paid operations are rejected, free ones still work.
"ACTIVE""EXHAUSTED"curl -X GET 'https://api.neurolate.com/ext/v1/key'{
"name": "string",
"keyPrefix": "string",
"limitValue": 0,
"limitPeriod": "TOTAL",
"usedValue": 0,
"remainingValue": 0,
"resetsOn": "2019-08-24",
"expiresAt": "2019-08-24T14:15:22Z",
"status": "ACTIVE"
}Clean text off images POST
Removes text. Each image with something cleaned comes back whole, as a PNG of the same size; `blocks` lists its areas. Areas — your `masks`; for an image without masks we find them: on a BLOCK — the text inside it, on a PAGE — OCR blocks where text was read. - `tier=PREMIUM`, `mode=MASK` — a premium model per area. - `tier=PREMIUM`, `mode=BBOX` — redraws the whole bounding box with a stronger model; for text over a face or a very complex background. Its model cost is higher, so it lands nearer the top of the `api_clean_premium` range. Billing per cleaned area: STANDARD — `api_clean`, PREMIUM — `api_clean_premium`. An area we found adds `api_ocr_mask`: 1 on a BLOCK image, 2 on a PAGE. Before the work a hold is charged, after it the actual cost (see Billing).
Detect text blocks: masks and/or text POST
Finds text blocks and returns their masks and/or text, in reading order. - PAGE — we find the blocks. TEXT on a page runs as MASK_AND_TEXT (see `modeApplied`). - BLOCK — the whole image is one block; we find the text shape inside it. - With `masks` — one block per mask, nothing outside them; images without masks are skipped. Pages and BLOCK images: blocks without text are dropped and free (MASK mode reads no text and returns every mask). Your mask always comes back and is charged, even with no text (`textStatus` EMPTY). Billing per returned block: mask — `api_ocr_mask` (not in TEXT mode), text — `api_ocr_text` (not in MASK mode). Before the work a hold is charged, after it the actual cost (see Billing).