Creating an API Key
1
Navigate to Settings > API
From your workspace, click on Settings in the sidebar, then select API.
2
Click Create API Key
Click the Create API Key button to open the creation dialog.
3
Enter a descriptive name
Give your key a name that identifies its purpose, like “Production Integration” or “Analytics Dashboard”.
4
Copy your key immediately
Your API key will be displayed only once. Copy it and store it securely before closing the dialog.
Using Your API Key
Include your API key in theAuthorization header of every request:
Example Request
Key Format
API keys follow this format:- Prefix:
exec_live_ - Body: 40 alphanumeric characters
- Example:
exec_live_aB3dE5fG7hI9jK1lM3nO5pQ7rS9tU1vW3xY5zA7b
Managing Keys
Viewing Keys
In Settings > API, you’ll see a table of all your API keys showing:- Key name
- Last 4 characters (for identification)
- Status (Active/Inactive)
- Creation date
- Last used timestamp
Deactivating a Key
If a key is compromised or no longer needed:- Click the … menu on the key row
- Select Deactivate
Deleting a Key
To permanently remove a key:- Click the … menu on the key row
- Select Delete
Security Best Practices
Never commit keys to code
Use environment variables or secrets management
Use descriptive names
Name keys by purpose so you know what to revoke
Rotate keys periodically
Create new keys and deactivate old ones regularly
Limit access
Only share keys with systems that need them
Error Responses
| Status | Error | Cause |
|---|---|---|
401 | Missing Authorization header | No Authorization header provided |
401 | Invalid or inactive API key | Key is wrong, deactivated, or deleted |
403 | Workspace is inactive | Your workspace has been disabled |