Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.watson-orchestrate.ibm.com/llms.txt

Use this file to discover all available pages before exploring further.

The watsonx Orchestrate Developer Edition now supports integration with the wxO SaaS tenant for LLM inferencing. Previously, developers were required to configure the Developer Edition using their own watsonx.ai API key and Space ID. This update simplifies the setup process by enabling proxy usage through Watsonx Orchestrate. This configuration approach also applies to other supported LLM providers, including Groq and AWS Bedrock.

Prerequisites

To retrieve the necessary configuration details, you must have access to an instance of watsonx Orchestrate.

Environment Configuration

Additional environment variables are required to enable proxy usage. These variables differ based on the deployment type:

Common Parameters

VariableDescription
AUTHORIZATION_URLIAM URL used to authorize watsonx Orchestrate to access the proxy service.
USE_SAAS_ML_TOOLS_RUNTIMEEnables the ADK to use the proxy.

SaaS Deployment Configuration

For SaaS deployments, use the following environment variables:
WO_API_KEY=<your API key for Watson Orchestrate on SaaS>
WO_INSTANCE=<your service instance URL>
# The below two fields are optional and automatically inferred by the Developer Edition
AUTHORIZATION_URL=<your IAM URL>
USE_SAAS_ML_TOOLS_RUNTIME=True
Note:
watsonx.ai API Key and Space ID are no longer required.

On-premises Deployment Configuration

For on-premises deployments, use the following environment variables:
WO_USERNAME=<your username for onprem>
WO_PASSWORD=<your password for onprem>
WO_INSTANCE=<your service instance URL>
AUTHORIZATION_URL=<your IAM URL>
VariableDescription
WO_USERNAMEUsername used to log in to IBM SoftwareHub.
WO_PASSWORDPassword associated with WO_USERNAME.
WO_INSTANCEwatsonx Orchestrate server instance URL
AUTHORIZATION_URLOptional, an IAM URL used to authorize watsonx Orchestrate to access the proxy service.

Alternative LLM Providers

In addition to watsonx.ai models, the Developer Edition supports other LLM providers. Similar to watsonx.ai configuration, you can either provide your own credentials or use the watsonx Orchestrate proxy service.

Groq Configuration

To use the groq/openai/gpt-oss-120b model, you have two options: Option 1: Using Your Own Groq Credentials Add the following to your .env file:
GROQ_API_KEY=<your-groq-key>
Option 2: Using watsonx Orchestrate Proxy Configure the same WO_API_KEY and WO_INSTANCE variables as described in the SaaS Deployment Configuration or On-premises Deployment Configuration sections above.

AWS Bedrock Configuration

To use the bedrock/openai.gpt-oss-120b-1:0 model, you have two options: Option 1: Using Your Own AWS Bedrock Credentials Add the following to your .env file:
BEDROCK_AWS_ACCESS_KEY_ID=<your-bedrock-access-key-id>
BEDROCK_AWS_SECRET_ACCESS_KEY=<your-bedrock-secret-access-key>
Option 2: Using watsonx Orchestrate Proxy Configure the same WO_API_KEY and WO_INSTANCE variables as described in the SaaS Deployment Configuration or On-premises Deployment Configuration sections above.
Note: When using the watsonx Orchestrate proxy (Option 2), you don’t need to provide provider-specific credentials. The proxy handles authentication with the LLM providers on your behalf.