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 Document Understanding^TM license entitlement.

Note: If you consume services or endpoints from an Automation Cloud™ environment (for example, du.uipath.com/ocr or du.uipath.com/ie/invoices) while you are using a different deployment type, such as Automation Suite offline, you need to add the API key from an Automation Cloud account, not the one available in Automation Suite.

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
• Machine Learning Extractor

These activities allow you to use UiPath® ML models.

Select 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.

Note: Machine Learning technology is probabilistic in nature. UiPath makes continuous efforts to improve our Document Understanding products but cannot guarantee accuracy or performance on any particular business document.