Getting Started

DevelEmail is a hosted transactional email platform. This guide gets you from zero to a sent email in three steps using the official SDK.

1. Install the SDK

npm install @develemail/sdk

2. Create a client

Every request needs an API key. Create one with devel init (see the CLI Reference) or from your project's page in the dashboard, then point the client at your API's base URL.

import { DevelEmail } from '@develemail/sdk';

const client = new DevelEmail({
  apiKey: process.env.DEVELEMAIL_API_KEY!,
  baseUrl: process.env.DEVELEMAIL_BASE_URL ?? 'https://develemail.com/api',
});

3. Send an email

const email = await client.emails.send({
  from: '[email protected]',
  to: '[email protected]',
  subject: 'Welcome!',
  html: '<p>Thanks for signing up.</p>',
});

console.log(email.id, email.status);

Sends are idempotent by default — the SDK generates an Idempotency-Key per call, so retrying a failed request never double-sends. Pass your own key via the second argument if you want to control retries explicitly:

await client.emails.send(input, { idempotencyKey: 'order-42-confirmation' });

Next steps

• SDK Reference — every resource and method the client exposes
• CLI Reference — send test emails and manage projects from the terminal
• API Overview — auth, base URL, and error format if you're calling the API directly