Dokumentace API

GPTMail API

Pomocí GPTMail API můžete přes HTTPS s hlavičkou X-API-Key generovat dočasné schránky, vypisovat a číst zprávy a mazat poštu. Hodí se pro automatizované testy, CI/CD pipeline a procesy QA.

Jak získat 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žnost 2: Přidejte vlastní doménu

Po ověření MX veřejné domény: odesláno bez přihlášení → klíč API (20000 požadavků); odesláno po přihlášení → 200 bodů. Každá doména získá pouze jednu odměnu. Důležité: po připojení se přípona domény stane veřejnou příponou pro všechny uživatele tohoto webu, takže i ostatní mohou pod ní generovat adresy. Po aktivaci neodstraňujte, nenahrazujte ani neměňte MX záznam směřující doménu na naši službu — jinak pozdější kontroly mohou doménu považovat za chybně nastavenou. Pokud kontrola shledá MX záznam za neplatný, doména se deaktivuje. Zůstane-li MX neplatný při 3 po sobě jdoucích kontrolách, deaktivuje se i přidružená API Key. Pokud se MX později znovu stane platným, doména se automaticky znovu aktivuje.

Domény

Veřejný testovací klíč

Pro testování posílejte v hlavičce X-API-Key sdílený veřejný klíč zobrazený níže. Mění se každý den a má denní limit 200 000 požadavků společný pro všechny uživatele.

Zbývá dnes

Reset za

Načítání živé kvóty pro veřejný klíč...

Níže uvedenou referenci API lze zkopírovat jako Markdown pro AI nástroje, znalostní báze nebo README.

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

AI
llms.txt

·

llms-full.txt

(Markdown)

Rychlý start

  • X-API-Key: YOUR_KEY je nejjednodušší možnost. Pro rychlé testy použijte místo YOUR_KEY denní veřejný klíč zobrazený výše.

  • Většina endpointů schránky vyžaduje parametr email, např. ?email=demo@example.com.

  • Odpovědi GPTMail API používají JSON s poli success, data a error a při použití klíče API také s polem usage. Chyby Cloudflare, včetně odpovědí při překročení limitu požadavků, mohou místo toho vrátit HTML. Před parsováním JSON zkontrolujte stavový kód HTTP a Content-Type.

  • Pokud už znáte podporovanou doménu tohoto webu, nemusíte nejdřív volat endpoint pro generování adresy. Můžete lokálně složit prefix@domain a rovnou volat API schránky — ušetříte jeden požadavek.

Limity četnosti požadavků a opakované pokusy

  • GET a POST /api/generate-email sdílejí limit 30 požadavků za 10 sekund na zdrojovou IP adresu. Platí to pro veřejné i osobní klíče API. Různé klíče a klienti za stejnou IP adresou tento limit sdílejí.

  • Překročení tohoto limitu vrátí HTTP 429 a na 10 sekund zablokuje generování e-mailů. Před dalším pokusem počkejte po dobu uvedenou v Retry-After. Pokud tato hlavička chybí, počkejte alespoň 10 sekund a poté pokusy opakujte s rostoucími prodlevami. Vyhněte se současným opakovaným pokusům z klientů, kteří sdílejí jednu IP adresu.

  • Toto pravidlo se nevztahuje na výpis schránky ani na čtení jednotlivých e-mailů. Denní a celkové kvóty klíčů API platí nezávisle na něm. Čekání 10 sekund vyčerpanou kvótu klíče neobnoví.

Základní endpointy

POST / GET
/api/generate-email

Vygenerujte dočasnou schránku. Použijte GET pro nejjednodušší náhodný tok, nebo POST s prefix a domain, chcete-li plnou kontrolu.

GET
/api/emails?email=...

Načtěte e-maily pro schránku.

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

Načtěte jeden e-mail včetně textu, HTML, surových hlaviček a metadat.

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

Smažte jeden e-mail podle ID.

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

Smažte všechny e-maily ve schránce.

GET
/api/stats

Přečtěte statistiky celého webu.

Ukázkový tok

Níže jsou dva běžné postupy: nechte službu vygenerovat schránku, nebo požádejte o pevný prefix. Pokud už znáte podporovanou doménu, můžete adresu složit lokálně a dotazovat se přímo.

1) Vygenerujte náhodnou dočasnou e-mailovou adresu

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Příklad odpovědi
{
  "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) Generování s pevným prefixem (např. 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"}'
Příklad odpovědi
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Seznam e-mailů ve schránce

Znáte-li už podporovanou doménu, přeskočte krok 1 a dotazujte se přímo.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Příklad odpovědi
{
  "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) Přečtěte jeden e-mail — včetně prostého textu, HTML těla a metadat

Nahraďte EMAIL_ID hodnotou id vrácenou v kroku 3. Předejte také adresu schránky jako email (i při mazání a stahování příloh): e-mail se pak načte přímo z jeho schránky, místo aby se vyhledával podle ID. S API klíčem je parametr email volitelný, jeho odeslání ale zrychlí vyhledání.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Příklad odpovědi
{
  "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) Smažte jeden e-mail podle ID

S API klíčem je parametr email volitelný, jeho odeslání ale zrychlí vyhledání.

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

6) Vyprázdněte celou schránku — smaže všechny e-maily pro tuto adresu

Každé volání smaže jednu dávku. Dokud odpověď obsahuje "has_more": true, volejte jej znovu, dokud nevrátí false.

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

Tvar odpovědi

Úspěšné odpovědi vypadají typicky takto. Při API Key věnujte pozornost informacím o kvótě 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šířené statistiky

  • /api/statistics/24h vrací jedno 24hodinové okno s rozložením po hodinách; starší okna získáte pomocí offset=1,2,... v dotazu.
  • /api/statistics/top-subjects vrací nejčastější předměty e-mailů.
  • /api/statistics/top-domains vrací nejaktivnější domény.
  • /api/statistics/top-senders vrací nejaktivnější odesílatele.
GPTMail