API Dokumentation

GPTMail API

Mit der GPTMail-API erstellen Sie temporäre Postfächer, listen Nachrichten auf, lesen sie und löschen E-Mails – über HTTPS mit einem X-API-Key-Header. Sie eignet sich für automatisierte Tests, CI/CD-Pipelines und QA-Workflows.

So erhalten Sie einen API Key

Buy API requests

Purchase API requests with GPTMail points. Earn points through daily check-ins and public domains, or buy points with LDC at a 1:1 rate.

Buy with points / add requests

Option 2: Eigene Domain hinzufügen

Nach erfolgreicher MX-Prüfung einer öffentlichen Domain: ohne Anmeldung eingereicht → API-Schlüssel (20000 Anfragen); angemeldet eingereicht → 200 Punkte. Jede Domain erhält nur eine Belohnung. Wichtig: Nach der Verbindung wird diese Domain-Suffix für alle Nutzer dieser Website öffentlich; andere können darunter ebenfalls Postfachadressen erzeugen. Nach der Aktivierung löschen, ersetzen oder ändern Sie nicht den MX-Eintrag, der diese Domain auf unseren Dienst zeigt. Andernfalls können spätere Prüfungen die Domain als falsch konfiguriert werten. Erweist sich der MX-Eintrag bei einer späteren Prüfung als ungültig, wird die Domain deaktiviert. Bleibt der MX-Eintrag bei 3 aufeinanderfolgenden Prüfungen ungültig, wird auch der zugehörige API Key deaktiviert. Wird der MX-Eintrag später wieder gültig, wird die Domain automatisch reaktiviert.

Domains

Öffentlicher Testschlüssel

Senden Sie zum Testen den unten angezeigten gemeinsamen öffentlichen Schlüssel im Header X-API-Key. Er ändert sich täglich und hat ein Tageslimit von 200.000 Anfragen, das sich alle Nutzer teilen.

Heute verbleibend

Zurücksetzen in

Live-Kontingent des öffentlichen Schlüssels wird geladen…

Die untenstehende API-Referenz kann als Markdown für KI-Tools, Wissensdatenbanken oder eine README kopiert werden.

Basis-URL: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Schnellstart

  • X-API-Key: YOUR_KEY ist die einfachste Option. Für schnelle Tests verwenden Sie anstelle von YOUR_KEY den oben angezeigten täglichen öffentlichen Schlüssel.

  • Die meisten Postfach-Endpunkte erfordern einen Parameter email, z. B. ?email=demo@example.com.

  • GPTMail-API-Antworten verwenden JSON mit den Feldern success, data und error sowie usage, wenn ein API-Schlüssel verwendet wird. Cloudflare-Fehler, einschließlich Ratenlimit-Antworten, können stattdessen HTML zurückgeben. Prüfen Sie den HTTP-Status und den Content-Type, bevor Sie JSON parsen.

  • Kennen Sie bereits eine derzeit unterstützte Domain auf dieser Website, müssen Sie den E-Mail-Generierungs-Endpunkt nicht zuerst aufrufen. Setzen Sie prefix@domain lokal zusammen und rufen Sie die Postfach-APIs direkt auf — das spart eine API-Anfrage.

Ratenlimits und Wiederholungsversuche

  • GET und POST /api/generate-email teilen sich ein Limit von 30 Anfragen pro 10 Sekunden je Quell-IP. Dies gilt sowohl für öffentliche als auch für persönliche API-Schlüssel. Verschiedene Schlüssel und Clients hinter derselben IP teilen sich dieses Limit.

  • Wird dieses Limit überschritten, wird HTTP 429 zurückgegeben und die E-Mail-Erzeugung für 10 Sekunden blockiert. Warten Sie die in Retry-After angegebene Dauer ab, bevor Sie es erneut versuchen. Fehlt dieser Header, warten Sie mindestens 10 Sekunden und versuchen Sie es dann mit zunehmenden Abständen erneut. Vermeiden Sie gleichzeitige Wiederholungen von Clients, die sich eine IP teilen.

  • Diese Regel gilt nicht für das Auflisten des Posteingangs oder das Lesen einzelner E-Mails. Tages- und Gesamtkontingente von API-Schlüsseln gelten weiterhin unabhängig davon. Ein erschöpftes Schlüsselkontingent wird durch 10 Sekunden Warten nicht wiederhergestellt.

Kern-Endpunkte

POST / GET
/api/generate-email

Erzeugt ein temporäres Postfach. Nutzen Sie GET für den einfachsten Zufalls-Flow oder POST mit prefix und domain, wenn Sie explizit steuern möchten.

