Dokumentasi API

GPTMail API

Gunakake API GPTMail kanggo nggawe kothak mlebu sauntara, nampilake lan maca pesen, sarta mbusak email liwat HTTPS nganggo header X-API-Key. Iki cocog kanggo tes otomatis, pipeline CI/CD, lan alur kerja QA.

Cara Entuk 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

Pilihan 2: Tambah domain dhewe

Sawise domain umum lolos verifikasi MX: dikirim tanpa mlebu akun → kunci API (20000 panjaluk); dikirim nalika mlebu akun → 200 poin. Saben domain mung nampa siji ganjaran. Penting: sawise disambungake, suffix domain kuwi dadi public suffix sing sumadhiya kanggo kabeh pangguna ing situs iki, dadi pangguna liya uga bisa nggawe alamat mailbox ing ngisoré. Sawise diaktifake, aja mbusak, ngganti, utawa ngowahi rekaman MX sing nuduhake domain iki menyang layanan kita. Yen ora, priksa mengko bisa uga nganggep domain kuwi salah konfigurasi. Yen priksa mengko nemokake MX ora sah, domain bakal dinonaktifake. Yen MX tetep ora sah kanggo 3 priksa berurutan, API Key sing gegandhengan uga bakal dinonaktifake. Yen MX malih dadi sah mengko, domain bakal diaktifake maneh otomatis.

Domain

Kunci tes umum

Kanggo tes, kirim kunci umum bebarengan sing ditampilake ing ngisor iki ing header X-API-Key. Kunci iki ganti saben dina lan duwe watesan saben dina 200.000 panjalukan sing dienggo bebarengan kabeh pangguna.

Sisa Dina Iki

Reset Ing

Muat kuota langsung kanggo public key...

Referensi API ing ngisor iki bisa disalin minangka Markdown kanggo piranti AI, basis kawruh, utawa README.

URL dhasar: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Miwiti Cepet

  • X-API-Key: YOUR_KEY minangka pilihan sing paling gampang. Kanggo tes cepet, gunakake kunci umum saben dina sing ditampilake ing ndhuwur minangka ganti YOUR_KEY.

  • Akèh endpoint mailbox mbutuhake parameter email, contone ?email=demo@example.com.

  • Tanggapan API GPTMail nganggo JSON kanthi kolom success, data, lan error, uga usage yen nganggo kunci API. Kasalahan Cloudflare, kalebu tanggapan watesan frekuensi, bisa wae mbalekake HTML. Priksa status HTTP lan Content-Type sadurunge ngolah JSON.

  • Yen sampeyan wis ngerti domain sing didhukung saiki ing situs iki, ora perlu nelpon endpoint generasi email dhisik. Sampeyan bisa nggabung prefix@domain sacara lokal lan nelpon API mailbox langsung, ngirit siji request API.

Watesan frekuensi lan nyoba maneh

  • GET lan POST /api/generate-email nganggo watesan bebarengan 30 panjalukan saben 10 detik kanggo saben IP sumber. Iki ditrapake kanggo kunci API umum lan pribadi. Kunci lan klien sing beda ing IP sing padha nganggo watesan iki bebarengan.

  • Yen watesan iki diliwati, bakal mbalekake HTTP 429 lan nggawe email diblokir 10 detik. Enteni sajrone wektu Retry-After sadurunge nyoba maneh. Yen header iki ora ana, enteni paling ora 10 detik, banjur coba maneh kanthi jeda sing saya suwe. Aja nyoba maneh bebarengan saka klien sing nganggo IP sing padha.

  • Aturan iki ora ditrapake kanggo nampilake dhaptar kothak mlebu utawa maca email siji-siji. Kuota saben dina lan total kunci API tetep ditrapake dhewe-dhewe. Ngenteni 10 detik ora mbalekake kuota kunci sing wis entek.

Endpoint Inti

POST / GET
/api/generate-email

Gawe inbox sawentara. Gunakake GET kanggo alur inbox acak paling prasaja, utawa POST kanthi prefix lan domain yen sampeyan pengin kontrol sing cetha.

GET
/api/emails?email=...

Jupuk email kanggo siji mailbox.

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

Jupuk siji email, kalebu teks, HTML, header mentah, lan metadata.

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

Busak siji email miturut ID.

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

Busak kabeh email ing siji mailbox.

GET
/api/stats

Waca statistik saindenging situs.

Conto Alur

Ing ngisor iki ana rong pola umum: idini layanan nggawe inbox kanggo sampeyan, utawa jaluk prefix tetep. Yen sampeyan wis ngerti domain sing didhukung saiki, sampeyan uga bisa nggabung mailbox sacara lokal lan takon langsung.

1) Gawe alamat email sawentara acak

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Conto response
{
  "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) Gawe karo prefix tetep (conto 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"}'
Conto response
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Dhaftar email ing inbox

Yen sampeyan wis ngerti domain sing didhukung, lengkahi langkah 1 lan takon langsung.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Conto response
{
  "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) Waca siji email — kalebu plain text, badan HTML, lan metadata

Ganti EMAIL_ID nganggo id sing dibalekake saka langkah 3. Kirim uga alamat kothak mlebu minangka email (uga kanggo mbusak lan ngundhuh lampiran): banjur email diwaca langsung saka kothak mlebune tinimbang digoleki miturut ID. Nganggo API key, parameter email ora wajib, nanging ngirimake bakal nggawe panelusuran luwih cepet.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Conto response
{
  "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) Busak siji email miturut ID

Nganggo API key, parameter email ora wajib, nanging ngirimake bakal nggawe panelusuran luwih cepet.

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

6) Kosongake kabeh inbox — mbusak kabeh email kanggo alamat iki

Saben panggilan mbusak siji kelompok. Sauntara respon isih ngemot "has_more": true, panggil maneh nganti ngasilake false.

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

Bentuk Response

Response sukses biasane katon kaya iki. Yen sampeyan autentikasi karo API Key, perhatèkake informasi quota ing 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
  }
}

Statistik Lanjutan

  • /api/statistics/24h mbalekake siji jendhela sebaran saben jam kanggo 24 jam; gunakake offset=1,2,... kanggo jendhela sing luwih lawas.
  • /api/statistics/top-subjects mbalekake subjek email sing paling kerep.
  • /api/statistics/top-domains mbalikake domain paling aktif.
  • /api/statistics/top-senders mbalikake pangirim paling aktif.
GPTMail