Table of Contents
How to Create an API Key #
Follow this step-by-step guide to create your VoxPria API key in under 2 minutes.
Step 1: Access API Keys Page #
- Log in to app.voxpria.com
- Click Settings in sidebar
- Select API Keys
📍 Location: Settings → API Keys
Step 2: Create New Key #
- Click “Create New API Key” button (top-right)
- Dialog box appears
Step 3: Configure Your Key #
Key Name #
Give it a descriptive name:
Good examples:
- “Production Server – Main App”
- “Development Environment”
- “WordPress Integration”
- “CRM Connector – Salesforce”
- “Marketing Automation”
Permission Scopes #
| Scope | Allows | Use Case |
|---|---|---|
calls:read |
View calls | Dashboards |
calls:write |
Trigger calls | CRM integration |
campaigns:read |
View campaigns | Analytics |
campaigns:write |
Manage campaigns | Automation |
contacts:read |
View contacts | Contact sync |
contacts:write |
Manage contacts | Imports |
webhooks:manage |
Manage webhooks | Event-driven |
⚠️ Security Tip: Only grant permissions actually needed (principle of least privilege).
Step 4: Generate Key #
- Review configuration
- Click “Create API Key”
- Key is displayed
Step 5: Copy & Store Key #
🚨 CRITICAL: This is the ONLY time you’ll see the complete key. Copy it NOW!
- Click “Copy” button
- Store in secure location:
- Password manager (1Password, LastPass, Bitwarden)
- Secure notes app
- Environment variable file
- Click “Done”
Step 6: Verify It Works #
curl -X GET "https://app.voxpria.com/api/v1/credits" \ -H "Authorization: Bearer YOUR_NEW_API_KEY" \ -H "Content-Type: application/json"
Managing Keys #
View Keys: #
Settings → API Keys shows all active keys
Revoke Key: #
- Find key in list
- Click “Revoke”
- Confirm action
- Key immediately deactivated
⚠️ Warning: Revoking cannot be undone. Applications using that key will stop working.
Best Practices #
- ✅ Separate keys per environment
- ✅ Descriptive names
- ✅ Minimal permissions
- ✅ Rotate every 90 days
- ✅ Revoke unused keys
- ❌ Never commit to Git
- ❌ Never share via email
- ❌ Never use production keys in dev
Troubleshooting #
Closed dialog before copying? #
Unfortunately, you must:
- Revoke the key you created
- Create a new one
- Copy it before closing!
Can’t see Create button? #
- Check account permissions
- Verify account in good standing
- Contact support if at key limit
Leave A Comment