Getting the API endpoint

The watsonx Orchestrate API endpoint varies depending on the offering that you use.

Follow the instructions for your specific offering to find the correct endpoint.

IBM Cloud offering

To get the API endpoint for the IBM Cloud offering:

  1. Log in to your watsonx Orchestrate account.

  2. Click your profile icon > Settings.

    User icon and Settings option
    Figure 1. Profile icon and Settings option

  3. Select the API details tab.

  4. Copy the Service instance URL.

The endpoint format is:

https://<hostname>/instances/<tenant_id>

Where:

  • <hostname> is the watsonx Orchestrate base URL. Common formats include:
    • https://api.<ibm-cloud-region>.watson.cloud.ibm.com/
    • https://api.<ibm-cloud-region>.cloud.ibm.com/
  • <tenant_id> is your watsonx Orchestrate tenant ID.

Amazon Web Services (AWS) offering

To get the API endpoint for the AWS offering:

  1. Log in to your watsonx Orchestrate account.

  2. Click your profile icon > Settings.

    User icon and Settings option
    Figure 1. Profile icon and Settings option

  3. Select the API details tab.

  4. Copy the Service instance URL.

The endpoint format is:

https://api.<region_code>.watson-orchestrate.ibm.com/instances/<tenant_id>

Where:

  • <region_code> is the AWS region where your instance is hosted.
  • <tenant_id> is your watsonx Orchestrate tenant ID.

On-premises offering

For the on-premises offering, the endpoint depends on the API you want to use:

  • watsonx Orchestrate API
  • AI Assistant Builder API

AI Assistant Builder API endpoint:

https://{onprem_host}:{port}/assistant/{namespace}/instances/{instance_id}/api

watsonx Orchestrate API endpoint:

https://{onprem_host}:{port}/orchestrate/{namespace}/instances/{instanceid}/v1

Parameters:

  • {onprem_host}: Hostname or IP of your IBM Software Hub cluster (for example, api.example.com).
    Find it in the IBM Software Hub web client under instance details.
  • {port}: Port number if required (for example, cpd.example.com:31843).
  • {namespace}: Namespace where your instance is deployed. Retrieve it using the Get service instance details API.
  • {instanceid}: Unique identifier of your instance. For watsonx Orchestrate, it’s the number after orchestrate- in the instance details URL.