GET
/api/emails?email=...

Ruft E-Mails für ein Postfach ab.

GET
/api/email/{id}?email=...

Ruft eine einzelne E-Mail ab, inkl. Text, HTML, Roh-Header und Metadaten.

DELETE
/api/email/{id}?email=...

Löscht eine E-Mail anhand der ID.

DELETE
/api/emails/clear?email=...

Löscht alle E-Mails in einem Postfach.

GET
/api/stats

Liest siteweite Statistiken.

Beispielablauf

Zwei gängige Muster: Das Postfach vom Dienst erzeugen lassen oder einen festen Präfix anfordern. Kennen Sie bereits eine derzeit unterstützte Domain, können Sie das Postfach auch lokal zusammensetzen und direkt abfragen.

1) Zufällige temporäre E-Mail-Adresse erzeugen

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Antwortbeispiel
{
  "success": true,
  "data": {
    "email": "a3f9c2b1@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 1,
    "remaining_today": 199999,
    "total_limit": 200000,
    "total_usage": 1,
    "remaining_total": 199999
  }
}

2) Mit festem Präfix erzeugen (z. B. demo@example.com)

curl -X POST 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: PUBLIC_API_KEY' \
  -d '{"prefix":"demo"}'
Antwortbeispiel
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) E-Mails in einem Postfach auflisten

Kennen Sie bereits eine unterstützte Domain, überspringen Sie Schritt 1 und fragen Sie direkt ab.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Antwortbeispiel
{
  "success": true,
  "data": {
    "emails": [
      {
        "id": "e5a7f3...",
        "email_address": "demo@example.com",
        "from_address": "noreply@github.com",
        "subject": "Your code: 654321",
        "content": "Your verification code is 654321",
        "html_content": "...",
        "has_html": true,
        "timestamp": 1709654321,
        "created_at": "2024-03-05T12:18:41Z"
      }
    ],
    "count": 1
  }
}

4) Eine einzelne E-Mail lesen — Klartext, HTML-Body und Metadaten

Ersetzen Sie EMAIL_ID durch eine in Schritt 3 zurückgegebene ID. Übergeben Sie außerdem die Postfachadresse als email (auch beim Löschen und beim Herunterladen von Anhängen): Die E-Mail wird dann direkt aus ihrem Postfach gelesen, statt per ID gesucht zu werden. Mit einem API-Schlüssel ist der Parameter email optional, beschleunigt aber die Suche, wenn er mitgesendet wird.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Antwortbeispiel
{
  "success": true,
  "data": {
    "id": "e5a7f3...",
    "email_address": "demo@example.com",
    "from_address": "noreply@github.com",
    "subject": "Your code: 654321",
    "content": "Your verification code is 654321",
    "html_content": "<p>Your code is 654321</p>",
    "has_html": true,
    "timestamp": 1709654321,
    "raw_size": 2048,
    "created_at": "2024-03-05T12:18:41Z"
  }
}

5) Eine einzelne E-Mail per ID löschen

Mit einem API-Schlüssel ist der Parameter email optional, beschleunigt aber die Suche, wenn er mitgesendet wird.

curl -X DELETE 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Antwortbeispiel
{
  "success": true,
  "data": {
    "message": "Email deleted"
  }
}

6) Gesamtes Postfach leeren — löscht alle E-Mails für diese Adresse

Jeder Aufruf löscht einen Stapel. Solange die Antwort "has_more": true enthält, rufen Sie ihn erneut auf, bis false zurückgegeben wird.

curl -X DELETE 'https://mail.chatgpt.org.uk/api/emails/clear?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Antwortbeispiel
{
  "success": true,
  "data": {
    "message": "Deleted 3 emails",
    "count": 3,
    "has_more": false
  }
}

Antwortform

Erfolgreiche Antworten sehen typischerweise so aus. Bei Authentifizierung mit einem API Key beachten Sie die Kontingentinfos in usage.

{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 1,
    "remaining_today": 199999,
    "total_limit": 200000,
    "total_usage": 1,
    "remaining_total": 199999
  }
}

Erweiterte Statistiken

  • /api/statistics/24h liefert ein 24-Stunden-Fenster der stündlichen Verteilung; verwenden Sie offset=1,2,... für ältere Fenster.
  • /api/statistics/top-subjects liefert die häufigsten E-Mail-Betreffzeilen.
  • /api/statistics/top-domains liefert die aktivsten Domains.
  • /api/statistics/top-senders liefert die aktivsten Absender.
GPTMail