Skip to content

Prerequisites

What we will implement

This part prepares the accounts, software, and access needed for the workshop. You will not build an agent yet; you will leave with a ready workspace path for building, testing, evaluating, and deploying one in the later parts.

Before starting the workshop, make sure you have the following:

Accounts & Access

  • GitHub account
  • IBM partner account
  • Access to TechZone
  • Access to ticket creation

Software Prerequisites

Homebrew (macOS)

macOS only — Windows users skip this section.

Homebrew is the recommended package manager for macOS. It is used to install Python, uv, and other workshop dependencies.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

The installer may prompt for your macOS password. After it finishes, follow any printed instructions to add Homebrew to your PATH (typically needed on Apple Silicon Macs):

# Apple Silicon (M1/M2/M3) — add to ~/.zprofile then reload
echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zprofile
eval "$(/opt/homebrew/bin/brew shellenv)"

# Intel Macs — Homebrew is already on PATH, no extra step needed

Verify the installation:

brew --version

Python 3.12

The workshop is tested with Python 3.12. Use Python 3.12 for all workshop exercises; other versions are not covered by the workshop support path.

macOS:

# Option 1 — Homebrew (recommended)
brew install python@3.12

# Option 2 — python.org installer
# Download from https://www.python.org/downloads/ and run the .pkg file

Note: macOS ships with /usr/bin/python3 (Apple's system Python). Do not use it for the workshop — always use the version you install above.

Windows:

  1. Download the Windows installer directly from python.org:
  2. Python 3.12.10 👉 https://www.python.org/downloads/release/python-31210/ Scroll to the Files section at the bottom of the page and choose:
  3. Windows installer (64-bit) — for most modern PCs (e.g. python-3.12.10-amd64.exe)

  4. Windows installer (32-bit) — only if your system is 32-bit

  5. Run the downloaded .exe file

  6. ⚠️ On the first screen, check "Add Python 3.12 to PATH" before clicking anything else — skipping this is the most common cause of python not found errors
  7. Click Install Now

Verify the installation:

Windows users: Open PowerShell (press Win + R, type powershell, press Enter) and run:

python --version

macOS/Linux users: Open your terminal and run:

python3 --version

uv

uv is used by the ADK extension to manage packages. Install it before starting Part 1.

macOS/Linux:

# Option 1 — Homebrew
brew install uv

# Option 2 — installer script
curl -LsSf https://astral.sh/uv/install.sh | sh

Windows (PowerShell):

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Verify the installation in a terminal on either Windows or macOS:

uv --version

1. Create a watsonx Orchestrate Instance

Primary: IBM watsonx Orchestrate Trial

Sign up for a free IBM watsonx Orchestrate trial account:

Start watsonx Orchestrate Trial

The trial provides enough capacity to complete all workshop exercises.

Backup 1: TechZone — Pilot reservation

If you have an IBM Opportunity ID, you can reserve a watsonx Orchestrate environment on TechZone:

When opening the collection, select the "watsonx Orchestrate essentials plan" reservation from the list, then pick Americas as the region.

Reservation type — use Pilot:

On the reservation form you will be asked to choose a purpose. Select Pilot and enter your Opportunity ID in the field provided. Using Pilot with an Opportunity ID is required for partner workshop access; selecting a different purpose may result in the reservation being rejected.

Where to find your Opportunity ID

Your Opportunity ID is the CRM opportunity number associated with the partner engagement. Ask your IBM contact or account team if you do not have it.

Backup 2: TechZone — Test environment (12 hours)

If you do not have an Opportunity ID, use this direct reservation link:

Reserve watsonx Orchestrate — Test (12 hours)

On the reservation form, select Test as the purpose. This provisions a fully functional watsonx Orchestrate environment valid for 12 hours — enough to complete the full workshop in a single session.

Collect your instance URL and API key

Once your watsonx Orchestrate instance is ready and you have opened it:

  1. Click your account icon in the top-right corner of the watsonx Orchestrate UI.
  2. Select Settings.
  3. Go to API details.
  4. Copy the Instance URL and save it in a safe place (e.g. a local notes file).
  5. Click Generate API key, copy the key immediately, and save it alongside the URL.

The Instance URL looks like this:

https://api.us-south.watson-orchestrate.cloud.ibm.com/instances/20250101-1234-5678-abcd-1234567890ab

Save both values now

The API key is shown only once. If you navigate away without copying it you will need to generate a new one.

These are the only two credentials the workshop needs

You will be asked for the same two values in several places. There is no second key and no separate IBM Cloud key to create — whenever a step asks for "the API key" or "the instance URL", it means these:

Value Where you use it
Instance URL Part 1 §8 (Environment Manager → Add) and Part 7 §3 (accelerator field WXO URL)
API key Part 1 §8 (activation prompt) and Part 7 §3 (accelerator field WXO API Key)

The optional Agent Evaluations & Red-Teaming module needs neither: its evaluation commands reuse the environment you activate in Part 1.

Never paste the API key into Bob chat

Type it only into the Environment Manager activation prompt or the accelerator's own password field. Do not save it in a project file and do not commit it.

2. Request a Bob Enterprise Account

Submit your request here:
https://www.ibm.com/support/pages/node/7159462

User Onboarding Request

Alternative: Bob IDE trial

If a Bob Enterprise Account is not available, use the Bob IDE trial as a backup: download Bob IDE.

Ready? Head to Part 1: Setup & Environment →