Async create-then-read flow.
POST creates a test and hands back a unique inbox address. Send your real email there from your existing infrastructure, then GET the result, so what gets scored is the message your platform really sends.
Create a spam test over REST, send your email to the address it returns, and read back a 0 to 100 score with every check behind it as JSON.
POST creates a test and hands back a unique inbox address. Send your real email there from your existing infrastructure, then GET the result, so what gets scored is the message your platform really sends.
Every completed test returns the score, the sender host, sender IP and message ID, and a results[] array covering 17 check types, from SPF, DKIM and DMARC to blocklists, SpamAssassin and broken links. One read covers the whole verdict.
/screenshots returns desktop, tablet and mobile renders of the test, and /heatmap returns AI focus and attention maps for desktop. Pass the same test id to POST /client-previews to render the email in 60+ real clients and devices.
GET /spam-check?page=N&per_page=15 returns the running and completed tests you created through the API, with id, status, score, timestamps and the hosted report_url. Show past results in your own dashboard without running the test again.
A 0 to 100 deliverability score, the per-check breakdown that drives it, and visual + AI extras for QA pipelines.
The score field is an integer from 0 to 100 that rolls every signal (authentication, content, blocklists, headers) into one number a CI step can branch on. Unspam reports read 90 to 100 as excellent, 70 to 89 as solid, 50 to 69 as at risk and 0 to 49 as high risk, and they count a failed SPF, DKIM or DMARC check as high risk whatever the number says, so branch on results[] too.
Pair with report_url if your humans need the full visual breakdown; both fields land in the same response.
The results[] array lists every check the engine ran: spf, dkim, dmarc, bimi, ip_blacklist, domain_blacklist, spamassassin, subject_line, html_best_practice, broken_links and more. Each entry has a stable id and the signals behind it, each with its own status.
No separate endpoint to pull check-by-check verdicts. One GET, the whole story.
GET /spam-check/{id}/screenshots returns image URLs for desktop, tablet and mobile renders of your email, with null for any device still in progress. Drop them into your CI artifacts or your sender dashboard with no further processing.
GET /spam-check/{id}/heatmap returns AI-generated focus and attention heatmaps for desktop, each with a url and a status, so you can see where readers will look before you ship the next send.
The spam-check API is asynchronous: you create a test, send your email to the inbox address we return, then read the verdict.
POST /ext/v2/spam-check with your bearer token. The 201 response hands back a test id and a unique inbox_address.
From your transactional pipeline, marketing platform, or a CI step. The message routes through our spam-check engine, which holds it for analysis.
GET /ext/v2/spam-check/{id} moves from pending_inbox_message through spam_check_running to completed, with the score, sender details and results[]. Poll on a back-off or wire it to a job worker, and stop on error or outdated as well.
/spam-check/{id}/screenshots for the three device renders, /spam-check/{id}/heatmap for AI focus and attention maps on desktop, and POST /client-previews with the same test id for the email in 60+ real clients (see the email preview API). Each draws on its own allowance: screenshots and the heatmap spend one unit the first time you request them, and a preview request spends one device preview for each device it renders. Requesting the heatmap before the screenshots also spends a screenshot unit, because the heatmap is drawn on the desktop screenshot.
6 endpoints, on the same token as the rest of the API. The OpenAPI document has every parameter and response code.
OpenAPI document/spam-check/spam-check/spam-check/{id}/spam-check/{id}/heatmap/spam-check/{id}/screenshots/statusIntegration, billing, rate limits, and what the spam-check endpoint returns.
POST /ext/v2/spam-check returns an inbox_address; your sending platform delivers the real email to that address; then GET /ext/v2/spam-check/{id} returns the verdict once status is completed. Back off with exponential delay or use a job worker, and stop on error or outdated as well.GET /ext/v2/status returns your email and your subscription: plan name, price, next payment date and the remaining limits (spam_checks, inbox_placements, screenshots, heatmaps, client_previews), plus the has_history, has_ai_assistant, has_api and has_mcp flags. Useful for showing usage in your own admin UI.Authorization: Bearer YOUR_API_TOKEN header.API access is included with the Custom plan, bought online from a $5 monthly minimum. Build it into your own product and resell it under your own brand.