This release is a pre-release and may not be stable for production use.
UiPath Python SDK
A Python SDK that enables programmatic interaction with UiPath Platform services including processes, assets, buckets, context grounding, data services, jobs, and more. The package also features a CLI for creation, packaging, and deployment of automations to UiPath Platform.
Use the UiPath LangChain SDK to pack and publish LangGraph Agents.
Table of Contents
- Installation
- Configuration
- Basic Usage
- Available Services
- Examples
- Command Line Interface (CLI)
- Project Structure
- Development
Installation
pip install uipath
using uv:
uv add uipath
Configuration
Environment Variables
Create a .env file in your project root with the following variables:
UIPATH_URL=https://cloud.uipath.com/ACCOUNT_NAME/TENANT_NAME
UIPATH_ACCESS_TOKEN=YOUR_TOKEN_HERE
Basic Usage
from uipath import UiPath
# Initialize the SDK
sdk = UiPath()
# Execute a process
job = sdk.processes.invoke(
name="MyProcess",
input_arguments={"param1": "value1", "param2": 42}
)
# Work with assets
asset = sdk.assets.retrieve(name="MyAsset")
Available Services
The SDK provides access to various UiPath services:
-
sdk.processes- Manage and execute UiPath automation processes -
sdk.assets- Work with assets (variables, credentials) stored in UiPath -
sdk.buckets- Manage cloud storage containers for automation files -
sdk.connections- Handle connections to external systems -
sdk.context_grounding- Work with semantic contexts for AI-enabled automation -
sdk.jobs- Monitor and manage automation jobs -
sdk.queues- Work with transaction queues -
sdk.actions- Work with Action Center -
sdk.api_client- Direct access to the API client for custom requests
Examples
Buckets Service
# Download a file from a bucket
sdk.buckets.download(
bucket_key="my-bucket",
blob_file_path="path/to/file.xlsx",
destination_path="local/path/file.xlsx"
)
Context Grounding Service
# Search for contextual information
results = sdk.context_grounding.search(
name="my-knowledge-index",
query="How do I process an invoice?",
number_of_results=5
)
Command Line Interface (CLI)
The SDK also provides a command-line interface for creating, packaging, and deploying automations:
Authentication
uipath auth
This command opens a browser for authentication and creates/updates your .env file with the proper credentials.
Initialize a Project
uipath init [ENTRYPOINT]
Creates a uipath.json configuration file for your project. If the entrypoint is not provided, it will try to find a single Python file in the current directory.
Debug a Project
uipath run ENTRYPOINT [INPUT]
Executes a Python script with the provided JSON input arguments.
Package a Project
uipath pack
Packages your project into a .nupkg file that can be deployed to UiPath.
Note: Your pyproject.toml must include:
- A description field (avoid characters: &, <, >, ", ', ;)
- Author information
Example:
description = "Your package description"
authors = [{name = "Your Name", email = "your.email@example.com"}]
Publish a Package
uipath publish
Publishes the most recently created package to your UiPath Orchestrator.
Project Structure
To properly use the CLI for packaging and publishing, your project should include:
- A
pyproject.tomlfile with project metadata - A
uipath.jsonfile (generated byuipath init) - Any Python files needed for your automation
Development
Setting Up a Development Environment
Please read CONTRIBUTING.md before submitting a pull request.
3 maintainers
Release files for uipath 2.0.19.dev1002910036
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| uipath-2.0.19.dev1002910036.tar.gz | 250.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| uipath-2.0.19.dev1002910036-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 345.5 kB
Release files / uipath-2.0.19.dev1002910036.tar.gz
| Download URL | uipath-2.0.19.dev1002910036.tar.gz |
|---|---|
| Size | 250.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6989fe9f9f3a35bba2d28d51b70c695894a3dde213ba62de4f12ae1a0fb6e14f
|
|
BLAKE2b-256 checksum How to use checksums |
5438d0bca19c969922c73c685e55096daf91098be3fbc89bd862275090ddbdf1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.6.16
|
Release files / uipath-2.0.19.dev1002910036-py3-none-any.whl
| Download URL | uipath-2.0.19.dev1002910036-py3-none-any.whl |
|---|---|
| Size | 95.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1f2089434387f2954a643ca5d3d714c1bc9fd70089109daa1bc41a6f3afe9204
|
|
BLAKE2b-256 checksum How to use checksums |
605bdec764e4125ae779f704987de875686a521c6708ba023e6f06226f38ba3c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.6.16
|
