API Keys

Generate and manage API keys to integrate Solo with external systems and build custom workflows.

What are API Keys?

API keys allow external systems to:

  • Access Solo API: Make API calls to Solo
  • Authenticate requests: Secure API access
  • Track usage: Monitor API usage
  • Control access: Revoke keys when needed

Generating API Keys

Create a New Key

  1. Go to Settings → API Keys
  2. Click "Generate New Key"
  3. Enter key name: Descriptive name (e.g., "Workflow Integration" or "n8n Integration")
  4. Set permissions: What the key can do (if applicable)
  5. Click "Generate"
  6. Copy key: Save the key immediately (shown only once)

Key Information

Each API key includes:

  • Key name: Your label for the key
  • Key value: The actual API key (Bearer token)
  • Created date: When key was created
  • Last used: Last time key was used
  • Usage count: Number of requests made

Using API Keys

Authentication

Use API keys in requests:

Authorization: Bearer <your-api-key>

API Endpoints

Use keys with Solo API endpoints:

  • Base URL: https://solomail.io/api/v1
  • Authentication: Bearer token in header
  • Rate limits: Based on your plan

Rate Limits

API key rate limits by plan:

  • Free Plan: 100 requests/day
  • Solopreneur Plan: 1,000 requests/day
  • Small Business Plan: 10,000 requests/day
  • Enterprise Plan: Unlimited

Managing API Keys

View Keys

See all your API keys:

  • List view: All keys in a list
  • Key details: Name, created date, usage
  • Status: Active or revoked
  • Usage: Request count and last used

Revoke Keys

Remove API keys:

  1. Go to Settings → API Keys
  2. Find key to revoke
  3. Click "Revoke" or "..." menu
  4. Confirm revocation
  5. Key immediately disabled

Important: Revoked keys cannot be recovered. Generate a new key if needed.

Key Permissions

Control what keys can do:

  • Read access: Can read data
  • Write access: Can create/update data
  • Admin access: Full access (use carefully)
  • Scoped access: Limited to specific resources

Security Best Practices

Protect Your Keys

  • Never share keys: Keep keys private
  • Don't commit to git: Never commit keys to version control
  • Use environment variables: Store keys securely
  • Rotate regularly: Generate new keys periodically

Key Management

  • Name descriptively: Use clear key names
  • One key per integration: Separate keys for different systems
  • Revoke unused keys: Remove keys you're not using
  • Monitor usage: Watch for unusual activity

Access Control

  • Limit permissions: Only grant necessary permissions
  • Review regularly: Check who has access
  • Revoke promptly: Remove access when no longer needed
  • Monitor activity: Watch for suspicious usage

API Key Usage

Common Use Cases

  • Custom workflows: Integration with workflow tools (such as n8n)
  • External apps: Integrate with your applications
  • Automation: Automated workflows
  • Monitoring: External monitoring systems

Example Usage

cURL:

curl -X GET https://solomail.io/api/v1/identity \
  -H "Authorization: Bearer <your-api-key>"

JavaScript:

fetch('https://solomail.io/api/v1/identity', {
  headers: {
    'Authorization': `Bearer ${apiKey}`
  }
})

Troubleshooting

Key not working?

  • Verify key is correct (no extra spaces)
  • Check key hasn't been revoked
  • Verify key has necessary permissions
  • Check rate limits haven't been exceeded

Rate limit exceeded?

  • Check your plan's rate limits
  • Review API usage
  • Wait for rate limit reset
  • Consider upgrading plan

Need more keys?

  • Generate additional keys as needed
  • Each key is independent
  • Monitor usage per key
  • Revoke unused keys

Next Steps

Version: 1.0
Last Updated: November 2025