Registry / aws / uipath

uipath

JSON →
library2.14.10pypypi✓ verified 23d ago

The UiPath Python SDK provides programmatic interaction with UiPath Cloud Platform services, including processes, assets, buckets, context grounding, data services, and jobs. It also features a CLI for creation, packaging, and deployment of automations to the UiPath Cloud Platform. The library is actively developed, with minor releases (X.Y.0) potentially introducing breaking changes and patch releases (X.Y.Z) for bug fixes and new features, usually on a monthly or bi-monthly cadence.

pip install uipath
INSTALL
IMPORT
SIG · UIPATH
U
uipath
awspythonv2.14.10
Install
12.6s avg
Import
2500ms
Disk
87MB
Pass rate
8/ 10
Env Coverage8 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v2.1.185 · 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
musl
glibc
py 3.10
✓ —
✓ 15.8s
py 3.11
✓ —
✓ 13.5s
py 3.12
✓ —
✓ 10.1s
py 3.13
✓ —
✓ 11s
py 3.9
✕ build_error
✕ build_error
87MB installed
● package 87MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

UiPath
from uipath.platform import UiPath
from uipath import UiPath
As of v2.9.0, the main 'UiPath' class for interacting with platform services has moved from the top-level package to the 'uipath.platform' submodule, now part of the `uipath-platform` dependency.

This quickstart demonstrates how to initialize the UiPath SDK and interact with basic services like listing processes. It requires `UIPATH_URL` and `UIPATH_ACCESS_TOKEN` to be set as environment variables. The SDK provides access to services like `sdk.processes`, `sdk.assets`, `sdk.buckets`, `sdk.connections`, `sdk.context_grounding`, `sdk.jobs`, `sdk.queues`, `sdk.tasks`, and `sdk.api_client`.

import os from uipath.platform import UiPath # Configure environment variables (replace with your actual values or .env file) UIPATH_URL = os.environ.get('UIPATH_URL', 'https://cloud.uipath.com/ACCOUNT_NAME/TENANT_NAME') UIPATH_ACCESS_TOKEN = os.environ.get('UIPATH_ACCESS_TOKEN', 'YOUR_TOKEN_HERE') # Ensure environment variables are set for authentication if not UIPATH_URL or not UIPATH_ACCESS_TOKEN: print("Please set UIPATH_URL and UIPATH_ACCESS_TOKEN environment variables.") exit(1) os.environ['UIPATH_URL'] = UIPATH_URL os.environ['UIPATH_ACCESS_TOKEN'] = UIPATH_ACCESS_TOKEN try: # Initialize the SDK sdk = UiPath() print(f"Successfully initialized UiPath SDK for URL: {UIPATH_URL}") # Example: List available processes (requires appropriate permissions) # Note: Error handling for API calls should be implemented in production code processes = sdk.processes.list() print(f"Found {len(processes)} processes:") for p in processes: print(f" - {p.name} (Key: {p.key})") # Example: Invoke a process (uncomment and modify for actual use) # job = sdk.processes.invoke( # name="MyProcess", # input_arguments={"param1": "value1", "param2": 42} # ) # print(f"Process invoked, Job ID: {job.id}") except Exception as e: print(f"An error occurred: {e}")
uipath --version
Debug
Known issues
breakingThe schema 'type' field for coded functions changed from 'agent' to 'function'. This affects how `UiPathFunctionsRuntime.get_schema()` behaves if you were expecting 'type: agent'.
fix
Review your `uipath.json` and any code interacting with `UiPathFunctionsRuntime.get_schema()` to account for `type: "function"` for entrypoints defined under 'functions'.
affects: v2.10.0 and later
breakingThe `platform` module, including the main `UiPath` class, was extracted into a new `uipath-platform` library. Additionally, `context grounding` contract changes removed `PreProcessing` and `Fields`, and added `extraction_strategy`, `embeddings_enabled`, `is_encrypted`.
fix
Install `uipath-platform` explicitly (`pip install uipath-platform`) and update imports from `from uipath import UiPath` to `from uipath.platform import UiPath`. Review any code using `context grounding` for updated contract specifications.
affects: v2.9.0 and later
breakingVersion 2.2.0 introduced several breaking changes related to Studio Web Integration (`uipath push`/`uipath pull` commands) and the new Evaluation Framework (`uipath eval` command).
fix
Consult the official release notes for v2.2.0 for specific migration steps related to Studio Web integration and the Evaluation Framework.
affects: v2.2.0 and later
gotchaWhile the `uipath` Python SDK itself requires Python >=3.11, users integrating Python scripts via UiPath Studio's 'Python Activities' (a separate UiPath package) might encounter compatibility issues with Python versions newer than 3.10 or 3.12, depending on the UiPath Studio version. Always check the UiPath Studio documentation for 'Python Activities' specific compatibility if using that integration method.
fix
If encountering 'Python Scope: Error initializing Python engine' or similar issues when integrating with UiPath Studio, verify the Python version compatibility required by your specific 'UiPath.Python.Activities' package and UiPath Studio version. The `uipath` Python SDK's requirements are separate from UiPath Studio's activity package requirements.
affects: All versions of UiPath Studio's Python Activities
Errors
Common errors & fixes
ModuleNotFoundError: No module named 'uipath.orchestrator'
The `Orchestrator` client is directly available under the top-level `uipath` package, not within a submodule named `uipath.orchestrator`.
fix
from uipath import Orchestrator
uipath.sdk.exceptions.UiPathSdkException: Status: 401
This error indicates that the provided API credentials (Client ID and Client Secret) are either invalid or lack the necessary permissions for the requested operation.
fix
Verify that the `client_id` and `client_secret` are correct and belong to an application with appropriate API access permissions in UiPath Automation Cloud.
uipath: command not found
The `uipath` command-line tool's executable is not in your system's PATH, or the Python environment where `uipath` was installed is not active/accessible.
fix
Ensure your Python environment's script directory is included in your system's PATH, or activate the virtual environment where `uipath` was installed.
uipath.sdk.exceptions.UiPathSdkException: Status: 404
The requested resource (e.g., asset, process, queue item) was not found in UiPath Orchestrator, or the provided name/ID is incorrect.
fix
Double-check the exact name or ID of the resource. Ensure it exists in your Orchestrator instance and that your application has permissions to view it.
AttributeError: module 'uipath' has no attribute 'AssetClient'
The `AssetClient` class is not directly available under the top-level `uipath` module. It resides in the `uipath.asset` submodule.
fix
from uipath.asset import AssetClient
Upgrade
Version history
2.14.10latest on PyPI · released Aug 28, 2026
Audit
Dependencies
uipath-platformrequiredThe core 'platform' module was extracted into this separate library in `uipath` v2.9.0 and is now a direct dependency for interacting with platform services.
Agent activity
38 hits · last 30 days
node
30
OpenAI (training)
2
Resources
uipath — pip install uipath · libregistry