API Dokumentatioun

GPTMail API

Benotzt d'GPTMail API, fir temporär Bréifkëschten unzeleeën, Noriichten opzelëschten an ze liesen an E-Mailen iwwer HTTPS mat engem X-API-Key-Header ze läschen. Si passt fir automatiséiert Tester, CI/CD-Pipelines a QA-Workflows.

Wéi kréien ech eng 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

Optioun 2: Setzt Är eege Domain derbäi

Nodeems eng ëffentlech Domain d'MX-Kontroll besteet: ouni Umeldung agereecht → API-Schlëssel (20000 Ufroen); ugemellt agereecht → 200 Punkten. All Domain kritt nëmmen eng Belounung. Wichteg: soubal verbonnen gëtt dës Domain-Suffix zu engem ëffentleche Suffix fir all Benotzer op dësem Site, sou dass och aner Benotzer Mailbox-Adressen drënner generéiere kënnen. No der Aktivéierung läscht, ersetzt oder ännert net de MX-Record deen dës Domain op eise Service weist. Soss kënnen spéider Kontrollen d'Domain als feelkonfiguréiert behandelen. Wann eng spéider Kontroll de MX-Record als ongülteg fënnt, gëtt d'Domain deaktivéiert. Wann de MX-Record fir 3 openeinanerfolleg Kontrollen ongülteg bleift, gëtt och déi zougehéierend API Key deaktivéiert. Wann de MX-Record méi spéit nees gülteg gëtt, gëtt d'Domain automatesch reaktivéiert.

Domainen

Ëffentlechen Testschlëssel

Fir Tester schéckt Dir de gedeelten ëffentleche Schlëssel, deen hei ënnendrënner ugewise gëtt, am Header X-API-Key. E wiesselt all Dag an huet eng deeglech Limitt vu 200.000 Ufroen, déi all d'Benotzer gemeinsam hunn.

Haut nach iwwreg

Reset an

Live-Quota fir de public Key gëtt gelueden...

D'API-Referenz hei ënnen kann als Markdown fir AI-Tools, Wëssensbasen oder e README kopéiert ginn.

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

AI
llms.txt

·

llms-full.txt

(Markdown)

Schnellstart

  • X-API-Key: YOUR_KEY ass déi einfachst Optioun. Fir séier Tester benotzt Dir den deegleche ëffentleche Schlëssel, deen uewe gewise gëtt, amplaz vu YOUR_KEY.

  • Déi meescht Mailbox-Endpoints brauchen en email-Parameter, zum Beispill ?email=demo@example.com.

  • GPTMail-API-Äntwerte benotze JSON mat de Felder success, data an error, plus usage wann en API-Schlëssel benotzt gëtt. Cloudflare-Feeler, dorënner Äntwerte bei enger Iwwerschreidung vun der Ufroelimitt, kënnen HTML zréckginn. Iwwerpréift den HTTP-Status a Content-Type, ier Dir JSON ausliest.

  • Wann Dir schonn eng momentan ënnerstëtzt Domain op dësem Site kennt, musst Dir den E-Mail-Generatiouns-Endpoint net éischter opfuerderen. Dir kënnt prefix@domain lokal zesummesetzen an direkt d'Mailbox-APIen opfuerderen, wat eng API request spuert.

Ufroelimitten an nei Versich

  • GET a POST /api/generate-email deelen eng Limitt vun 30 Ufroen pro 10 Sekonnen a pro Quell-IP. Dat gëllt fir ëffentlech a perséinlech API-Schlësselen. Verschidde Schlësselen a Clienten hannert där selwechter IP deelen dës Limitt.

  • Wann d'Limitt iwwerschratt gëtt, kënnt HTTP 429 zréck an d'Generéiere vun E-Mail-Adresse gëtt fir 10 Sekonne blockéiert. Waart déi an Retry-After uginn Zäit, ier Dir et nach eng Kéier probéiert. Wann dësen Header feelt, waart op d'mannst 10 Sekonnen a vergréissert duerno d'Ofstänn tëscht de Versich. Vermeit gläichzäiteg Widderhuelunge vu Clienten, déi eng IP deelen.

  • Dës Reegel gëllt net fir d'Oplëschte vu Messagen an der Inbox oder d'Liese vun eenzelen E-Mailen. Déi deeglech a gesamt Quote vum API-Schlëssel gëllen onofhängeg weider. Eng Waardezäit vun 10 Sekonne stellt eng opgebrauchte Schlësselquote net nees hier.

Haaptendpoints

POST / GET
/api/generate-email

Generéier e temporäre Mailbox. Benotzt GET fir de einfachste zoufällege Mailbox-Flow, oder POST mat prefix a domain wann Dir explizit Kontroll wëllt.

GET
/api/emails?email=...

E-Mailen fir eng Mailbox ofruffen.

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

Eng eenzel E-Mail ofruffen, inklusiv Text, HTML, Ro-Header a Metadaten.

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

Eng E-Mail no ID läschen.

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

All E-Mailen an enger Mailbox läschen.

GET
/api/stats

Site-breet Statistike liesen.

Beispill-Flow

Hei ënnen zwee heefeg Musteren: loosst de Service eng Mailbox fir Iech generéieren, oder ufrot e fixe Prefix. Wann Dir schonn e momentan ënnerstëtzt Domain kennt, kënnt Dir d'Mailbox och lokal zesummesetzen a direkt ofruffen.

1) Eng zoufälleg temporär E-Mail-Adress generéieren

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Beispill-Äntwert
{
  "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) Mat fixe Prefix generéieren (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"}'
Beispill-Äntwert
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) E-Mailen an enger Mailbox oplëschten

Wann Dir eng ënnerstëtzt Domain kennt, Schrëtt 1 iwwersprangen a direkt ofruffen.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Beispill-Äntwert
{
  "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) Eng eenzel E-Mail liesen — inklusiv Klartext, HTML-Body a Metadaten

Ersetzt EMAIL_ID duerch eng id aus dem Schrëtt 3. Gitt och d'Adress vun der Bréifkëscht als email mat (och beim Läschen an beim Eroflueden vun Unhäng): d'E-Mail gëtt dann direkt aus hirer Bréifkëscht gelies, amplaz no der ID gesicht ze ginn. Mat engem API-Schlëssel ass den Parameter email optional, mee wann en matgeschéckt gëtt, geet d'Sich méi séier.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Beispill-Äntwert
{
  "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) Eng E-Mail no ID läschen

Mat engem API-Schlëssel ass den Parameter email optional, mee wann en matgeschéckt gëtt, geet d'Sich méi séier.

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

6) Eng ganz Mailbox eidel maachen — läscht all E-Mailen fir dës Adress

All Opruff läscht e Stapel. Soulaang d'Äntwert "has_more": true enthält, rufft en nach eng Kéier op, bis false zréckkënnt.

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

Äntwert-Form

Erfollegräich Äntwerten gesinn normalerweis esou aus. Wann Dir Iech mat engem API Key authentifizéiert, op d'Quota-Informatiounen an usage oppassen.

{
  "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
  }
}

Erweidert Statistiken

  • /api/statistics/24h gëtt eng Zäitfënster vu 24 Stonne mat der Verdeelung pro Stonn zréck; benotzt offset=1,2,... fir méi al Zäitfënsteren.
  • /api/statistics/top-subjects gëtt déi heefegst E-Mail-Sujeten zréck.
  • /api/statistics/top-domains gëtt déi aktivst Domainen zréck.
  • /api/statistics/top-senders gëtt déi aktivst Ofsender zréck.
GPTMail