UiPath Python SDK
A Python SDK that enables programmatic interaction with UiPath Cloud 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 Cloud Platform.
Use the UiPath LangChain SDK to pack and publish LangGraph Agents.
Check out other UiPath Integrations to pack and publish agents built with LlamaIndex, OpenAI Agents, Google ADK, and more.
This quickstart guide walks you through deploying your first agent to UiPath Cloud Platform.
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.platform 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.tasks- 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
The uipath.json file should include your entry points in the functions section:
{
"functions": {
"main": "main.py:main"
}
}
Running uipath init will process these function definitions and create the corresponding entry-points.json file needed for deployment.
For more details on the configuration format, see the UiPath configuration specifications.
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 with your function definitions (e.g.,"functions": {"main": "main.py:main"}) - A
entry-points.jsonfile (generated byuipath init) - A
bindings.jsonfile (generated byuipath init) to configure resource overrides - Any Python files needed for your automation
Development
Tools
Check out uipath-dev - an interactive application for building, testing, and debugging UiPath Python runtimes, agents, and automation scripts.
Contributions
Please read our contribution guidelines before submitting a pull request.
3 maintainers
Release files for uipath 2.10.37.post1
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.10.37.post1.tar.gz | 2.9 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| uipath-2.10.37.post1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 3.3 MB
Release files / uipath-2.10.37.post1.tar.gz
| Download URL | uipath-2.10.37.post1.tar.gz |
|---|---|
| Size | 2.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
050b13dd1780d08c254fe103e4a193c17abf7a4c9d7e26ded5eff1625797b5a6
|
|
BLAKE2b-256 checksum How to use checksums |
afaae484bf941a90ad27c40b6083367bb9dba3d3b4aca983946ea1908d25b4f7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 8, 2026.
Transparency logRelease files / uipath-2.10.37.post1-py3-none-any.whl
| Download URL | uipath-2.10.37.post1-py3-none-any.whl |
|---|---|
| Size | 372.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9e2c6024d1ee7f4d27b6a41030398cb7584a42449d0e739aa4d1f42052a4ada8
|
|
BLAKE2b-256 checksum How to use checksums |
b7a7e40d804e8d2e0f150f64fa840bf458b1e4a9b93878aab0c021469305e038
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 8, 2026.
Transparency log
