# API Key

{% tabs %}
{% tab title="General Key" %}

<figure><img src="https://1470748636-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDY50EL4OmcrPvtoecg4h%2Fuploads%2Fo8EVacbl1sIEiVtmyLbs%2FScreenshot%202026-03-25%20at%2019.53.47.png?alt=media&#x26;token=201d550a-0b74-4542-b4f8-0a828af59324" alt=""><figcaption></figcaption></figure>

The **API Key** feature allows you to define and manage your own API keys for external LLM providers or models. Once created (e.g., `MY_API`), the key can be linked to any LLM provider or model in your environment. When selected, the system automatically uses the defined API key for authentication eliminating the need to re-enter it each time.

***

## **View API Key List**

<figure><img src="https://1470748636-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDY50EL4OmcrPvtoecg4h%2Fuploads%2FnZll9HUw1Luc4xrK6noq%2FScreenshot%202026-03-25%20at%2019.54.12.png?alt=media&#x26;token=108075d2-b450-4770-a04f-fb94926f5ccb" alt=""><figcaption></figcaption></figure>

The table displays all available API Keys with the following fields:

1. Key Name\
   The name of the API Key.
2. Key Value\
   Displays the API Key value. **This key does not have an expiration date.**

***

## Add New API Key

<figure><img src="https://1470748636-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDY50EL4OmcrPvtoecg4h%2Fuploads%2FY4F3pEcVYpKuYePkGghW%2FScreenshot%202025-10-08%20at%2015.12.42.png?alt=media&#x26;token=bc733859-9f53-49bb-b237-6a77fe67f09a" alt=""><figcaption></figcaption></figure>

To create a new API key, click **New API Key**. Fill in the required fields below, then click **Save** to store the key or **Cancel** to discard the changes.

1. **API Key Name**\
   Enter a unique label for the API key (e.g., `MY_API`). This name is used to identify the key within the system.
2. **API Key Value**\
   Paste the actual API key string provided by your LLM provider.

***

## **Edit API Key Details**

To view or edit an existing API key, click the **Edit** icon in the **API Key List** page. After making changes, click **Save** to apply them or **Cancel** to discard.

<figure><img src="https://1470748636-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDY50EL4OmcrPvtoecg4h%2Fuploads%2FpiNI4z9LEe9jFt4wG597%2FScreenshot%202026-03-02%20at%2011.33.39.png?alt=media&#x26;token=0fe3559a-d363-45cf-928e-e4a0a36212a4" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
For security reasons, the API key value is partially masked and only the first 3 and last 3 characters are displayed.
{% endhint %}

***

## **Search API Key**

Use the **Search** field to quickly find a specific API key by typing its name.

<figure><img src="https://1470748636-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDY50EL4OmcrPvtoecg4h%2Fuploads%2FmvIXCq0IJPBx5b0kRSsA%2FScreenshot%202025-10-08%20at%2015.14.45.png?alt=media&#x26;token=ac6a17b5-8f28-428a-8da9-0a6dea0096df" alt=""><figcaption></figcaption></figure>

***

## **Delete API Key**

To delete an API key, click the **Trash** icon in the Action column. A confirmation pop-up will appear, click **Delete** to confirm or **Cancel** to abort the action.

<figure><img src="https://1470748636-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDY50EL4OmcrPvtoecg4h%2Fuploads%2Fl9ssvrY6C4uGBBSVJjuh%2FScreenshot%202025-10-08%20at%2015.16.10.png?alt=media&#x26;token=7b58a473-2532-4075-b27e-95daaa71e518" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Deleted API keys cannot be recovered and will no longer be usable.
{% endhint %}
{% endtab %}

{% tab title="Agent API Key" %}

<figure><img src="https://1470748636-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDY50EL4OmcrPvtoecg4h%2Fuploads%2FBd1G3wESAflV3YLkOx0y%2FScreenshot%202026-03-25%20at%2019.01.48.png?alt=media&#x26;token=8d1e07e8-0953-4863-8cbe-3cf09a70e628" alt=""><figcaption></figcaption></figure>

The **Agent API Key** feature allows users to generate and manage API Keys used for authenticating and integrating agents within the system. Users can monitor and manage API Keys to ensure secure and controlled access for agent operations.

