JavaScript / TypeScript SDK

Install

npm i @boundry/sdk

Quickstart

Set BOUNDRY_API_KEY, then send from a domain verified in this project. The display-name form is valid; an unverified sending domain returns 422.

import { Boundry } from "@boundry/sdk";

const boundry = new Boundry({
  apiKey: process.env.BOUNDRY_API_KEY,
  region: "au",
});

const { id } = await boundry.emails.send({
  from: "Acme <hello@acme.com>",
  to: ["ava@northwind.com.au"],
  subject: "Welcome to Acme",
  html: "<p>It works.</p>",
});

Client options

Resources and methods

These rows are derived from the public OpenAPI operations and link to the generated endpoint reference. options? accepts request controls such as signal and idempotencyKey.

Errors

Non-success responses throw BoundryError, with status, code, and requestId. Connection failures throw BoundryConnectionError; request deadlines throw BoundryTimeoutError.

import { Boundry, BoundryError } from "@boundry/sdk";

const boundry = new Boundry({ apiKey: process.env.BOUNDRY_API_KEY });

try {
  await boundry.emails.send({
    from: "Acme <hello@acme.com>",
    to: ["ava@northwind.com.au"],
    subject: "Welcome to Acme",
    html: "<p>It works.</p>",
  });
} catch (error) {
  if (error instanceof BoundryError) {
    console.error(error.status, error.code, error.requestId);
  }
}

Retries and idempotency

The SDK retries connection failures and 408, 429, and 5xx responses with exponential full jitter, up to maxRetries (2 by default), and honours Retry-After. It automatically creates an idempotency key for emails.send; pass { idempotencyKey: "..." } as the second argument when you need a stable key, including for another non-idempotent request.

Regions and runtimes

region: "au" resolves to https://api.au.boundry.dev. Set baseUrl explicitly only when you need to override region.

import { Boundry } from "@boundry/sdk";

const boundry = new Boundry({
  apiKey: process.env.BOUNDRY_API_KEY,
  baseUrl: "https://api.au.boundry.dev",
});

It supports Node 18+, Cloudflare Workers, Deno, Bun, and modern browsers with a Fetch implementation. Keep project API keys on a trusted server rather than exposing them in browser-delivered code.