API Authentication

​

Overview

​

Generating an API Key

​

Via Dashboard

1. Log in to your ByteSend Dashboard
2. Navigate to Settings → General
3. Scroll to the API Keys section
4. Click Generate New API Key
5. Give your key a name (e.g., “Development”, “Production”)
6. Click Create
7. Copy the key immediately — you won’t be able to see it again
8. Store it securely (use environment variables, not in version control)

​

Using Your API Key

​

In API Requests

curl -X GET https://bytesend.cloud/api/v1/domains \
  -H "Authorization: Bearer your_api_key_here"

​

In SDK Clients

​

JavaScript/TypeScript

import { ByteSend } from "bytesend-js";

const bytesend = new ByteSend(process.env.BYTESEND_API_KEY!);

// Now use the client
const emails = await bytesend.emails.list();

​

Python

from bytesend import ByteSend

bytesend = ByteSend(api_key=os.getenv("BYTESEND_API_KEY"))

# Now use the client
emails = bytesend.emails.list()

​

API Key Management

​

Viewing Your Keys

1. Go to Settings → General
2. All active API keys are listed with:
   • Key name
   • Creation date
   • Last used date
   • Masked key preview

​

Rotating Keys

1. Generate a new API key in the dashboard
2. Update all applications to use the new key
3. Test that everything works correctly
4. Delete the old key from the dashboard

​

Revoking Keys

1. Navigate to Settings → General
2. Find the key you want to revoke
3. Click Revoke
4. Confirm the action
5. The key will be immediately invalidated

​

Security Best Practices

​

Protect Your Keys

• Never commit API keys to version control
• Use environment variables to store sensitive keys
• Use different keys for different environments (development, staging, production)
• Rotate keys regularly (every 90 days recommended)
• Revoke keys immediately if compromised

​

Environment Variables

BYTESEND_API_KEY=sk_live_your_key_here

import dotenv from 'dotenv';
dotenv.config();

const apiKey = process.env.BYTESEND_API_KEY;

​

Monitoring Usage

• Check the “Last used” timestamp to identify unused keys
• Monitor your API usage through the dashboard analytics
• Set up alerts for unusual activity

​

Troubleshooting

​

”Unauthorized” Error

• Verify the API key is correct and not expired
• Check that the key is included in the Authorization header
• Ensure the header format is Bearer {key} (with a space)
• Verify the key hasn’t been revoked

​

Key Not Working After Generation

• Make sure you copied the entire key
• Check that there are no extra spaces or characters
• Try revoking and generating a new key

​

Lost or Forgotten Key

1. You cannot recover the old key
2. Generate a new API key from the dashboard
3. Update all applications to use the new key
4. Revoke the old key (if known)

​

Rate Limiting

• Free Plan: 100 requests/minute
• BASIC Plan: 1,000 requests/minute
• LIFETIME Plan: 10,000 requests/minute

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1234567890

​

Next Steps

• Send your first email
• Explore the full API reference
• View SDK documentation