uipath-runtime

What it is and what it does

uipath-runtime is a foundational library that defines the contracts and protocols all runtimes must follow within the UiPath ecosystem. It is not typically installed directly by end users; instead, it serves as a dependency for higher-level SDKs. The package provides base interfaces for runtime execution, including schema definition, async execution, optional event streaming, resource cleanup, and structured error handling.

When building custom runtime implementations, you import types and interfaces from this package to ensure your runtime conforms to UiPath's execution model. It supplies utilities for execution context (file I/O, logging), event types for real-time monitoring, error codes and categories for consistent error reporting, and a factory protocol for runtime discovery and instantiation. Most developers will encounter this as a transitive dependency rather than importing it directly.

Use it for:

• Building a custom agent runtime that integrates with UiPath orchestration platforms
• Implementing structured error handling and event streaming for automation scripts
• Creating a runtime factory to support discovery and dynamic instantiation of multiple runtime types
• Defining input/output schemas and execution contracts for compatible agents
• Capturing and monitoring real-time execution events during long-running automation tasks

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides foundational runtime interfaces and protocols for building agent runtimes in the UiPath ecosystem, including execution context, event streaming, structured error handling, and factory patterns.

Yes, if you are building a custom runtime implementation for the UiPath ecosystem. No, if you are only using higher-level SDKs—it will be installed automatically as a dependency. Verify the unclear license status before committing to a production project. The package is actively maintained and has no known vulnerabilities.

Install

uipath-runtime on PyPI

pip install uipath-runtime

uv add uipath-runtime

poetry add uipath-runtime

Installing uipath-runtime

Before you install

Active maintenance with a recent release (2 days old). Low install friction with only 3 runtime dependencies. Supports current Python versions (3.11, 3.12, 3.13).

License in practice

License status is unclear—no SPDX identifier or raw license text is declared. Verify licensing terms before use in proprietary or restricted projects.

Quickstart

pip install uipath-runtime

from uipath.runtime import (
    UiPathRuntimeResult,
    UiPathRuntimeStatus,
    UiPathRuntimeSchema,
)

class MyRuntime:
    async def get_schema(self) -> UiPathRuntimeSchema:
        return UiPathRuntimeSchema(
            input={"type": "object", "properties": {"message": {"type": "string"}}},
            output={"type": "object", "properties": {"result": {"type": "string"}}},
        )
    
    async def execute(self, input=None, options=None) -> UiPathRuntimeResult:
        return UiPathRuntimeResult(
            output={'message': 'Hello'},
            status=UiPathRuntimeStatus.SUCCESSFUL,
        )

Requires Python 3.11 or later. Async/await syntax required for all protocol methods.

Verify before relying

• Whether this package is intended for direct use or primarily as a transitive dependency
• Specific license terms and restrictions (license_treatment is 'unclear')
• Real-world adoption rate and use patterns beyond documented downstream packages

Package facts

Evidence: uipath_runtime-0.13.1-py3-none-any.whl

Tags

More Build Tools packages