Documentation

SDKs, CLI & OpenAPI

Node, Go, Python, Ruby, PHP, .NET, Java, Rust and Elixir clients, a CLI, framework guides and the OpenAPI spec.

The machine-readable spec is served at /openapi.json (OpenAPI 3.1). Official clients are dependency-free and use the same durable acceptance path. The Node.js SDK, CLI, React Email helper and MCP server are live on npm; the Python client is live on PyPI; the Ruby gem is live on RubyGems; the PHP client is live on Packagist; the Rust crate is live on crates.io; and the Elixir package is live on Hex. The remaining clients install from their public repositories until their registries are configured.

LanguageInstall
Node.jsnpm i @transmitly/sdk
Gogo get github.com/Transmitly-io/[email protected]
Pythonpip install transmitly
Ruby / Railsgem install transmitly
PHP / Laravelcomposer require transmitly/sdk
.NETsdk/dotnet · Transmitly.Client
Javasdk/java · io.transmitly:transmitly
Rustcargo add transmitly
Elixir{:transmitly, "~> 1.0"}

Every client repository is public under github.com/Transmitly-io.

node
import { Transmitly } from "@transmitly/sdk";

const tx = new Transmitly({ apiKey: process.env.TRANSMITLY_KEY });

await tx.emails.send({
  from: "Notify <[email protected]>",
  to: ["[email protected]"],
  subject: "Your workspace is ready",
  html: "<p>Welcome.</p>",
  reply_to: "Support <[email protected]>",
  tags: { flow: "onboarding" },
});

// resources
await tx.messages.list({ status: "bounced" });
await tx.domains.list();
await tx.suppressions.add({ email: "[email protected]", reason: "manual" });
await tx.webhooks.create({ url: "https://api.acme.com/hooks", events: ["email.delivered_to_mx"] });
await tx.usage.get();

The Node SDK accepts a React Email element directly with react (install @react-email/render); the SDK renders HTML and plain text before the request. @transmitly/react-email exports renderReactEmail and sendReactEmail for other Node call sites.

Framework guides. Server-side examples for Next.js App Router, Remix, Nuxt, Express, Hono, Redwood, Bun and Astro are in examples/README.md. The Ruby README includes a Rails initializer and controller example; the PHP README includes a Laravel service-provider setup; the .NET README includes ASP.NET Core dependency injection and a minimal API endpoint.

CLI. @transmitly/cli wraps the same API for terminals and scripts. It supports send with attachments and scheduling, message and domain inspection, suppressions, webhooks, usage and health. Run it with npx @transmitly/cli.

cli
export TRANSMITLY_API_KEY=txk_…

npx @transmitly/cli emails send   --from "Notify <[email protected]>"   --to [email protected]   --subject "Welcome"   --html "<p>Your workspace is ready.</p>"

npx @transmitly/cli messages list --status bounced
npx @transmitly/cli domains verify dom_…
npx @transmitly/cli health

SMTP submission. Applications that already speak SMTP can use mail.transmitly.io on port 587 with STARTTLS or 465 with implicit TLS, authenticating with an API key. Submission is scoped to verified sender domains in the authenticated workspace and is never an open relay. It returns 250 only after the same durable message, delivery and outbox transaction used by the API. See SMTP submission for the full contract.

Domain, webhook and inbound management require an API key with the admin scope. Keep keys server-side. Webhook verification is built into every SDK and must use the raw request body:

verify webhook
if (!Transmitly.verifyWebhook(rawBody, signature, secret)) {
  return res.status(400).end();
}

Need the full API surface? OpenAPI 3.1.