Local setup¶

Before you can start using agentic workflows from your local machine, you’ll need a short one-time setup. This guide walks you through what’s required to use the OPAQUE Python SDK and connect to secure workflows from your local environment.

Prerequisites¶

You’ll need:

• Python 3.10 or higher
• Access to an OPAQUE deployment (you will look up its version)
• Access to the Opaque Python SDK ZIP file (provided by OPAQUE)

Check your Python version¶

Open a terminal and run:

python3 --version

If Python is not installed or the version is lower than 3.10, download the latest version from python.org/downloads.

For Linux users, run:

sudo apt install python3 python3-pip

Once Python 3.10 or higher is installed, the next step is to look up your OPAQUE deployment version.

Locate your OPAQUE deployment version¶

To find the version you’re running:

• On the sign-in page, just below the Login button, or
• At the bottom of any page once you're signed in.

The version appears in the format Opaque vx.x.x (for example, Opaque v2.3.0). Make sure the OPAQUE Python SDK you install matches this version.

Install the OPAQUE SDK¶

The SDK lets you connect to your deployed workflows and invoke them programmatically from your local environment.

After identifying the correct version, proceed to install the SDK from the ZIP file you received from OPAQUE.

1. Unzip the SDK package:

   unzip opaque-python-package.zip
   

2. Install the SDK using pip:

   pip install opaque-<OPAQUE_VERSION>.tar.gz
   

   Replace <OPAQUE_VERSION> with the correct version number (e.g., 2.3.0).

If the installation is successful, you should see

Successfully installed opaque-x.x.x 

where x.x.x reflects your installed version, such as 2.3.0).

The SDK is now ready to use. You can programmatically invoke any approved workflow built in OPAQUE and receive structured responses directly in your development environment.