Generating an API key

Get the API key to authenticate you on watsonx Orchestrate API for 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.

    User icon and Settings option
    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 watsonx Orchestrate AWS authentication endpoint and pass the generated API key. For more information, see Generating a JWT token.