UiPath Python SDK

PyPI downloads PyPI - Version Python versions

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

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.toml file with project metadata
  • A uipath.json file with your function definitions (e.g., "functions": {"main": "main.py:main"})
  • A entry-points.json file (generated by uipath init)
  • A bindings.json file (generated by uipath 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.

Project links

Data verified by PyPI on Jul 3, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.14.5)

Owner

PyPI data
Data sourced directly from PyPI's database.

3 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for cristipufu from gravatar.com cristipufu Avatar for gheorghitahurmuz from gravatar.com gheorghitahurmuz Avatar for mariuscosareanu from gravatar.com mariuscosareanu

Credits

Maintainer: Marius Cosareanu

GitHub Statistics

Data verified by PyPI on Jul 3, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

Requires

Python >=3.11

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uipath-2.12.6.tar.gz (4.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

uipath-2.12.6-py3-none-any.whl (417.4 kB view details)

Uploaded Python 3

File details

Details for the file uipath-2.12.6.tar.gz.

File metadata

  • Download URL: uipath-2.12.6.tar.gz
  • Upload date:
  • Size: 4.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for uipath-2.12.6.tar.gz
Algorithm Hash digest
SHA256 6bdfbefc5b05c5a601248bfa7bdc870e0328b177b290a04666e92c5e5bf41703
MD5 445c2a343c6c541bda91c346dcacb3ad
BLAKE2b-256 cdcc2fa4d5fef55f03198f8efdee69854c31afe8baa523391437089d61ff1478

See more details on using hashes here.

Provenance

The following attestation bundles were made for uipath-2.12.6.tar.gz:

Publisher: cd.yml on UiPath/uipath-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file uipath-2.12.6-py3-none-any.whl.

File metadata

  • Download URL: uipath-2.12.6-py3-none-any.whl
  • Upload date:
  • Size: 417.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for uipath-2.12.6-py3-none-any.whl
Algorithm Hash digest
SHA256 786d2e17cba38d0f583e3cb6e57999b366e8c58cf9a7efad90ddee777f1775ae
MD5 ea12fed7445cc08ba2ace6be12d6a0aa
BLAKE2b-256 7570e0e584e6445a1f0815c52b9d1069e5138097c443a81325fe07692571c213

See more details on using hashes here.

Provenance

The following attestation bundles were made for uipath-2.12.6-py3-none-any.whl:

Publisher: cd.yml on UiPath/uipath-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

2.14.5

2.14.4

2.14.2

2.14.1

2.14.0

2.13.22

2.13.21

2.13.20

2.13.19

2.13.18

2.13.17

2.13.16

2.13.15

2.13.14

2.13.13

2.13.12

2.13.11

2.13.10

2.13.9

2.13.8

2.13.7

2.13.6

2.13.5

2.13.4

2.13.3

2.13.2

2.13.1

2.13.0

2.12.8 yanked

Reason this release was yanked:

breaking change

2.12.7

This release

2.12.6

2.12.5

2.12.4

2.12.3

2.12.2

2.12.1

2.12.0

2.11.19

2.11.18

2.11.17

2.11.16

2.11.15

2.11.14

2.11.13

2.11.12

2.11.11

2.11.10

2.11.9

2.11.8

2.11.7

2.11.6

2.11.5

2.11.4

2.11.3

2.11.1

2.11.0

2.10.84

2.10.83

2.10.82

2.10.81

2.10.80

2.10.79

2.10.78

2.10.77

2.10.76

2.10.75

2.10.74

2.10.73

2.10.72

2.10.71

2.10.70

2.10.69

2.10.68

2.10.67

2.10.66

2.10.65

2.10.64

2.10.63

2.10.62

2.10.61

2.10.60

2.10.59

2.10.58

2.10.57

2.10.56

2.10.55

2.10.54

2.10.53

2.10.52

2.10.51

2.10.50

2.10.49

2.10.48

2.10.47

2.10.46

2.10.45

2.10.44

2.10.43

2.10.42

2.10.41

2.10.40

2.10.39

2.10.38

2.10.37

2.10.36

2.10.35

2.10.34

2.10.33

2.10.32

2.10.31

2.10.30

2.10.29

2.10.28

2.10.27

2.10.26

2.10.25

2.10.24

2.10.23

2.10.22

2.10.21

2.10.20

2.10.19

2.10.18

2.10.17

2.10.16

2.10.15

2.10.14

2.10.13

2.10.12

2.10.11

2.10.10

2.10.9

2.10.8

2.10.7

2.10.6

2.10.5

2.10.4

2.10.3

2.10.2

2.10.1

2.10.0

2.9.15

2.9.14

2.9.13

2.9.12

2.9.11

2.9.10

2.9.9

2.9.8

2.9.7

2.9.6

2.9.5

2.9.4

2.9.3

2.9.2

2.9.1

2.9.0

2.8.49

2.8.48

2.8.47

2.8.46

2.8.45

2.8.44

2.8.43

2.8.42

2.8.41

2.8.40

2.8.39

2.8.38

2.8.37

2.8.36

2.8.35

2.8.34

2.8.33

2.8.32

2.8.31

2.8.30

2.8.29

2.8.28

2.8.27

2.8.26

2.8.25

2.8.24

2.8.23

2.8.22

2.8.21

2.8.20

2.8.19

2.8.18

2.8.17

2.8.16

2.8.15

2.8.14

2.8.13

2.8.12

2.8.11

2.8.10

2.8.9

2.8.8

2.8.7

2.8.6

2.8.5

2.8.4

2.8.3

2.8.2

2.8.1

2.8.0

2.7.11

2.7.10

2.7.9

2.7.8

2.7.7

2.7.6

2.7.5

2.7.4

2.7.3

2.7.2

2.7.1

2.7.0

2.6.32 yanked

Reason this release was yanked:

Breaking compat with uipath-langchain

2.6.31

2.6.30

2.6.29

2.6.28

2.6.27

2.6.26

2.6.25

2.6.24

2.6.23

2.6.22

2.6.21

2.6.20

2.6.19

2.6.18

2.6.17

2.6.16

2.6.15

2.6.14

2.6.13

2.6.12

2.6.11

2.6.10

2.6.9

2.6.8

2.6.7

2.6.6

2.6.5

2.6.4

2.6.3

2.6.2

2.6.1

2.6.0

2.5.40

2.5.39

2.5.38

2.5.37

2.5.36

2.5.35

2.5.34

2.5.33

2.5.32

2.5.31

2.5.30

2.5.29

2.5.28

2.5.27

2.5.26

2.5.25

2.5.24

2.5.23

2.5.22

2.5.21

2.5.20

2.5.19

2.5.18

2.5.17

2.5.16

2.5.15

2.5.14

2.5.13

2.5.12

2.5.11

2.5.10

2.5.9

2.5.8

2.5.7

2.5.6

2.5.5

2.5.4

2.5.3

2.5.2

2.5.1

2.5

2.4.24

2.4.23

2.4.22

2.4.21

2.4.20

2.4.19

2.4.18

2.4.17

2.4.15

2.4.14

2.4.13

2.4.12

2.4.11

2.4.10

2.4.9

2.4.8

2.4.7

2.4.6

2.4.5

2.4.4

2.4.3

2.4.2

2.4.1

2.4.0

2.3.5

2.3.4

2.3.3

2.3.2

2.3.1

2.3.0

2.2.45

2.2.44

2.2.43

2.2.42

2.2.41

2.2.40

2.2.39

2.2.38

2.2.37

2.2.36

2.2.35

2.2.34

2.2.33

2.2.32

2.2.31

2.2.30

2.2.29

2.2.28

2.2.27

2.2.26

2.2.25

2.2.24

2.2.23

2.2.22

2.2.21

2.2.20 yanked

Reason this release was yanked:

bad merge

2.2.19

2.2.18

2.2.17

2.2.16

2.2.15

2.2.14

2.2.13

2.2.12

2.2.11

2.2.10

2.2.8

2.2.7

2.2.6

2.2.5

2.2.4

2.2.3

2.2.2

2.2.1

2.2.0

2.1.185

2.1.184

2.1.183

2.1.182

2.1.181

2.1.180

2.1.179

2.1.178

2.1.177

2.1.176

2.1.175

2.1.174

2.1.173

2.1.172

2.1.171

2.1.170

2.1.169

2.1.168

2.1.167

2.1.166

2.1.165

2.1.164

2.1.163

2.1.162

2.1.161

2.1.160

2.1.159

2.1.158

2.1.157

2.1.156

2.1.155

2.1.154

2.1.153

2.1.152

2.1.151

2.1.150

2.1.149

2.1.148

2.1.147

2.1.146

2.1.145

2.1.144

2.1.143

2.1.142

2.1.141

2.1.140

2.1.139

2.1.138

2.1.137

2.1.136

2.1.135

2.1.134

2.1.133

2.1.132

2.1.131

2.1.130

2.1.129

2.1.128

2.1.127

2.1.126

2.1.125

2.1.124

2.1.123

2.1.122

2.1.121

2.1.119

2.1.118

2.1.117

2.1.116

2.1.115

2.1.114

2.1.113

2.1.112

2.1.111

2.1.110

2.1.109

2.1.108

2.1.107

2.1.106

2.1.105

2.1.104

2.1.103

2.1.102

2.1.101

2.1.100

2.1.99

2.1.98

2.1.97

2.1.96

2.1.95

2.1.94

2.1.93

2.1.92

2.1.91

2.1.90

2.1.89

2.1.88

2.1.87

2.1.86

2.1.85

2.1.84

2.1.83

2.1.82

2.1.81 yanked

Reason this release was yanked:

auth command not working on MacOS

2.1.80

2.1.79

2.1.78

2.1.77

2.1.76

2.1.75

2.1.74

2.1.73

2.1.72

2.1.71

2.1.70

2.1.69

2.1.68

2.1.67

2.1.66

2.1.65

2.1.64

2.1.63

2.1.62

2.1.61

2.1.60

2.1.59

2.1.58

2.1.57

2.1.56

2.1.55

2.1.54

2.1.53 yanked

2.1.52

2.1.51

2.1.50

2.1.49

2.1.48

2.1.47

2.1.46

2.1.45

2.1.44

2.1.43

2.1.42

2.1.41

2.1.40

2.1.39

2.1.38

2.1.37

2.1.36

2.1.35

2.1.34

2.1.33

2.1.32

2.1.31

2.1.30

2.1.29

2.1.28

2.1.27

2.1.26

2.1.25

2.1.24

2.1.23

2.1.22

2.1.21

2.1.20

2.1.18

2.1.17

2.1.16

2.1.15 yanked

Reason this release was yanked:

pack ignores subdirs

2.1.14

2.1.13

2.1.12

2.1.11

2.1.10

2.1.9

2.1.8

2.1.7

2.1.6

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.1.0

2.0.84

2.0.83

2.0.82

2.0.81

2.0.80

2.0.79

2.0.78

2.0.77

2.0.76

2.0.75

2.0.74

2.0.73

2.0.72

2.0.71

2.0.70

2.0.69

2.0.68

2.0.67 yanked

Reason this release was yanked:

permission issues

2.0.66

2.0.65

2.0.64

2.0.63

2.0.62

2.0.61

2.0.60

2.0.59

2.0.58

2.0.57

2.0.56

2.0.55

2.0.54

2.0.53

2.0.52

2.0.51

2.0.50

2.0.49

2.0.48

2.0.47

2.0.46

2.0.45

2.0.44

2.0.43

2.0.42

2.0.41

2.0.40

2.0.39

2.0.38

2.0.37

2.0.36

2.0.35

2.0.34

2.0.33

2.0.32

2.0.31

2.0.30

2.0.29

2.0.28

2.0.27

2.0.26

2.0.25

2.0.24 yanked

Reason this release was yanked:

breaking change with uipath-langchain

2.0.23

2.0.22

2.0.21

2.0.20

2.0.19

2.0.19.dev1002910038 pre-release

2.0.19.dev1002910037 pre-release

2.0.19.dev1002910036 pre-release

2.0.19.dev1002910021 pre-release

2.0.19.dev10291020 pre-release

2.0.18

2.0.17

2.0.16

2.0.15

2.0.14

2.0.13

2.0.12

2.0.11

2.0.10

2.0.9

2.0.8

2.0.7

2.0.6

2.0.5

2.0.4

2.0.4.dev5 pre-release

2.0.4.dev4 pre-release

2.0.4.dev3 pre-release

2.0.4.dev2 pre-release

2.0.3

2.0.2.dev2 pre-release

2.0.2.dev1 pre-release

2.0.1

2.0.1.dev1 yanked

2.0.0 yanked

2.0.0.dev3 yanked

2.0.0.dev2 yanked

1.1.1 yanked

1.0.0 yanked

0.0.1 yanked

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page