Get an API Key#

You need to generate an API key to access NVIDIA NIM Microservices from the NVIDIA RAG Blueprint. You need an API key to access models hosted in the NVIDIA API Catalog, and to download models on-premises. For more information, refer to NGC API Keys.

To generate an API key, use the following procedure.

  1. Go to https://org.ngc.nvidia.com/setup/api-keys.

  2. Click Generate Personal Key.

  3. Enter a Key Name.

  4. For Expiration, choose Never Expire.

  5. For Services Included, select NGC Catalog and Public API Endpoints.

  6. Click Generate Personal Key.

  7. Copy your key and save it somewhere safe and private.

  8. (Important) Export your key as an environment variable by using the following code.

    export NGC_API_KEY="<your-ngc-api-key>"

API Key Expiration#

If your API key expires, do one of the following:

  • Create a new key by using the previous procedure, and then delete the expired key.

  • Use the Action menu to Rotate your key.

You must update the new key information in your environment variables and code.