Getting API Keys
API access is available on Scale and Enterprise plans.
1. Go to **Settings > API**
2. Click **"Generate API Key"**
3. Give the key a descriptive name
4. Copy and store the key securely
Keys are only shown once. Store them in your secrets management system.
Using API Keys
Include your API key in the Authorization header:
```
Authorization: Bearer vg_live_abc123...
```
Example request:
```bash
curl https://api.vectorgap.ai/v1/brands \
-H "Authorization: Bearer vg_live_abc123..."
```
All API requests require authentication.
Key Types
**Live keys** (vg_live_...)
For production use. Full access to your account.
**Test keys** (vg_test_...)
For development. Limited functionality, no billing impact.
Use test keys during development, live keys in production.
Key Management
Best practices:
- **Rotate regularly** - Generate new keys periodically
- **Use environment variables** - Never hardcode keys
- **Limit scope** - Use least privilege principle
- **Monitor usage** - Check API logs for anomalies
- **Revoke immediately** - If a key is compromised
You can have multiple active keys. Revoke any key instantly from Settings.
Security
API keys grant full access to your account. Protect them:
- Never commit keys to version control
- Use secrets management (Vault, AWS Secrets Manager, etc.)
- Restrict key access to authorized team members
- Set up IP allowlisting (Enterprise feature)
- Enable key expiration (Enterprise feature)