***

## **View API Key List**

<figure><img src="https://1470748636-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDY50EL4OmcrPvtoecg4h%2Fuploads%2FkPeIOg1XAtINUStQ6Kvo%2FScreenshot%202026-03-25%20at%2019.36.37.png?alt=media&#x26;token=f6fdcc15-5a35-4bb0-8cb7-4f5650069044" alt=""><figcaption></figcaption></figure>

The table displays all available Agent API Keys with the following fields:

1. **Key Name**\
   The unique name assigned to the API Key
2. **Status**

   Displays the current status of the API Key:

   * **Active** → Key is valid and usable
   * **Expired** → Key is no longer valid after the expiration date
3. **Secret Key**\
   Stored securely by the system and displayed in masked format only.
4. **Created**\
   Displays the date when the API Key was created.
5. **Last Used**\
   Displays the most recent date the API Key was used.
6. **Created by**\
   Displays the user who created the API Key.
7. **Expired Date**\
   Displays the expiration date of the API Key. \\

{% hint style="warning" %}
Agent API Keys expire after 90 days for security reasons. Create a new key once inactive.
{% endhint %}

{% hint style="info" %}
For security reasons, the API key value is partially masked and only the first 4 and last 4 characters are displayed.
{% endhint %}

***

## Add New API Key

<figure><img src="https://1470748636-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDY50EL4OmcrPvtoecg4h%2Fuploads%2FKbZumnzGnBfou7W93Rw1%2FScreenshot%202026-03-25%20at%2019.15.28.png?alt=media&#x26;token=9ab514db-c250-49af-aed6-d1a415f2e300" alt=""><figcaption></figcaption></figure>

To create a new API key, click **Create API Key** and select **Agent API Key**. Fill in the required field below, then click **Save** to store the key or **Cancel** to discard the changes.

1. **API Key Name**\
   Enter a unique name for the API key (e.g., ABC-Key). This name is used to identify the key within the system.

A secret key will be generated automatically after saving.&#x20;

<figure><img src="https://1470748636-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDY50EL4OmcrPvtoecg4h%2Fuploads%2Fci9Gg8gNUiLBpUD8DlPT%2FGroup%202%20(1).png?alt=media&#x26;token=7dfb481c-bcca-444b-8c7e-ea5b42e495b5" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
The Secret Key is displayed only once and cannot be retrieved again after closing the popup. Make sure to **copy and store it securely.**
{% endhint %}

***

## Edit API Key Details

To edit an existing API key, click the **Edit** icon in the API Key list page.  After making changes, click **Save** to apply them or **Cancel** to discard.

<figure><img src="https://1470748636-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDY50EL4OmcrPvtoecg4h%2Fuploads%2FkLwv0lZFu3bstSlQA44Y%2FScreenshot%202026-03-25%20at%2019.24.26.png?alt=media&#x26;token=32818a83-7c88-4fc6-8a49-63c7e1e14728" alt=""><figcaption></figcaption></figure>

***

## **Search API Key**

Use the **Search** field to quickly find a specific API key by typing its name.

<figure><img src="https://1470748636-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDY50EL4OmcrPvtoecg4h%2Fuploads%2Fp8sqEShCbwY21eOBuzgY%2FScreenshot%202026-03-25%20at%2019.25.32.png?alt=media&#x26;token=7d92eb5e-2061-462b-8967-19f4ae94be65" alt=""><figcaption></figcaption></figure>

***

## **Delete API Key**

To delete an API key, click the **Trash** icon in the Action column. A confirmation pop-up will appear, click **Delete** to confirm or **Cancel** to abort the action.

<figure><img src="https://1470748636-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDY50EL4OmcrPvtoecg4h%2Fuploads%2F8IBwGA1Hjjd4oML5kqwA%2FScreenshot%202026-03-25%20at%2019.26.49.png?alt=media&#x26;token=21ec106f-7946-4538-80a2-da37b1aa2021" alt="" width="563"><figcaption></figcaption></figure>

{% hint style="info" %}
Deleted API keys cannot be recovered and will no longer be usable.
{% endhint %}
{% endtab %}
{% endtabs %}
