Dokumentasyon ng API

GPTMail API

Gamitin ang GPTMail API para gumawa ng pansamantalang inbox, maglista at magbasa ng mga mensahe, at magbura ng mail sa HTTPS gamit ang X-API-Key header. Angkop ito para sa automated na pagsubok, mga CI/CD pipeline, at mga QA workflow.

Paano Kumuha ng 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

Opsyon 2: Idagdag ang sarili mong domain

Kapag pumasa sa MX verification ang pampublikong domain: isinumite nang hindi naka-sign in → API key (20000 request); isinumite habang naka-sign in → 200 puntos. Isang gantimpala lang ang matatanggap ng bawat domain. Mahalaga: kapag nakakonekta na, ang domain suffix na iyon ay magiging public suffix na available sa lahat ng user sa site na ito, kaya maaari ring gumawa ang ibang user ng mailbox address sa ilalim nito. Pagkatapos ma-activate, huwag burahin, palitan, o baguhin ang MX record na nakaturo ang domain na ito sa aming serbisyo. Kung hindi, maaaring ituring ng mga susunod na check na mali ang setup ng domain. Kung may check na nakitang invalid ang MX record, ide-deactivate ang domain. Kung mananatiling invalid ang MX record sa 3 magkakasunod na check, ide-deactivate din ang nauugnay na API Key. Kung magiging valid muli ang MX record sa ibang pagkakataon, awtomatikong maia-activate ulit ang domain.

Mga Domain

Pampublikong key para sa pagsubok

Para sa pagsubok, ipadala ang nakabahaging pampublikong key na nakikita sa ibaba sa X-API-Key header. Nagbabago ito araw-araw at may pang-araw-araw na limit na 200,000 request na pinaghahatian ng lahat ng user.

Natitira Ngayon

Magre-reset Sa

Nilo-load ang live quota para sa public key...

Maaaring kopyahin ang API reference sa ibaba bilang Markdown para sa AI tools, knowledge bases, o README.

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

AI
llms.txt

·

llms-full.txt

(Markdown)

Mabilis na Simula

  • X-API-Key: YOUR_KEY ang pinakasimpleng opsyon. Para sa mabilisang pagsubok, gamitin ang pang-araw-araw na pampublikong key na nakikita sa itaas kapalit ng YOUR_KEY.

  • Karamihan sa mailbox endpoints ay nangangailangan ng parameter na email, halimbawa ?email=demo@example.com.

  • Gumagamit ang mga sagot ng GPTMail API ng JSON na may mga field na success, data, at error, pati ng usage kapag may ginamit na API key. Ang mga error ng Cloudflare, kasama ang mga sagot dahil sa rate limit, ay maaaring magbalik ng HTML sa halip. Suriin ang HTTP status at Content-Type bago i-parse ang JSON.

  • Kung alam mo na ang kasalukuyang supported na domain sa site na ito, hindi mo kailangang tawagin muna ang email generation endpoint. Maaari mong buuin ang prefix@domain nang lokal at direktang tawagin ang mailbox APIs, na nakakatipid ng isang API request.

Mga rate limit at muling pagsubok

  • Magkasamang gumagamit ang GET at POST /api/generate-email ng limit na 30 request kada 10 segundo bawat source IP. Nalalapat ito sa pampubliko at personal na API key. Pinaghahatian ng iba't ibang key at client sa likod ng iisang IP ang limit na ito.

  • Kapag nalampasan ang limit na ito, magbabalik ito ng HTTP 429 at haharangin ang paggawa ng email sa loob ng 10 segundo. Hintayin ang tagal na nasa Retry-After bago subukang muli. Kung wala ang header na ito, maghintay nang hindi bababa sa 10 segundo, saka subukang muli nang may palaking pagitan. Iwasan ang sabay-sabay na muling pagsubok mula sa mga client na iisa ang IP.

  • Hindi nalalapat ang patakarang ito sa paglilista ng inbox o pagbasa ng isa-isang email. Nalalapat pa rin nang hiwalay ang pang-araw-araw at kabuuang quota ng API key. Hindi naibabalik ng paghihintay nang 10 segundo ang naubos na quota ng key.

Pangunahing Endpoints

POST / GET
/api/generate-email

Gumawa ng pansamantalang inbox. Gamitin ang GET para sa pinakasimpleng random inbox flow, o POST na may prefix at domain kapag gusto mong kontrolin nang tiyak.

GET
/api/emails?email=...

Kunin ang mga email para sa isang mailbox.

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

Kunin ang isang email, kasama ang text, HTML, raw headers, at metadata.

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

Tanggalin ang isang email ayon sa ID.

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

Tanggalin ang lahat ng email sa isang mailbox.

GET
/api/stats

Basahin ang site-wide na statistics.

Halimbawang Flow

Nasa ibaba ang dalawang karaniwang pattern: hayaang gumawa ang serbisyo ng inbox para sa iyo, o humiling ng fixed na prefix. Kung alam mo na ang kasalukuyang supported na domain, maaari mo ring buuin ang mailbox nang lokal at direktang i-query ito.

1) Bumuo ng random na pansamantalang email address

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Halimbawa ng 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) Bumuo gamit ang fixed na prefix (hal. 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"}'
Halimbawa ng response
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Ilista ang mga email sa inbox

Kung alam mo na ang supported na domain, laktawan ang hakbang 1 at direktang mag-query.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Halimbawa ng 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) Basahin ang isang email — kasama ang plain text, HTML body, at metadata

Palitan ang EMAIL_ID ng id na ibinalik mula sa hakbang 3. Ipasa rin ang address ng inbox bilang email (pati sa pagbura at pag-download ng attachment): direktang babasahin ang email mula sa inbox nito sa halip na hanapin ayon sa ID. Kapag may API key, opsyonal ang parameter na email, pero mas bumibilis ang paghahanap kapag ipinadala ito.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Halimbawa ng 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) Tanggalin ang isang email ayon sa ID

Kapag may API key, opsyonal ang parameter na email, pero mas bumibilis ang paghahanap kapag ipinadala ito.

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

6) Linisin ang buong inbox — tinatanggal ang lahat ng email para sa address na ito

Bawat tawag ay nagbubura ng isang batch. Hangga't may "has_more": true ang tugon, tawagin ito ulit hanggang magbalik ito ng false.

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

Hugis ng Response

Ang matagumpay na mga response ay karaniwang ganito ang itsura. Kung nag-authenticate ka gamit ang API Key, pansinin ang impormasyon ng quota sa loob ng 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
  }
}

Pinalawig na Statistics

  • /api/statistics/24h nagbabalik ng isang 24-oras na window ng distribusyon kada oras; gamitin ang offset=1,2,... para sa mas lumang mga window.
  • /api/statistics/top-subjects nagbabalik ng pinakamadalas na subject ng email.
  • /api/statistics/top-domains nagbabalik ng pinakaaktibong domains.
  • /api/statistics/top-senders nagbabalik ng pinakaaktibong senders.
GPTMail