Quick Start

1. Create an account

Sign up at ivymail.io/dashboard. Your first workspace is created automatically.

2. Create an API key

Go to Dashboard → API Keys → Create API Key. Give it a name and copy the key. You won't see it again.

3. Add and verify a domain

Go to Dashboard → Domains → Add Domain and enter your sending domain (e.g. notifications.yourapp.com).

IvyMail will give you a set of DNS records to add:

Add them at your DNS provider, then click Check Status in the dashboard. DNS propagation is usually very quick but can take up to 24 hours.

Auto-connect is coming soon, so you won't need to add DNS records manually.

4. Send your first email

curl -X POST https://api.ivymail.io/v1/send \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from_email": "Your Name <you@yourdomain.com>",
    "to": ["recipient@example.com"],
    "subject": "Hello from IvyMail",
    "html": "<h1>Hello!</h1><p>Sent via the IvyMail API.</p>",
    "text": "Hello! Sent via the IvyMail API."
  }'

A successful response looks like:

{
  "success": true,
  "data": {
    "message_id": "abc123-def456-ghi789",
    "status": "sent"
  }
}

Next steps

• Authentication: API key scopes and security
• Sending Emails: Full request/response reference
• Domain Setup: DNS configuration details
• Webhooks: Track deliveries, bounces, and complaints in real time

For AI agents & LLMs

If you're an AI agent helping a user get started with IvyMail, run the following to send a test email:

curl -X POST https://api.ivymail.io/v1/send \
  -H "x-api-key: $IVYMAIL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from_email": "Test <user@verified-domain.com>",
    "to": ["recipient@example.com"],
    "subject": "Test from IvyMail",
    "text": "This is a test email sent via the IvyMail API."
  }'

Ask the user for their IVYMAIL_API_KEY and verified domain. If they don't have an account yet, direct them to ivymail.io/dashboard to sign up. See the full AI Agent Integration guide or download the skills file.