Skip to main content

​
Search an API key

You can use the search bar to easily find the API key you’re looking for

​
List of API Keys

In the Admin/Document section, you can view a comprehensive list of all API keys with the following details:
  • Prefix: A sequence of characters that identifies the type, origin, or scope of the API key.
  • Unique Name: The unique name associated with the API key.
  • Created: The date the API key was created.
  • Expires: The expiration date of the API key.
  • Has Expired: Indicates whether the API key is still active. (Red = - Key is still active; Green = Expired)
  • Revoked: Indicates if the API key has been disabled. (Red = Key is active; Green = Key has been revoked)
You can delete one or multiple API keys using the “Action” dropdown menu.

​
Viewing API Key Details

When you access the details of a specific API key, you will see the following information:
  • Roles: Choose from three roles that determine the permissions for the API key: Standard API Key, Admin API Key, Project API Key
  • Permitted Models: Specify whether the API key can access one or multiple models from the available list.
  • Permitted Skills: This feature is not yet active.
  • Opt-In: A privacy setting that determines whether API usage is tracked. If the opt-in checkbox is unchecked, no usage data will be recorded.
  • User: Each API key is linked to a specific user. You can reassign the API key to a different user if needed.
  • Prefix: A sequence of characters that identifies the type, origin, or scope of the API key (automatically generated during creation and not editable).
  • Name: A unique name for the API key, generated during creation and non-editable.
  • Revoked: Indicates if the API key has been revoked. Once revoked, it cannot be reactivated.
  • Expires: Indicates the expiration date of the API key. Once expired, the key is no longer usable.

​
Editing/revoking an API key

To edit or revoke an API key, click on its prefix in the list. You can modify its expiration date and time, name, role, permissions (including models and skills), and associated user.

​
Deleting an API Key

You can permanently delete an API key from its detail page. Note that this action is irreversible.

​
Creating a New API Key

To create a new API key, click the “Add API Key” button and fill in the following details:
  • Expire: Set the expiration date and time for the API key (optional; non-editable after creation).
  • Name: A user-defined name for the API key (50 characters max; need not be unique).
  • Roles: Select one of three roles impacting the API key’s permissions: Standard API Key (use stand alone), Admin API Key (admin access), Project API Key (Application/webservice)
  • Permitted Models: Specify whether the API key can call one or multiple models from the available list.
  • Permitted Skills: This feature is not yet active.
  • Opt-In: A privacy setting to determine whether the API key’s usage is tracked. If the opt-in checkbox is unchecked, no usage data will be recorded.
  • User: The API key must be associated with a user, and you can assign it to another user as needed.
To create a new API key, click on the “Add API Key” button at the top right corner or directly on “Add” next to “API Keys” in the left sidebar of the admin panel. After setting your desired parameters and clicking save, remember to save the displayed API key from the banner at the top of your screen; it will not be visible again.
Remember to save the displayed API key from the banner at the top of your screen after creation; it will not be visible again.