To change your environments in the ADK, you must provide the ADK with your service instance URL and your watsonx Orchestrate API key. Currently, watsonx Orchestrate as a service (SaaS) is deployed in both IBM Cloud and AWS. Depending on which environment you have a valid account, the process to retrieve this information can vary.

The ADK is unable to connect to on-premises environments. Support for IBM Software Hub and IBM Cloud Pak for Data will come in later releases.

​
IBM Cloud

To connect to IBM Cloud, you need both the service instance URL and an API key of your watsonx Orchestrate instance.

1

Log in to your watsonx Orchestrate instance.

2

Click your user icon on the top right and click Settings.

user_settings.png

3

Go to the API details tab.

4

Copy the service instance URL.

5

Click the Generate API key button.

ibmcloud_credentials.png

6

Generate an API Key

The page redirects you to the IBM Cloud Identity Access Management center. Click Create to create a new API Key.

ibmcloud_iam.png

7

Enter a name and a description for your API Key.

ibmcloud_create_apikey.png

8

Copy the API key and store it in a safe vault.

ibmcloud_copy_apikey.png

​
AWS

To connect to an instance hosted on AWS, follow these steps:

1

Log in to your watsonx Orchestrate instance.

2

Click your user icon on the top right and click Settings.

user_settings.png

3

Go to the API details tab.

4

Copy the service instance URL.

5

Generate API key

Click the Generate API key button and copy the key.

aws_credentials.png

  • API keys are not retrievable and can’t be edited or deleted. Make sure to store your API keys in a safe location after you generate a new API key.
  • You are limited to 10 API keys in this environment. If you have no more available keys, contact IBM Support for further assistance.