Install & Compatibility
Where this runs
tested against v0.1.70 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
py 3.10
✕ build_error
✕ build_error
py 3.9
✕ build_error
✕ build_error
40MB installed
● package 40MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
UipathPlatform
✓ from uipath_platform import UipathPlatform
This quickstart demonstrates how to initialize the `UipathPlatform` client and make a basic API call, such as listing assets from UiPath Orchestrator. It assumes authentication details (Organization ID, Tenant ID, and Auth Token) are provided via environment variables. Ensure your authentication token has the necessary permissions for the API calls you intend to make.
import os
from uipath_platform import UipathPlatform
# Retrieve credentials from environment variables
# Ensure these are set in your environment before running:
# UIPATH_ORGANIZATION_ID, UIPATH_TENANT_ID (optional for some calls), UIPATH_AUTH_TOKEN
# Example: export UIPATH_ORGANIZATION_ID="your_org_id"
# export UIPATH_TENANT_ID="your_tenant_id"
# export UIPATH_AUTH_TOKEN="Bearer your_token_string"
ORGANIZATION_ID = os.environ.get("UIPATH_ORGANIZATION_ID", "")
TENANT_ID = os.environ.get("UIPATH_TENANT_ID", "")
AUTH_TOKEN = os.environ.get("UIPATH_AUTH_TOKEN", "")
BASE_URL = os.environ.get("UIPATH_BASE_URL", "https://cloud.uipath.com")
if not (ORGANIZATION_ID and AUTH_TOKEN):
print("Error: Missing UIPATH_ORGANIZATION_ID or UIPATH_AUTH_TOKEN environment variables.")
print("Please set them before running this script.")
exit(1)
try:
# Initialize the client
# The client object provides access to various operation groups (e.g., assets, queues).
client = UipathPlatform(
organization_id=ORGANIZATION_ID,
tenant_id=TENANT_ID,
auth_token=AUTH_TOKEN,
base_url=BASE_URL
)
print(f"Successfully initialized UiPath Platform client for Organization ID: {ORGANIZATION_ID}")
print("Attempting to list first 5 assets (requires Asset Read permission on your token)...")
# Example: List assets from Orchestrator
# This call requires 'x_uipath_tenantid' for Orchestrator operations.
# Ensure your AUTH_TOKEN has the necessary scopes, e.g., 'Orchestrator.Assets.Read'.
assets_response = client.assets.get_assets(
organization_id=ORGANIZATION_ID,
x_uipath_tenantid=TENANT_ID,
top=5
)
if assets_response.status_code == 200:
print(f"Successfully retrieved assets: {assets_response.parsed}")
else:
print(f"Failed to retrieve assets. Status: {assets_response.status_code}, Error: {assets_response.content}")
except Exception as e:
print(f"An error occurred: {e}")
Debug
Known issues
breakingThe `uipath-platform` library was extracted from the main `uipath-python` SDK in `uipath-python` v2.9.0. If you are using the `uipath-python` SDK pre-2.9.0, the platform client was integrated; post-2.9.0, it is expected as a separate dependency, potentially leading to import or dependency conflicts if not managed correctly.fixEnsure consistent dependency management. For `uipath-python` >= v2.9.0, explicitly install `uipath-platform` if platform-specific low-level client access is needed. For older `uipath-python` SDKs, the platform client functionality is bundled.
affects: uipath-platform v0.1.x when used with uipath-python < v2.9.0 or uipath-python >= v2.9.0
gotchaThe `uipath-platform` PyPI package follows its own `0.1.x` versioning scheme, which is distinct from the `2.x.x` versioning of the main `uipath-python` SDK. This can lead to compatibility issues if not carefully considered, as the SDK might expect a specific version of the underlying platform client.fixRefer to the `uipath-python` SDK documentation for recommended versions of `uipath-platform` (if any) to use together. Always test compatibility thoroughly when upgrading either library.
affects: All versions of uipath-platform when used alongside uipath-python SDK.
gotchaAuthentication with the UiPath Platform requires providing `organization_id`, `tenant_id` (for tenant-specific operations), and a valid `auth_token`. Misconfigured or missing credentials are a common source of connection errors and `401 Unauthorized` responses.fixDouble-check your `UIPATH_ORGANIZATION_ID`, `UIPATH_TENANT_ID`, and `UIPATH_AUTH_TOKEN` environment variables or directly passed parameters. Ensure the `auth_token` is a valid Bearer token with the necessary scopes/permissions for the API endpoints you are calling.
affects: All
Errors
Common errors & fixes
ModuleNotFoundError: No module named 'uipath_platform'
The `uipath-platform` library is not installed in your Python environment.
fixRun `pip install uipath-platform` to install the library.
requests.exceptions.HTTPError: 401 Client Error: Unauthorized for url:
The provided authentication token is invalid, expired, or lacks the necessary permissions for the requested API endpoint.
fixGenerate a new API token with appropriate scopes from your UiPath Automation Cloud tenant's API Access page. Ensure the token is prefixed with `Bearer ` when used.
TypeError: UipathPlatform.__init__ missing 1 required positional argument: 'organization_id'
Required authentication parameters like `organization_id`, `tenant_id`, or `auth_token` were not provided to the `UipathPlatform` constructor.
fixEnsure `organization_id`, `tenant_id`, and `auth_token` are explicitly passed to the `UipathPlatform` constructor. It's recommended to use environment variables for these values.
Upgrade
Version history
0.1.70latest on PyPI · released Jun 17, 2026
Audit
Dependencies
requestsrequiredHTTP client functionality