Quickstart

1. Create an account

Sign up at app.sendbyte.africa/signup. You get a project and a sandbox API key immediately; the key is shown once, so copy it.

Lost it? Open the email log and click “Create a sandbox key”: a fresh key in one click.

2. Send your first email

Sandbox keys (sk_test_) simulate everything end to end with no real delivery and no domain setup.

import { SendByte } from '@sendbyte/node';

const sendbyte = new SendByte('sk_test_...');

const { id } = await sendbyte.emails.send({
  from: 'You <you@yourapp.ng>',
  to: 'anyone@example.ng',
  subject: 'My first SendByte email',
  html: '<p>It works.</p>',
});

from sendbyte import SendByte

sendbyte = SendByte("sk_test_...")

email = sendbyte.emails.send(
    from_="You <you@yourapp.ng>",
    to="anyone@example.ng",
    subject="My first SendByte email",
    html="<p>It works.</p>",
)

$sendbyte = new \SendByte\SendByte('sk_test_...');

$email = $sendbyte->sendEmail([
    'from' => 'You <you@yourapp.ng>',
    'to' => 'anyone@example.ng',
    'subject' => 'My first SendByte email',
    'html' => '<p>It works.</p>',
]);

curl -X POST https://api.sendbyte.africa/v1/emails \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "from": "You <you@yourapp.ng>",
    "to": "anyone@example.ng",
    "subject": "My first SendByte email",
    "html": "<p>It works.</p>"
  }'

The API answers 201 with the email’s id and status queued. Within a second the sandbox simulates the full lifecycle: email.sent, email.delivered, email.opened.

3. Watch it in the dashboard

Open the email log. Your email is there with its status and a full event timeline.

4. Go live

Verify your domain: add it, publish three DNS records, check verification
Create a live key (sk_live_) in the dashboard under API keys
Swap the key in your code. Done.