Articles in this section

Set up a connection to WatsonX

Tanisha Ray
Updated

Watsonx is a cloud-native AI and data platform that helps organizations build, fine-tune, deploy, and govern generative AI and machine-learning solutions at enterprise scale.

Set up a connection

After you start the connection, configure it in the Create connection panel and complete all of the required * authentication settings:

Setting

Instructions

Name your connection * 

Enter a clear and distinguishable name.

Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.

API type *

Choose your WatsonX account API type:

  • Global: Manage Watsonx projects, shared resources to administer environments and develop, run, and collaborate centrally.

  • Prompts and agents: Create, manage, and execute prompts and AI agents. Use it to standardize prompt engineering and build intelligent agents that automate tasks and workflows.

  • Notebooks: Build, experiment, and train machine-learning and generative AI models in interactive notebooks to accelerate development, testing, and collaboration.

  • Orchestrate: Coordinate AI workflows, tools, and agents to automate multi-step processes and enable intelligent, goal-driven interactions across systems.

API type:Global

Region *

Select your WatsonX account region.

Version *

Enter your WatsonX account version.

Project ID *

Enter your WatsonX account project ID.

dataLoad.svg​​ How to retrieve the project ID

API key *

Enter your WatsonX API key.

Multiple layers of protection are in place, including AES 256 encryption, to keep your connection’s API key safe. When editing this form later, you must enter this key again; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​ How to retrieve the API key

API type: Prompts and agents

Region *

Select your WatsonX account region.

API key *

Enter your WatsonX API key.

Multiple layers of protection are in place, including AES 256 encryption, to keep your connection’s API key safe. When editing this form later, you must enter this key again; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​ How to retrieve the API key

API type: Notebooks

Region *

Select your WatsonX account region.

Notebook GUID *

Enter your WatsonX account notebook GUID. For more information, see Create a new version.

API key *

Enter your WatsonX API key.

Multiple layers of protection are in place, including AES 256 encryption, to keep your connection’s API key safe. When editing this form later, you must enter this key again; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​ How to retrieve the API key

API type: Orchestrate

Mode *

Choose your WatsonX account mode (Cloud or On-premise).

Mode: Cloud

Environment *

Select your WatsonX account environment (AWS or IBM Cloud).

Hostname *

Enter your WatsonX hostname. For example, if your WatsonX account URL is https://api.celigo1/instances/123456/v1/skillsets, then celigo1 is your hostname.

Tenant ID *

Enter your WatsonX account tenant ID. For example, if your WatsonX account URL is https://api.celigo1/instances/123456/v1/skillsets, then 123456 is your tenant ID.

API key *

Enter your WatsonX API key.

Multiple layers of protection are in place, including AES 256 encryption, to keep your connection’s API key safe. When editing this form later, you must enter this key again; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​ How to retrieve the API key

Mode: On-premise

On-premise agent *

Select an on-premise agent from the list.

To connect to an on-premise application, integrator.io requires that an agent be installed on a networked computer. For more information see On-premise agent.

On-premise host *

Enter your WatsonX account on-premise host.

Port *

Enter your WatsonX port. For example, if your WatsonX account URL is https://onprem.example.com:8443/orchestrate/prod/instances/inst-12345/v1?username=jdoe, then 8443 is your port.

Namespace *

Enter your WatsonX hostname. For example, if your WatsonX account URL is https://onprem.example.com:8443/orchestrate/prod/instances/inst-12345/v1?username=jdoe, then prod is your namespace.

Instance ID *

Enter your WatsonX hostname. For example, if your WatsonX account URL is https://onprem.example.com:8443/orchestrate/prod/instances/inst-12345/v1?username=jdoe, then inst-12345 is your instance ID.

Username *

Enter your WatsonX hostname. For example, if your WatsonX account URL is https://onprem.example.com:8443/orchestrate/prod/instances/inst-12345/v1?username=jdoe, then jdoe is your username.

API key *

Enter your WatsonX API key.

Multiple layers of protection are in place, including AES 256 encryption, to keep your connection’s API key safe. When editing this form later, you must enter this key again; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​ How to retrieve the API key

Tip

This connector documentation describes only the settings shown for the Simple view. For the corresponding HTTP settings, see Token auth universal connector documentation.

How to retrieve the API key (Global, Prompts and agents, and Notebooks)

  1. Sign in to your IBM Cloud account.

  2. Navigate to Manage > Access (IAM) > API keys.

  3. Click Create.

  4. Enter a Name.

  5. Click Create.

  6. Copy the API key.

How to retrieve the project ID

  1. Sign in to your IBM WatsonX account.

  2. Navigate to Manage > General > Details.

  3. Copy the Project ID.

How to retrieve the API key (Orchestrate)

Mode: Cloud

AWS

  1. Sign in to your IBM WatsonX account.

  2. Navigate to Profile icon > Settings.

  3. Click API details.

  4. Click Generate API key.

  5. Copy the API key.

IBM Cloud

  1. Sign in to your IBM Cloud account.

  2. Click Catalog.

  3. Enter “WatsonX Orchestrate” in the search bar.

  4. Select WatsonX Orchestrate in Catalog service.

  5. Select the Region.

  6. Click Create.

  7. Enter a Name.

  8. Click Create.

  9. Copy the Instance URL.

  10. Copy the API key.

Mode: On-premise

  1. Sign in to your IBM WatsonX account.

  2. Navigate to Profile icon > Profile and settings.

  3. Navigate to API key > Generate new key.

  4. Click Generate.

  5. Copy the API key.

Additional references