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.

​
IBM Cloud

To connect to IBM Cloud, you need both the service instance URL and an API key of your watsonx Orchestrate instance.
Don’t use the credentials that you get from the IBM Cloud resources page. Use the following procedure to get the appropriate API key and service instance URL.
1

Log in to your watsonx Orchestrate instance.
2

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

Go to the API details tab.
4

Copy the service instance URL.
5

Click the Generate API key button.
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.
7

Enter a name and a description for your API Key.
8

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

Add and activate your environment with the ADK CLI:
BASH
orchestrate env add -n my-name -u https://my-service-instance-url --type ibm_iam --activate
For more information, see Configuring your environments.

​
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.
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.
  • 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.
6

Add and activate your environment with the ADK CLI:
BASH
orchestrate env add -n my-name -u https://my-service-instance-url --type mcsp --activate
For more information, see Configuring your environments.

​
On-premises

For on-premises environments, you can authenticate using one of two methods:
  • API Key Use the API key that authenticates your user in the on-premises watsonx Orchestrate environment.
  • Username and Password Use your username and password credentials to authenticate in the on-premises watsonx Orchestrate environment.
Note: You can only use one authentication method at a time. If you try to authenticate using both methods simultaneously, an authentication error occurs.