- Overview
- Building models
- Consuming models
- ML packages
- 1040 - ML package
- 1040 Schedule C - ML package
- 1040 Schedule D - ML package
- 1040 Schedule E - ML package
- 1040x - ML package
- 3949a - ML package
- 4506T - ML package
- 709 - ML package
- 9465 - ML package
- ACORD125 - ML package
- ACORD126 - ML package
- ACORD131 - ML package
- ACORD140 - ML package
- ACORD25 - ML package
- Bank Statements - ML package
- Bills Of Lading - ML package
- Certificate of Incorporation - ML package
- Certificate of Origin - ML package
- Checks - ML package
- Children Product Certificate - ML package
- CMS 1500 - ML package
- EU Declaration of Conformity - ML package
- Financial Statements - ML package
- FM1003 - ML package
- I9 - ML package
- ID Cards - ML package
- Invoices - ML package
- Invoices Australia - ML package
- Invoices China - ML package
- Invoices Hebrew - ML package
- Invoices India - ML package
- Invoices Japan - ML package
- Invoices Shipping - ML package
- Packing Lists - ML package
- Payslips - ML package
- Passports - ML package
- Purchase Orders - ML package
- Receipts - ML Package
- Remittance Advices - ML package
- UB04 - ML package
- Utility Bills - ML package
- Vehicle Titles - ML package
- W2 - ML package
- W9 - ML package
- Public endpoints
- Supported languages
- Data and security
- Licensing and Charging Logic
- API Key
- Metering and charging logic
- How to
Document Understanding User Guide
API Key
The AI Units section in the Consumables tab on the Licenses page displays the consumption entitlement (AI Units) that can be extracted by our Machine Learning servers based on your AI Units entitlement.
Support for API key authentication is currently being phased out and will be discontinued by March 2025. An alternative authentication method will be made available to Document UnderstandingTM users in due time, which will serve as a replacement for the API key authentication mechanism.
Learn more about upcoming deprecations.
Access to the models' endpoints is granted based on an API Key. The API Key is generated automatically when you create your account, and it is required for the following activities in Studio:
- Form Extractor
- Intelligent Keyword Classifier
These activities allow you to use UiPath® ML models.
Click Copy API Key to copy the displayed API Key to your clipboard and then paste it in your activity or in the case of UiPath® OCR, in the UiPath Document OCR engine activity.
A request is sent from the activity to the Machine Learning Server, and access is granted based on your API Key.
If at any point the API Key is compromised, discard it by generating a new one.
Keep in mind that we limit the size of documents that can be processed by our servers. For more information, check the Known limitations page.
