Autonomous Agent & Protect-VM Ready

NiTRO MAiL API Keys & Agent SDK

Mint scoped ntr_live_... keys for Protect-VM agents, CI/CD test runners, and headless signup/OTP automation across your custom .com domain pool.

Base URL:https://mail.nitromail.co/api/v1

Scoped API Keys

Pass via Authorization: Bearer ntr_live_... or X-API-Key: ntr_live_...

Scopes:

Agent & Automation Quickstart

# Inside any Protect-VM confined-bash session (pre-authenticated via :18560 — zero API key exposure)
nitromail status
nitromail domains

# 1. Mint a session-isolated disposable mailbox in one line
EMAIL=$(nitromail create --prefix signup --domain nitromail.co --address-only)
echo "Using burner: $EMAIL"

# 2. Trigger target signup / password-reset / magic-link flow, then await OTP or link in real time
OTP=$(nitromail wait "$EMAIL" --otp --timeout 45)
echo "Extracted OTP: $OTP"

# 3. Read full MIME body, links & save attachments into .tmp/mail/, or send DKIM-signed mail
nitromail read latest "$EMAIL" --save-attachments .tmp/mail
nitromail send --from "$EMAIL" --to verify@example.com --subject "Verification" --text "Confirmed"
nitromail delete "$EMAIL"

REST API v1 Reference

All :id inbox parameters accept either the inbox UUID or the full email address (e.g. agent@nitromail.co).

GET/api/v1/status

Verify API key, scopes & active domain pool

GET/api/v1/domains

List active .com domains available for mailboxes

POST/api/v1/inboxes

Create mailbox ({ prefix, localPart, domain, ttlMinutes })

GET/api/v1/inboxes

List active mailboxes (?domain= & ?label=)

DELETE/api/v1/inboxes/:idOrEmail

Delete mailbox & purge messages

GET/api/v1/inboxes/:idOrEmail/messages

List messages, OTPs, links & attachments

GET/api/v1/inboxes/:idOrEmail/wait

Serverless long-poll (?timeoutMs=25000&otpOnly=1)

GET/api/v1/messages/:id

Full MIME text/HTML, headers & attachment links

GET/api/v1/attachments/:id

Download raw attachment (?format=json for base64)

POST/api/v1/messages/send

Send DKIM-signed email ({ from, to, subject, text })

Recent Webhook Deliveries (0)

Pass webhookUrl when creating an inbox to stream HMAC-SHA256 signed JSON payloads on incoming mail.