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.

​
Overview

Runs-elsewhere mode is used when an agent or application runs outside the watsonx Orchestrate runtime. This mode uses instance credentials to authenticate and send requests to the platform.

​
Authentication

Authentication is handled by providing instance credentials, such as API key and instance URL. The SDK manages token generation and request authentication.

​
Examples

​
AWS production

PYTHON
from ibm_watsonx_orchestrate_sdk import Client

client = Client(
    api_key='api_key',
    instance_url='https://api.dl.watson-orchestrate.ibm.com/instances/20250430-0949-0287-00f2-33dc583100c9'
)

​
CPD

PYTHON
from ibm_watsonx_orchestrate_sdk import Client
client = Client(
    password='password',
    username='https://cpd-cpd-instance-1.apps.wo-533-br-source.cp.fyre.ibm.com/orchestrate/cpd-instance-1/instances/1777441537260557'
)

​
HIPAA

PYTHON
from ibm_watsonx_orchestrate_sdk import Client

client = Client(
    api_key='api_key',
    instance_url='https://api.dl.watson-orchestrate.ibm.com/instances/20250430-0949-0287-00f2-33dc583100c9',
    iam_url=""
)

​
Local (developer edition)

PYTHON
from ibm_watsonx_orchestrate_sdk import Client
client = Client()
  • Instance credentials are required for authentication.
  • The SDK manages token handling internally.
  • Requests are routed through the configured instance URL.
  • Local configuration applies only when running developer edition locally.

​
References