Dokumentácia API

GPTMail API

Pomocou GPTMail API môžete cez HTTPS s hlavičkou X-API-Key vytvárať dočasné schránky, zobrazovať a čítať správy a mazať poštu. Hodí sa na automatizované testy, CI/CD pipeline a QA procesy.

Ako získať 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

Možnosť 2: Pridajte vlastnú doménu

Po úspešnom overení MX verejnej domény: odoslané bez prihlásenia → kľúč API (20000 požiadaviek); odoslané po prihlásení → 200 bodov. Každá doména dostane iba jednu odmenu. Dôležité: po pripojení sa táto doménová prípona stane verejnou a dostupnou všetkým používateľom, takže aj iní môžu generovať adresy schránok pod ňou. Po aktivácii neodstraňujte, nenahrádzajte ani nemeňte MX záznam smerujúci doménu na našu službu. Inak môžu ďalšie kontroly považovať doménu za nesprávne nakonfigurovanú. Ak kontrola zistí neplatný MX záznam, doména bude deaktivovaná. Ak MX záznam zostane neplatný pri 3 po sebe idúcich kontrolách, príslušný API Key bude tiež deaktivovaný. Ak MX záznam neskôr opäť bude platný, doména sa automaticky znova aktivuje.

Domény

Verejný testovací kľúč

Na testovanie posielajte zdieľaný verejný kľúč zobrazený nižšie v hlavičke X-API-Key. Mení sa každý deň a má denný limit 200 000 požiadaviek, ktorý zdieľajú všetci používatelia.

Zostáva dnes

Reset o

Načítava sa aktuálna kvóta pre verejný kľúč...

Referenciu API nižšie môžete skopírovať ako Markdown pre AI nástroje, knowledge base alebo README.

Základná adresa URL: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Rýchly štart

  • X-API-Key: YOUR_KEY je najjednoduchšia možnosť. Na rýchle testy použite namiesto YOUR_KEY denný verejný kľúč zobrazený vyššie.

  • Väčšina endpointov schránky vyžaduje parameter email, napríklad ?email=demo@example.com.

  • Odpovede GPTMail API používajú JSON s poľami success, data a error, a pri použití API kľúča aj usage. Chyby Cloudflare vrátane odpovedí pri prekročení limitu frekvencie môžu namiesto toho vrátiť HTML. Pred spracovaním JSON skontrolujte stav HTTP a Content-Type.

  • Ak už poznáte podporovanú doménu na tejto stránke, nemusíte najprv volať endpoint generovania email. Môžete lokálne zostaviť prefix@domain a priamo volať API schránky, čím ušetríte jeden API request.

Limity frekvencie požiadaviek a opakovanie

  • GET a POST /api/generate-email zdieľajú limit 30 požiadaviek za 10 sekúnd na zdrojovú IP adresu. Platí to pre verejné aj osobné API kľúče. Rôzne kľúče a klienti za rovnakou IP adresou tento limit zdieľajú.

  • Pri prekročení tohto limitu sa vráti HTTP 429 a generovanie e-mailov sa na 10 sekúnd zablokuje. Pred ďalším pokusom počkajte čas uvedený v Retry-After. Ak táto hlavička chýba, počkajte aspoň 10 sekúnd a potom to skúšajte znova s postupne sa predlžujúcimi intervalmi. Vyhnite sa súčasným opakovaným pokusom klientov, ktorí zdieľajú IP adresu.

  • Toto pravidlo sa nevzťahuje na zobrazenie zoznamu schránky ani na čítanie jednotlivých e-mailov. Denné a celkové kvóty API kľúčov naďalej platia samostatne. Čakanie 10 sekúnd neobnoví vyčerpanú kvótu kľúča.

Hlavné endpointy

POST / GET
/api/generate-email

Vygenerujte dočasnú schránku. Použite GET pre najjednoduchší náhodný tok alebo POST s prefix a domain, keď chcete presnú kontrolu.

GET
/api/emails?email=...

Načítať emaily pre schránku.

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

Načítať jeden email vrátane textu, HTML, surových hlavičiek a metadát.

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

Zmazať jeden email podľa ID.

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

Zmazať všetky emaily v schránke.

GET
/api/stats

Čítať štatistiky celej stránky.

Príklad postupu

Nižšie sú dva bežné spôsoby: nechať službu vygenerovať schránku alebo požiadať o pevný prefix. Ak už poznáte podporovanú doménu, môžete adresu zostaviť lokálne a dotazovať ju priamo.

1) Vygenerovať náhodnú dočasnú emailovú adresu

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Príklad odpovede
{
  "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) Vygenerovať s pevným prefixom (napr. 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"}'
Príklad odpovede
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Zoznam emailov v schránke

Ak už poznáte podporovanú doménu, preskočte krok 1 a dotazujte priamo.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Príklad odpovede
{
  "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) Prečítať jeden email — obsahuje plain text, HTML telo a metadáta

Nahraďte EMAIL_ID identifikátorom vráteným v kroku 3. Odovzdajte aj adresu schránky ako email (aj pri mazaní a sťahovaní príloh): e-mail sa potom načíta priamo z jeho schránky namiesto vyhľadávania podľa ID. S API kľúčom je parameter email voliteľný, ale jeho odoslanie zrýchli vyhľadávanie.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Príklad odpovede
{
  "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) Zmazať jeden email podľa ID

S API kľúčom je parameter email voliteľný, ale jeho odoslanie zrýchli vyhľadávanie.

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

6) Vyčistiť celú schránku — zmaže všetky emaily pre túto adresu

Každé volanie odstráni jednu dávku. Kým odpoveď obsahuje "has_more": true, volajte znova, kým nevráti false.

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

Tvar odpovede

Úspešné odpovede zvyčajne vyzerajú takto. Ak sa autentifikujete pomocou API Key, venujte pozornosť informáciám o kvóte v 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
  }
}

Rozšírené štatistiky

  • /api/statistics/24h vráti jedno 24-hodinové okno hodinového rozloženia; offset=1,2,... použite pre staršie okná.
  • /api/statistics/top-subjects vráti najčastejšie predmety e-mailov.
  • /api/statistics/top-domains vracia najaktívnejšie domény.
  • /api/statistics/top-senders vracia najaktívnejších odosielateľov.
GPTMail