Charchy Senddocs

Quickstart

Send your first email in five minutes with a test key — curl, Node/TypeScript, Laravel, Python or Go.

You need a Charchy Send workspace. It is invite-only for now — request access.

Using an AI coding agent?

Copy a ready prompt for Next.js, Convex, Laravel, Express or Django from Build with AI. It covers everything on this page.

Get a test key

Your welcome screen has a test key ready (chy_test_…); make more under API keys. A test key goes through every check a live key does but never sends a real email, and it is free. Put it in your server's environment:

export CHARCHY_SEND_KEY="chy_test_…"

Keys belong on your server. The API sends no CORS headers, so a call from browser code fails — on purpose.

Send an email

Send to delivered@sim.charchy.krd, a magic address that always "delivers". With a test key, from can use any domain.

// npm install @charchy/send — or plain fetch: it is one JSON POST.
import { CharchySend } from "@charchy/send"

const send = new CharchySend() // reads CHARCHY_SEND_KEY when a request is made

const { data, error } = await send.emails.send(
  {
    from: "My App <hello@example.com>",
    to: "delivered@sim.charchy.krd",
    subject: "Hello from Charchy Send",
    html: "<p>It works.</p>",
  },
  { idempotencyKey: "quickstart/1" }
)

if (error) throw error // error.code, error.message, error.docs
console.log(data.id) // "em_…"

The response comes back at once:

{ "id": "em_8f2k1x9q4w7m3n5p6r0s2t4v", "status": "queued" }

Watch it arrive

In Emails in the dashboard, the email appears once accepted, turns sent, then delivered a second later. Or ask the API (reading needs a key with full permission, like the welcome-screen one):

const { data, error } = await send.emails.get("em_8f2k1x9q4w7m3n5p6r0s2t4v")
console.log(data?.status) // "delivered"

Try bounced@sim.charchy.krd too, to see what your code does with a bounce.

Add your domain

Real emails leave from your own domain. In Domains, add it and publish the three DNS records shown — or press Add with Cloudflare. See Domains & DNS.

Go live

Create a live key (chy_live_…; you accept the Charchy Send terms first) and change from to an address on your verified domain. Until your workspace is approved, a live key sends only to your own team's addresses, up to 50 a day, free — enough to see a real email in your inbox. Once approved and paid, it sends to anyone.

Next

On this page