Skip to main content

​
1. Access the Management Interface

To access your API keys:
  • Log in to your Paradigm instance.
  • Click your profile icon located at the bottom-left of the screen.
  • In the menu that opens, select “API Keys”.

​
2. API Keys Dashboard

Once on the page, you will see the list of your existing keys. For each key, you can view:
  • The key ID / name
  • The status (Active / Revoked)
  • The expiration date (if applicable)
This is where you can quickly monitor the validity of your access at a glance.

​
3. Create a New API Key

The creation process is designed to be immediate:
  • Click the “Add API Key” (or “Create”) button.
  • The key is generated instantly and displayed on the screen.
⚠️ Important: Save your key immediately!
For security reasons, the full key is shown only once at this step.
  • Copy it and paste it right away into your password manager or a secure configuration file.
  • If you close this window without copying it, you will never be able to retrieve it again. You will need to delete it and create a new one.

​
4. Limits (Quota)

Each user is limited to a maximum of 5 active API keys at the same time.
  • If you have reached this quota (5/5), the creation button will be disabled.
Solution: You must delete an old key in order to generate a new one. Specific need? If you absolutely need more than 5 keys, please contact an administrator so they can generate one manually via the admin panel.

​
5. Delete (Revoke) a Key

If a key has been compromised or is no longer used, you should delete it to secure your account:
  • Identify the key in your list.
  • Click the trash icon (or the “Delete” button) on the corresponding row.
  • Confirm deletion. The key will stop working immediately.