Generating an API key for on-premises

Get the Zen API key to authenticate to the watsonx Orchestrate API for on-premises offering.

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

    User icon and Profile and settings option
    Figure 1. 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>

For exampe:

myUser:abcdefghijklmnopqrstuvwxyz1234567890

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