API Dokumentasie

GPTMail API

Gebruik die GPTMail API om tydelike inkassies te genereer, boodskappe te lys en te lees, en e-pos oor HTTPS met 'n X-API-Key-opskrif uit te vee. Dit is geskik vir outomatiese toetse, CI/CD-pyplyne en QA-werkvloeie.

Hoe om 'n API Key te kry

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

Opsie 2: Voeg jou eie domein by

Nadat 'n openbare domein MX-verifikasie slaag: ingedien sonder aanmelding → API-sleutel (20000 versoeke); ingedien ná aanmelding → 200 punte. Elke domein ontvang net een beloning. Belangrik: sodra dit gekoppel is, word daardie domein se agtervoegsel 'n openbare agtervoegsel vir alle gebruikers, sodat ander ook posbusadresse daaronder kan skep. Na aktivering, moenie die MX-rekord wat die domein na ons diens wys, uitvee, vervang of wysig nie. Anders kan latere kontroles die domein as verkeerd gekonfigureer beskou. As 'n kontrole MX ongeldig vind, word die domein gedeaktiveer. Bly MX vir 3 opeenvolgende kontroles ongeldig, word die geassosieerde API Key ook gedeaktiveer. Word MX later weer geldig, word die domein outomaties heraktiveer.

Domeine

Openbare toetssleutel

Stuur vir toetsing die gedeelde openbare sleutel hieronder in die X-API-Key-opskrif. Dit verander elke dag en het 'n daaglikse limiet van 200 000 versoeke wat deur alle gebruikers gedeel word.

Oor vandag

Stel terug oor

Laai regstellende kwota vir die openbare sleutel...

Die API-verwysing hieronder kan as Markdown vir KI-instrumente, kennisdatabasisse of 'n README gekopieer word.

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

AI
llms.txt

·

llms-full.txt

(Markdown)

Vinnige begin

  • X-API-Key: YOUR_KEY is die eenvoudigste opsie. Gebruik vir vinnige toetse die daaglikse openbare sleutel hierbo in die plek van YOUR_KEY.

  • Die meeste posbus-eindpunte vereis 'n email-parameter, byvoorbeeld ?email=demo@example.com.

  • GPTMail API-antwoorde gebruik JSON met die velde success, data en error, plus usage wanneer 'n API-sleutel gebruik word. Cloudflare-foute, insluitend antwoorde oor tempolimiete, kan eerder HTML teruggee. Kontroleer die HTTP-status en Content-Type voordat jy JSON ontleed.

  • As jy reeds 'n ondersteunde domein op hierdie werf ken, hoef jy nie eers die e-posgenerasie-eindpunt te roep nie. Jy kan prefix@domain plaaslik samestel en die posbus-API's direk roep, wat een API-versoek spaar.

Tempolimiete en herhaalde pogings

  • GET en POST /api/generate-email deel 'n limiet van 30 versoeke per 10 sekondes per bron-IP. Dit geld vir publieke sowel as persoonlike API-sleutels. Verskillende sleutels en kliënte agter dieselfde IP deel hierdie limiet.

  • As hierdie limiet oorskry word, word HTTP 429 teruggestuur en word die skep van e-posadresse vir 10 sekondes geblokkeer. Wag die Retry-After-tydperk uit voordat jy weer probeer. As hierdie kopskrif ontbreek, wag ten minste 10 sekondes en probeer dan weer met toenemende wagtye. Vermy gelyktydige herhaalde pogings van kliënte wat 'n IP deel.

  • Hierdie reël geld nie vir die lys van die inkassie of die lees van individuele e-posse nie. Daaglikse en totale kwotas van API-sleutels geld steeds onafhanklik. Om 10 sekondes te wag, herstel nie 'n uitgeputte sleutelkwota nie.

Kern eindpunte

POST / GET
/api/generate-email

Skep 'n tydelike posbus. Gebruik GET vir die eenvoudigste lukrake vloei, of POST met prefix en domain wanneer jy eksplisiete beheer wil hê.

GET
/api/emails?email=...

Haal e-pos vir die posbus op.

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

Haal een e-pos op, insluitend teks, HTML, rou opskrifte en metadata.

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

Skrap een e-pos volgens ID.

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

Skrap alle e-pos in die posbus.

GET
/api/stats

Lees werfwyde statistieke.

Voorbeeldvloei

Hieronder is twee algemene patrone: laat die diens 'n posbus skep, of vra 'n vaste voorvoegsel. As jy reeds 'n ondersteunde domein ken, kan jy die posbus plaaslik samestel en direk navraag doen.

1) Genereer 'n lukrake tydelike e-posadres

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Voorbeeldantwoord
{
  "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) Genereer met 'n vaste voorvoegsel (bv. 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"}'
Voorbeeldantwoord
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Lys e-posse in 'n posbus

As jy reeds 'n ondersteunde domein ken, sla stap 1 oor en doen direk navraag.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Voorbeeldantwoord
{
  "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) Lees 'n enkele e-pos — sluit plat teks, HTML-lyf en metadata in

Vervang EMAIL_ID met 'n id wat in stap 3 teruggegee is. Gee ook die inkassie-adres as email deur (ook wanneer jy uitvee of aanhegsels aflaai): die e-pos word dan direk uit sy inkassie gelees in plaas daarvan om volgens ID gesoek te word. Met 'n API-sleutel is die email-parameter opsioneel, maar as jy dit stuur, word die opsoek vinniger.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Voorbeeldantwoord
{
  "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) Skrap 'n enkele e-pos volgens ID

Met 'n API-sleutel is die email-parameter opsioneel, maar as jy dit stuur, word die opsoek vinniger.

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

6) Maak 'n hele posbus skoon — verwyder alle e-pos vir hierdie adres

Elke oproep verwyder een bondel. Solank die antwoord "has_more": true bevat, roep dit weer aan totdat dit false teruggee.

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

Antwoordvorm

Suksesvolle antwoorde lyk gewoonlik so. As jy met 'n API Key magtig, let op die kwotainligting binne 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
  }
}

Uitgebreide statistieke

  • /api/statistics/24h gee een 24-uur-venster met uurlikse verspreiding terug; gebruik offset=1,2,... vir ouer vensters.
  • /api/statistics/top-subjects gee die mees algemene e-posonderwerpe terug.
  • /api/statistics/top-domains gee die mees aktiewe domeine terug.
  • /api/statistics/top-senders gee die mees aktiewe afsenders terug.
GPTMail