document-understanding
latest
false
UiPath logo, featuring letters U and I in white
Document Understanding User Guide
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Nov 7, 2024

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.



Important:

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.

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

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.