API Keys
Overview
The API Keys page allows you to manage the keys required for integrating VoiceCreator.ai services with your custom applications or workflows. API keys are essential for authenticating and authorising API requests securely.
Creating an API Key
To create a new API key:
- Navigate to the API Keys section in your dashboard.
- Click the Add API Key button.
- Enter a descriptive name for your API key in the provided field.
Example: "Customer Integration Key" - Click the Generate API Key button to create the key.
Once generated, the API key will be displayed. Make sure to copy it immediately as it will not be shown again for security reasons.
Managing API Keys
Viewing API Keys
The API Keys section displays all the keys associated with your organisation. For each key, you can see:
- Name: The descriptive name given during creation.
- Created Date: The date the key was generated.
- Status: Indicates if the key is active or inactive.
Actions
- Deactivate: Temporarily disable the API key.
- Delete: Permanently remove the API key.
- Regenerate: Create a new key to replace an existing one. Ensure all systems using the old key are updated with the new key.
Security Notes
- API keys provide access to your VoiceCreator.ai account, so handle them with care.
- Never share your API keys publicly or in insecure environments.
- Use descriptive names for your keys to keep track of their usage.
- Regularly review and deactivate unused keys to enhance security.
Permissions
Only users with Organisation Admin roles can create, view, or manage API keys.
Updated 2 months ago