5 minute setup

Quick Start

Get up and running with ArtaMail in under 5 minutes.

Prerequisites

  • Node.js 18 or later
  • An ArtaMail account with an API key
  • At least one email template created in the dashboard
1

Install the SDK

Choose the SDK that matches your framework:

Terminal
# Next.js
pnpm add @artamail/nextjs
# Nuxt 3
pnpm add @artamail/nuxt
# Node.js / Other
pnpm add @artamail/sdk
2

Configure your API key

Add your API key to your environment variables:

.env.local
ARTAMAIL_API_KEY=am_live_sk_your_api_key_here

You can find your API key in the Dashboard Settings.

Test vs Live Keys
Use am_test_sk_* keys during development. Test mode simulates sending without actually delivering emails or writing to the database.
3

Send your first email

Choose your framework and send a test email:

app/api/send/route.ts
1import { sendEmail } from '@artamail/nextjs/server';
2import { NextResponse } from 'next/server';
3
4export async function POST(request: Request) {
5  const { email, name } = await request.json();
6
7  const result = await sendEmail({
8    to: email,
9    template: 'welcome',
10    data: { name }
11  });
12
13  return NextResponse.json({ id: result.id });
14}
4

Verify the email was sent

Check the Transactional Emails page in your dashboard to see the email status.

Success!
Your email should appear in the dashboard within seconds. The status will update as it moves through queued → sent → delivered.

Next Steps

Next.js SDK documentation
Deep dive into the Next.js integration
→
Creating email templates
Learn how to create and manage templates
→
API Reference
Complete API documentation
→