An Abyssale API Key is essential for connecting your workspace to custom applications, scripts, or third-party platforms. These keys allow you to automate visual generation and manage your designs programmatically.
Key Features & Limitations
Multi-key Support: You can create up to 3 active API keys per workspace.
Custom Naming: Give each key a unique name (e.g., "Production" or "Zapier") to stay organized.
The Default Key: The first active key in your list serves as the default. This is the key automatically used in the "API Console" tab when you are testing designs within the Abyssale UI.
Permissions: You must be a Manager, Admin, or Workspace Owner to create or manage API keys.
Step-by-Step Guide
Access Workspace Settings
Log in to your Abyssale dashboard. On the left-hand sidebar, click on "Workspace settings" at the bottom.Open the API Key Tab
In the settings menu, under the "WORKSPACE" section, click on the "API key" tab.Create a New Key
If you have fewer than 3 keys, follow these steps to generate a new one:
Click the "Create new API key" button in the top right corner.
Name your key: Enter a recognizable name in the pop-up field so you know where this key is being used.
Click "Create". Your new key will appear in the list immediately.
Manage Your Keys
Once your keys are created, you can perform several actions by clicking the icons next to each entry in the list:
Copy (Key Icon): Click this to instantly copy the API key to your clipboard.
Reveal (Eye Icon): Click this to toggle the visibility of the key if you need to view it directly in the dashboard.
More Actions (Three Dots): Click this menu to access:
Rename: Change the name of your key for better organization.
Delete: Permanently remove the key.
What happens if I delete my Default Key?
If you delete the key currently labeled as the Default key:
Abyssale will automatically promote the next active key in your list to be the new default.
The API Console in your design editor will immediately update to use this new default key.
Warning: Deleting a key is permanent. Any external integration (like a script or a Zapier workflow) using that specific key will stop working immediately.
You are now equipped with your Abyssale API key, ready to unlock the full potential of automated visuals generation!