Skip to main content
1

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.
API Keys overview
2

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.
Create API Key popup with environment selection
3

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.
Important: Store your API key securely. You will not be able to view it again after closing the popup.
API Key created popup
4

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.
API Keys list
5

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.
Create Production API Key popup
6

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.
Multiple API keys in list
7

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.
Revoke or delete API Key actions

For security reasons, API keys are only shown once. Always store your keys securely and never share them publicly.