File Commands
Upgrade a mixed document
Change the processing type of a Mixed Document from Classify to Instant, or from Instant to Complete, without changing the Book's book_class.
Use this endpoint for mixed PDF uploads when only that mixed document needs a higher processing tier and you want new uploads to continue following the Book's current class.
For single (non-mixed) documents, use the Upgrade a document endpoint. For Book-level class changes, use the Book Upgrades and Update Book endpoint.
Prerequisites
- Document-level upgrades must be enabled for your organization. If not, contact your Ocrolus account manager.
- The mixed document must finish its current processing before you upgrade it.
- Do not upgrade child documents individually. Upgrade the mixed document with this endpoint.
- If the Book is already Complete, or a Book upgrade already covers the same target, the mixed document upgrade is rejected.
- On success, the mixed document re-enters processing under the new tier. Re-fetch status and Capture or Analyze data after verification completes.
When to use this endpoint
| Scenario | Use this endpoint? |
|---|---|
| An Instant mixed document needs Complete accuracy | Yes - upgrade_type: COMPLETE |
| A classified mixed document needs Instant capture (Book class is INSTANT_CLASSIFY_ONLY or INSTANT_CLASSIFY_ISO_CAPTURE) | Yes - upgrade_type: INSTANT |
| The file is a single (non-mixed) document | No - use Upgrade a document |
| The entire Book should move to Complete | No - use Update Book |
Upgrade types
| upgrade_type | Meaning |
|---|---|
| INSTANT | Upgrade from Classify to Instant capture |
| COMPLETE | Upgrade from Classify or Instant to Complete |
Mixed document upgrades are forward-only. You cannot downgrade from Complete back to Instant.
post/v1/document/mixed/upgrade
Request
- Base URLhttps://api.ocrolus.com
- URLhttps://api.ocrolus.com/v1/document/mixed/upgrade
- AuthOAuth 2Client credentialsToken URL: https://auth.ocrolus.com/oauth/token
Request body
Response
Success
Example response
{
"status": 200
}Changes
No recorded changes to this operation across all 1 revision of this API.