send0 documentation

Before you startCopy Anchor Link

You need a send0 API key. During the private beta, keys are issued to people on the waitlist. Keys look like s0_live_… (sends real mail) or s0_test_… (goes through every check but never sends). See API keys for scopes and per-inbox keys.

InstallCopy Anchor Link

npm install @send0/sdk

The whole idea in ten linesCopy Anchor Link

import { Send0 } from "@send0/sdk";

const send0 = new Send0(process.env.SEND0_API_KEY);
const inbox = await send0.inboxes.create({ name: "signup-agent" }); // signup-agent@send0.email

await browser.fill("#email", inbox.address);
await browser.click("Create account");

const msg = await send0.inboxes.wait(inbox.id, { from: "*@github.com", timeout: 60 });
console.log(msg?.extracted?.otp); // "482913"

Pick a quickstartCopy Anchor Link

Know when it worksCopy Anchor Link

• inboxes.create() returns an address like signup-agent@send0.email.
• Email that address from your own mailbox. GET /v1/inboxes/{id}/messages lists it within a few seconds.
• wait() returns the message with extracted.otp and extracted.action_link filled in when the email contains a code or a verification link.
• Your reply shows up in the same conversation in Gmail or Outlook.

If a request fails, the error has a stable code (for example recipient_not_allowed) and a request_id. See Errors & limits.