About this guide

This guide helps developers and integrators use the UiPath® APIs. It provides information about available resources, authentication methods, and how to construct API requests. By offering programmatic access to functionality and data within the UiPath® platform, the APIs enable seamless integration with UiPath services and external systems.

The APIs apply across UiPath Test Cloud offerings. However, API availability and behavior can vary depending on the cloud platform you use. For details about which APIs are supported in each cloud platform, see the Feature availability page in the Test Cloud Admin guide. Also check out the About this documentation page for information on how to navigate the Test Cloud administrative documentation.

This guide also introduces the two core layers of the UiPath API architecture:

• Organization-level services, such as Identity Server and Licensing, which manage operations at the organization level.
• Tenant-scoped services, such as Orchestrator and Data Service, which support the needs of individual tenants.

Note:

The URLs in this guide use cloud.uipath.com as the base URL. Depending on the cloud platform you are using, replace the base URL accordingly:

• Test Cloud: cloud.uipath.com
• Test Cloud Public Sector: govcloud.uipath.us
• Test Cloud Dedicated: <customURL>.dedicated.uipath.com