Local setup¶

Before you can start building agentic workflows in Opaque, you’ll need a few things set up locally. This quick setup guide walks you through what’s required to use the Opaque Python SDK and connect to your secure workflows from your local machine.

Prerequisites¶

To use agentic workflows in Opaque, you’ll need:

• Python 3.10 or higher
• Access to the Opaque Python SDK ZIP file (provided by your Opaque contact)

Step 1. 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, you can run:

sudo apt install python3 python3-pip

Once Python is installed, you're ready to install the SDK.

Step 2. Install the Opaque SDK¶

After confirming that Python is installed, the next step is to install the Opaque SDK. The SDK allows you to connect to your deployed workflows and invoke them programmatically from your local environment.

Important: The SDK version must match your Opaque deployment version.

To check your Opaque deployment version, you can look in either of two places:

• 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).

Once you’ve received the SDK ZIP file from your Opaque contact:

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.