API

Run a deliverability test from your own systems.

Create a test, send a message to the address you get back, and read the score — from CI, a deploy step, or anything that can make an HTTP request. The API is small on purpose: these pages describe all of it.

1. 01 Overview What the API does, where it lives, and why it is deliberately small.
2. 02 Authentication API keys, scopes, rotation, and the two endpoints that need no key at all.
3. 03 Quickstart The whole loop — create a test, send a message, read the score — as a script you can paste.
4. 04 Rate limits and errors The error shape, the status codes we return, and how to back off correctly.
5. 05 Endpoint reference All six endpoints, with a real request and a real response for each.
6. 06 Webhooks Event types, payloads, signature verification, and retry behaviour.
7. 07 Changelog What changed in the API, and what we will not change without a new version.

Have a key already? Jump to the quickstart. Need one? Create an API key.