Quickstart

Send your first email in under a minute. Base URL for the examples below is http://localhost:8080 — swap in your RelayForge host.

1. Check the service is up

curl http://localhost:8080/health
# {"ok": true, "version": "0.1.0", "provider": "resend"}

2. Dry-run a score (nothing is sent)

curl -X POST http://localhost:8080/v1/scores \
  -H "Authorization: Bearer $RELAYFORGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"don+relayforge@lifeofmorr.com","to":"don+relayforge@lifeofmorr.com",
      "subject":"Welcome","text":"Hi."}'

3. Send for real

curl -X POST http://localhost:8080/v1/emails \
  -H "Authorization: Bearer $RELAYFORGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"don+relayforge@lifeofmorr.com","to":["don+relayforge@lifeofmorr.com"],
      "subject":"Welcome to Acme","html":"<h1>Hi</h1>","text":"Hi."}'
# {"id":"re_3Z9f8a1b2c","deliverability_score":87,
#  "score_breakdown":{...},"score_flags":[...],"provider":"resend","status":"sent"}
Full reference: every endpoint — method, path, auth, request and response shapes — is documented in OPENAPI.md in the product repo.

Pick a plan