Getting the API endpoint

Get the API endpoint to use the watsonx Orchestrate API. The way that you get this endpoint varies according to the offering that you are use.

Amazon Web Services (AWS) offering

For the AWS offering, you get the API endpoint in the watsonx Orchestrate settings page. Follow the procedure to get the API endpoint for AWS:

  1. Click your profile icon.

  2. Click Settings.

    User icon and Settings option
    Figure 1. The image shows the profile icon and the Settings option.

  3. Click API details.

  4. Click Copy to clipboard button.

  5. Copy the Service instance URL.

After that the API endpoint is saved in your clipboard, the endpoint saved in your clipboard follows the structure:

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

On-premises offering

For the On-premises offering, the service endpoint is based on your deployment URL. It follows the structure:

https://<root_uri>/orchestrate/<namespace>/instances/<instanceid>

Where:

  • <root_uri> is the deployment URL.

  • <instanceid> is the unique identifier of your instance. It is the number sequence after orchestrate- in the instance details URL.

    The instance ID in the URL
    Figure 2. The image shows the instance ID in the URL.

  • <namespace> is the namespace of your instance. To retrieve the <namespace>, use the operation Get service instance details. This operation is documented in the IBM Cloud Pak for Data Platform API 5.0.0 documentation.

IBM Cloud offering

For the IBM Cloud offering, the service endpoint is based on your watsonx Orchestrate URL and the instance ID. It follows the structure:

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

Where:

  • <hostname> is the watsonx Orchestrate URL.

  • <tenant_id> is the Tenant ID of your tenant on watsonx Orchestrate. You can get the tenant ID from the About window. It is the last 32 characters that appears in the crn section.

    Tenant ID in the crn
    Figure 3. The image shows the Tenant ID.