- Getting started
- Authentication
- Scopes and permissions
- Platform Management APIs
API Keys
You use API keys to establish a connection between the UiPath® platform and other applications that are external to it. External applications can be either UiPath desktop applications, or third-party applications.
API keys are available for several UiPath services (products).
Learn more about upcoming deprecations.
You can view API access information for each of your existing Orchestrator services on the Admin > Tenant > Services page.
This information is required for authenticating to your Orchestrator service in Automation Cloud via API calls.
Not applicable for Azure AD
If the authentication settings for your organization are set to use a directory integration, the API Access button is not available and these instructions are not applicable for you.
In this case, you must do one of the following:
- log out of Automation Cloud and then log in with a UiPath® account instead of a directory account, or
- (recommended) use the OAuth flow instead.
You can view the API access information for a service if you have the Organization Administrator role, or if you are assigned to that service.
You can use the copied information to consume cloud APIs .
Revoking access cancels all previously assigned user keys, thus breaking all applications that rely on previously assigned user keys. A new user key is automatically generated for the selected Orchestrator service.
You must share the new user key to all the affected applications.
The API key for Document Understanding is available on the
page:From here, you can:
- Copy the key for use in external applications.
- Click the refresh icon to generate a new
key.
Important: Generating a new key renders the old key invalid. Any external applications that used the old key cannot connect to Automation Cloud any more.
For more information, see API Key in the Document Understanding documentation.
The API key for Computer Vision is available on the Admin > Organization > Licenses > Robots & Services page.
From here, you can:
- Copy the key for use in external applications.
-
Click the Refresh icon to generate a new key.
Important: Generating a new key renders the old key invalid. Any external applications that used the old key cannot connect to Automation Cloud anymore.
For more information, see Computer Vision .