Authentication

In a UiPath Studio project, to use the Computer Vision activities or Computer Vision as part of Unified Target for UI Automation activities, you need to authenticate to the Computer Vision server.

API Key

When authenticating, the Computer Vision server first tries to use the API key. If this does not work, it falls back to the user token.

The API key can be obtained by organization administrators from Automation Cloud by going to Admin > Licenses > Robots & Services > Computer Vision > selecting the Copy the API Key button. More details can be found in the API Keys page.

The API key can then be populated in the ApiKey field under the Computer Vision Project Settings category. For more information, see the Project Settings page.

The API key is then used by the CV Screen Scope activity. If you add a different API key under the ApiKey property of the CV Screen Scope activity, then the ApiKey project setting is overwritten and reflected in all subsequent activities project-wide.

Also, Computer Vision in Unified Target is enabled when providing the API key in Project Settings, so you can have a better detection when indicating with UI Automation activities.

Note: Even though API Key authentication will be removed for Automation Cloud services, Computer Vision is an exception to this. In terms of security, API key authentication in Computer Vision is as safe as Personal Access Tokens (PATs). Therefore, you can continue using API keys for Computer Vision authentication, while keeping your UiPath resources secure. For more information about the API key removal and the transition to PATs, visit Upcoming removals for Automation Cloud and Migrating from API keys to Personal Access Tokens (PATs).

User token

If Studio is connected to Orchestrator Cloud using interactive sign-in either directly from Studio or from Assistant, the user token generated at sign-in is used to authenticate to the Computer Vision server.