Technical Limitations
Technical limitations when integrating Mindee.
These limitations are designed to ensure the safety and stability of the Mindee API and platform.
Unless noted otherwise, any action that exceeds or does not comply with the limitations will be rejected with an error.
Accepted Files
PDF Files
All Portable Document Format (PDF) can be processed, either single page or multiple pages.
These are defined using the application/pdf Media type.
In some cases application/binary is used, this is incorrect as per the standard, but should also work, so long as the extension is .pdf and the binary contents are a valid PDF file.
In rare cases, the PDF headers are corrupted or invalid. Fix these using our PDF repair tool, otherwise the server may reject them.
Each PDF page can be a combination of text and image elements.
Image Files
Most common image types can be processed.
Specifically, we accept the following image types:
JPEG
image/jpeg
jpeg, jpg
PNG
image/png
png
non-animated only
WebP
image/webp
webp
TIFF
image/tiff
tiff, tif
single page or multiple pages
HEIC
image/heic
heic
HEIF
image/heif
heif
Single HEVC-encoded image only.
Zip Files
As a convenience for testing, it is possible to upload Zip files to the Live Test.
The API does not support sending Zip files.
API File Limits
These limits apply to all files sent to the API, regardless of type.
File Size
100 MB
100 MB
Number of Pages
No limit
10 pages
If you have access to the file locally, there are workarounds available for these limits:
Requires using our Client Libraries / SDKs.
Live Test File Limits
These limits apply to files sent to the Live Test.
Document File Size
50 MB
50 MB
Number of Pages
50 pages
10 pages
Zip File Size
100 MB
100 MB
Accepted URLs
It is possible to send an URL rather than binary data to the API.
An URL pointing to all accepted files may be used, if it adheres to the API file limits.
In addition, the source URL must adhere to the following rules:
Secured using TLS (HTTPS).
Publicly available using only the URL, no authentication headers.
Authentication may be provided in the URL as query parameters: username+password or token. For example, Amazon S3 signed URLs will work.
Contents must be a binary file (raw bytes, not base64-encoded).
File contents cannot be encrypted.
The Mindee server will not follow redirections (HTTP 3xx).
Sending an URL to the Live Test is not supported.
Rate Limits
Burst calls to the Mindee API are limited to ensure the stability of the platform for all users.
These rate limits apply to an entire organization, meaning the combination of all models, origin IPs, and API keys.
The following limits are enforced:
Send for Processing (POST)
200 requests per minute
Polling (GET)
1200 requests per minute Normally, this is handled by the client library.
If rate limits are exceeded, the server will return a HTTP 429 error.
However, there are no limits to the total number of files sent, so long as they adhere to the rate limits.
Data Schema
Number of Fields in the Data Schema
The recommended maximum number of fields is 25 for a Data Schema.
While there will be no errors, beyond this number response times will increase.
Names of Fields
The field name must only contain:
lowercase Latin letters without accents (a-z)
numbers (0-9)
underscores (
_), but neither first nor last characters can be an underscore.the following names cannot be used:
value,fields,items.
Webhooks
Webhook URLs must adhere to the the following rules:
Secured using TLS (HTTPS).
Publicly available using only the URL, no authentication headers.
Authentication may be provided in the URL as query parameters: username+password or token
The Mindee server will not follow redirections (HTTP 3xx).
The route should return OK (HTTP 2xx) when successful.
Last updated
Was this helpful?