Overview
TrueParser tracks three separate kinds of usage:- API request limits
- Document Unit quotas
- byte usage
What Is a Document Unit?
A Document Unit is the common product term for one countable unit of parsing work. Depending on parser family, one Document Unit may correspond to:- a page
- an email/message item
- a SQL statement
- a logical file or dataset
Request-Rate Limits
TrueParser also enforces request-rate limits for API traffic. Current public request-rate behavior:- request limits are app-scoped
- the current API uses a requests-per-minute limit
- request-rate limits are separate from Document Unit quotas
429 Too Many Requests.
Document Units by Family
The current Document Unit mapping is:| Family | One Document Unit means |
|---|---|
| One page | |
| MsOffice | One page |
| OpenDoc | One page |
| MailKit | One top-level email/message item |
| SQL | One statement |
| GIS | One logical dataset |
| CAD | One processed document |
Important
Document Unit is the product term used across plans, pricing,
quota enforcement, and customer-facing usage discussions. The exact technical
counting rule depends on the parser family listed above.
Quota Windows
Document Unit quotas are enforced across multiple windows:- per document
- hourly
- daily
- weekly
- monthly
Byte Usage
TrueParser also tracks accepted upload size in bytes. Byte tracking is useful for:- visibility
- telemetry
- operational monitoring
Usage Visibility
You can inspect current usage through the Usage API. The current API exposes usage as separate request, quota, and byte windows rather than one aggregated usage object. At a high level, the Usage API provides visibility into:- request-rate usage
- Document Unit quota windows
- byte usage windows
Quota Errors
When your application exceeds a limit, the current API can surface errors such as:rate_limit_exceededquota_exceededdocument_quota_exceeded
rate_limit_exceededmeans your application exceeded an API traffic limitquota_exceededmeans your application exceeded a rolling Document Unit windowdocument_quota_exceededmeans a single document exceeded the allowed per-document quota

