API keys in the portal
Updated
Where your keys are#
Dashboard. Every key on your account is listed with:
| Column | Meaning |
|---|---|
| Label | The name given to the key, so you can tell several apart |
| API Key | Masked — first four and last four characters only |
| Status | See below |
| Models Access | Which document types this key may extract |
| Usage | Credits consumed against this key's quota |
| Last Used | When the key last made a successful call, or Never |
Two tiles at the top summarise the account: Active Keys and Total Used.
Copying a key#
Keys are shown masked. Use the copy control on the Dashboard to put the full value on your clipboard — it is fetched only when you ask for it, so the full key never sits in the page.
Status values#
| Status | What it means | What to do |
|---|---|---|
| Active | Working normally | — |
| Expired | Past its expiry date | Contact support for a renewal |
| Revoked | Switched off on our side | Contact support |
| Quota Exhausted | Usage has reached the key's limit | Top up, or ask for a higher quota |
Expired and quota-exhausted keys return 401 and 402 respectively — see error codes.
Models Access#
A key can only extract the document types assigned to it. Requesting anything else returns 400 unknown_model.
To see the exact list a key permits, call models — it costs no credits — or open the Test API page, where the document-type dropdown is populated from it.
Getting another key#
Keys cannot be created from the portal. Ask support@docxtract.io.
A separate key per integration is worth requesting: usage becomes attributable per system, and one can be revoked without disturbing the others.
Usage and quota#
Usage counts credits, and credits are per page — a ten-page document costs ten. It is not a request counter.
This is separate from rate limiting, which caps requests per minute rather than total consumption. See rate limits and quotas.
Something wrong or missing on this page? Tell us.