IBM API Hub
IBM watsonx Orchestrate API

By IBM watsonx Orchestrate

IBM watsonx Orchestrate provides a set of APIs to boost your experience using the features from the product.


Authenticating to the API

Authenticate to the watsonx Orchestrate API to use its operations. Each watsonx Orchestrate offering has they own authentication method.

Amazon Web Services (AWS) offering

The AWS offering uses a JSON Web Token (JWT) to authenticate you in the watsonx Orchestrate API. You get this token by making a request to the API passing your API key to the API.

You get the API key in your watsonx Orchestrate settings page. Follow the procedure to generate an API key:

  1. Click your profile icon.

  2. Click Settings.

    Figure 1. The image shows the profile icon and the Settings option.
  3. Click API details.

  4. Click Generate API key.

  5. Click Copy to copy the API key to your clipboard.

With it, the API key is generated and temporarily saved in your clipboard. Paste the API key to use it or save safely. Save each API key that you generate, you can't delete this API key after the generation step. Also, users can generate up to a maximum of 10 keys.

After that, to get the JWT Token, make a request to the authentication endpoint and pass the generated API key. For more information, see Generating a JWT token.

On-premises offering

The on-premises offering uses a Zen API key to authenticate you in the watsonx Orchestrate API. The Zen API key is the concatenation of your username with the API key of your on-premises environment in Base64.

You get the API key in the Software Hub page of your on-premises environment. From that page, follow the procedure to generate the API key:

  1. Click the profile icon.

  2. Click Profile and settings

    Figure 2. The image shows the profile icon and the Profile and settings option.
  3. Click API key > Generate new key.

  4. Click Generate.

  5. Click Copy and save your key somewhere safe. You cannot recover this key if you lose it.

Then, to obtain the Zen API key, you must encode it with your username in Base64 following the structure:

<username>:<API key>

You can use the tool of your preference to make the encode. The following code snippet is an example of how to encode the username and API key in Base64 by using the echo command in a terminal:

$ echo "{username}:{API key}" | base64

IBM Cloud offering

The watsonx Orchestrate for IBM Cloud offering uses the IAM API key to authenticate you on the watsonx Orchestrate API.

To get the IAM API key, access the IBM Cloud Identity and Access Management page in your IBM Cloud console. From the console, follow the procedure to generate the IAM API key:

  1. In the IAM menu, click Manage identities.

  2. Click API keys.

    Figure 3. The image shows the API keys menu in the IBM Cloud.
  3. Click Create.

  4. Set a name for the API key.

  5. Click Create.

  6. Click Copy and save your key somewhere safe.

Open API Specification

About specification
API Version

1.0.1

Legend
Technologies
Products & Services
Company information
Company logoIBM Watsonx Orchestrate