> ## Documentation Index
> Fetch the complete documentation index at: https://docs.udiconnect.io/llms.txt
> Use this file to discover all available pages before exploring further.

# API Key Generation

> How to generate and manage API keys for authenticating API requests in both Preview and Production environments.

<Steps>
  <Step title="Go to API Keys">
    * In the sidebar, navigate to **API Keys** under the **Settings** section.
    * Here you can view, create, and manage all API keys for your organization in both **Preview** and **Production** environments.

    <img className="block dark:hidden" src="https://mintlify.s3.us-west-1.amazonaws.com/p36/images/imagevers1_1/apikeyside.png" alt="API Keys overview" />

    <img className="hidden dark:block" src="https://mintlify.s3.us-west-1.amazonaws.com/p36/images/imagevers1_1/apikeyside.png" alt="API Keys overview" />
  </Step>

  <Step title="Create a New API Key">
    * Click the **Create API Key** button in the top right corner.
    * A dialog will appear where you can define the properties of the new API key.
    * Provide a **Name** and optionally a **Description** for the key.
    * Choose the appropriate **Environment** — either **Preview** or **Production**.\
      ⚠️ Make sure to select the correct environment, as keys are **only valid for the chosen environment** and cannot be used interchangeably.
    * Click **Create API Key** to generate your new key.

    <img className="block dark:hidden" src="https://mintlify.s3.us-west-1.amazonaws.com/p36/images/imagevers1_1/previewkey.png" alt="Create API Key popup with environment selection" />

    <img className="hidden dark:block" src="https://mintlify.s3.us-west-1.amazonaws.com/p36/images/imagevers1_1/previewkey.png" alt="Create API Key popup with environment selection" />
  </Step>

  <Step title="Copy Your API Key">
    * After creation, your new API key will appear in a popup window.
    * **Copy the key immediately**, as it will not be shown again after closing this dialog.
    * You can create new keys or revoke existing ones at any time if needed.

    <Danger>**Important:** Store your API key securely. You will not be able to view it again after closing the popup.</Danger>

    <img className="block dark:hidden" src="https://mintlify.s3.us-west-1.amazonaws.com/p36/images/imagevers1_1/copypreviewkey.png" alt="API Key created popup" />

    <img className="hidden dark:block" src="https://mintlify.s3.us-west-1.amazonaws.com/p36/images/imagevers1_1/copypreviewkey.png" alt="API Key created popup" />
  </Step>

  <Step title="View and Manage API Keys">
    * Once created, your new API key will appear in the keys list.
    * The list shows key details such as name, environment, and creation date.
    * You can revoke (temporarily disable) or delete (permanently remove) a key from the Actions menu.

    <img className="block dark:hidden" src="https://mintlify.s3.us-west-1.amazonaws.com/p36/images/imagevers1_1/apikeyslist1.png" alt="API Keys list" />

    <img className="hidden dark:block" src="https://mintlify.s3.us-west-1.amazonaws.com/p36/images/imagevers1_1/apikeyslist1.png" alt="API Keys list" />
  </Step>

  <Step title="Create Keys for Production Environment">
    * You can also create API keys for the **Production** environment using the same process.
    * Select **Production** in the Environment dropdown before creating the key.

    <img className="block dark:hidden" src="https://mintlify.s3.us-west-1.amazonaws.com/p36/images/imagevers1_1/productionkey.png" alt="Create Production API Key popup" />

    <img className="hidden dark:block" src="https://mintlify.s3.us-west-1.amazonaws.com/p36/images/imagevers1_1/productionkey.png" alt="Create Production API Key popup" />
  </Step>

  <Step title="Manage Multiple Keys">
    * You can generate multiple API keys for different environments or use cases.
    * There is no limit to the number of keys that can be created.
    * All active keys will be visible in the list.

    <img className="block dark:hidden" src="https://mintlify.s3.us-west-1.amazonaws.com/p36/images/imagevers1_1/apikeyslist2.png" alt="Multiple API keys in list" />

    <img className="hidden dark:block" src="https://mintlify.s3.us-west-1.amazonaws.com/p36/images/imagevers1_1/apikeyslist2.png" alt="Multiple API keys in list" />
  </Step>

  <Step title="Revoke or Delete API Keys">
    * To manage existing API keys, open the **Actions** menu next to a key.
    * **Revoke** temporarily disables the key (it can be reactivated later).
    * **Delete** permanently removes the key from your organization.

    <img className="block dark:hidden" src="https://mintlify.s3.us-west-1.amazonaws.com/p36/images/imagevers1_1/revokedelete.png" alt="Revoke or delete API Key actions" />

    <img className="hidden dark:block" src="https://mintlify.s3.us-west-1.amazonaws.com/p36/images/imagevers1_1/revokedelete.png" alt="Revoke or delete API Key actions" />
  </Step>
</Steps>

<Card title="For security reasons, API keys are only shown once. Always store your keys securely and never share them publicly." icon="key" horizontal="true" />
