Getting Started
Introduction
What the Notideus API is, the API-key surface, and how this documentation is organized.
What is Notideus
Notideus is a developer-first API for transactional and marketing email: one HTTP API to send messages, sync contacts, and track delivery — built to land in the inbox, every time.
Public API vs dashboard
Notideus has two API surfaces with different audiences and authentication:
| Public API | Dashboard API | |
|---|---|---|
| Auth | API key — Authorization: Bearer nt_live_… | Session JWT (email + password or OAuth login) |
| Who it's for | Your servers, calling server-to-server | Humans — the web dashboard at notideus.io |
This documentation covers the public API only. Dashboard endpoints (templates, domains, API keys, broadcasts) are out of scope here — sign in at notideus.io to manage them.
Base URL
All API endpoints live under https://api.notideus.io/v1, for example POST https://api.notideus.io/v1/emails. The one exception is the unauthenticated health check:
curl https://api.notideus.io/healthz
Returns 200 OK:
{
"status": "ok"
}
What's covered
- Getting Started — the API surface, authentication, domains and DNS, and templates. You are here.
- Tutorials — language walkthroughs (Node.js, Python, PHP, Laravel) and deep dives on batches, idempotency, contact sync, and WhatsApp.
- API Reference — every public endpoint, field by field, with error codes and quotas.
- Resources — how email delivery works in practice: statuses, contact states, tracking and events.
Honest limitations. Notideus does not yet offer outbound webhooks — delivery events flow back via inbound SES/SNS only (see Tracking and events); there is no public email-status polling endpoint — statuses are dashboard-only (see Email lifecycle); and sends do not support cc, bcc, attachments, or scheduled delivery — see the send endpoint for what the request body accepts.