uipath-openai-agents 0.0.9

Python SDK that enables developers to build and deploy OpenAI agents to the UiPath Cloud Platform

UiPath OpenAI Agents Python SDK

A Python SDK that enables developers to build and deploy OpenAI Agents to the UiPath Cloud Platform. It provides programmatic interaction with UiPath Cloud Platform services.

This package is an extension to the UiPath Python SDK and implements the UiPath Runtime Protocol.

Check out these sample projects to see the SDK in action.

Requirements

• Python 3.11 or higher
• UiPath Automation Cloud account

Installation

pip install uipath-openai-agents

using uv:

uv add uipath-openai-agents

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

Command Line Interface (CLI)

The SDK provides a command-line interface for creating, packaging, and deploying OpenAI Agents:

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

Running uipath init will process the agent definitions in the openai_agents.json file 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 AGENT [INPUT]

Executes the agent 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 = "[e-mail]"}]

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 openai_agents.json file with your agent definitions (e.g., "agents": {"agent": "main.py:agent"})
• 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

Developer Tools

Check out uipath-dev - an interactive application for building, testing, and debugging UiPath Python runtimes, agents, and automation scripts.

Setting Up a Development Environment

Please read our contribution guidelines before submitting a pull request.

Special Thanks

A huge thank-you to the open-source community and the maintainers of the libraries that make this project possible:

• OpenAI for providing a powerful framework for building AI agents.
• OpenInference for observability and instrumentation support.
• Pydantic for reliable, typed configuration and validation.