Getting Started

Send your first email in under 5 minutes.

1. Sign in as Admin

Navigate to the admin panel and sign in with your admin password.

http://localhost:8000/admin/login

2. Create a Product

A Product represents your application. Each product gets its own API key and configuration.

Create productbash

curl -X POST http://localhost:8000/admin/api/products \
  -H "X-Admin-Key: YOUR_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "My App"}'

3. Configure an Email Provider

Configure SMTP or another provider to enable email sending.

Configure SMTP providerbash

curl -X PUT http://localhost:8000/admin/api/products/1/email-config \
  -H "X-Admin-Key: YOUR_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "provider_type": "smtp",
    "email_user": "your@email.com",
    "email_pass": "your-app-password",
    "smtp_server": "smtp.gmail.com",
    "smtp_port": 587
  }'

Visual configuration

Use the admin dashboard at /admin to configure providers visually instead of using the API.

4. Send Your First Email

Use the API key from step 2 to send an email:

Send emailbash

curl -X POST http://localhost:8000/api/v1/email/send \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to_emails": "user@example.com",
    "subject": "Hello from the Platform",
    "message_body": "<h1>Welcome!</h1><p>This is your first email.</p>",
    "is_html": true
  }'

5. Check the Logs

Get logsbash

curl -X GET http://localhost:8000/api/v1/email/logs \
  -H "X-API-Key: YOUR_API_KEY"

Done!

You have sent your first email through the platform. Check the logs to see its delivery status.