API दस्तावेज़

GPTMail API

GPTMail API का उपयोग करके आप HTTPS पर X-API-Key हेडर के साथ अस्थायी इनबॉक्स बना सकते हैं, संदेशों की सूची देख और पढ़ सकते हैं, और मेल हटा सकते हैं। यह स्वचालित परीक्षणों, CI/CD पाइपलाइनों और QA वर्कफ़्लो के लिए उपयुक्त है।

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

विकल्प 2: अपना domain जोड़ें

सार्वजनिक डोमेन का MX सत्यापन सफल होने पर: बिना लॉगिन जमा किया → API कुंजी (20000 अनुरोध); लॉगिन करके जमा किया → 200 अंक। प्रत्येक डोमेन को केवल एक पुरस्कार मिलता है। महत्वपूर्ण: जुड़ने के बाद वह डोमेन सफ़िक्स इस साइट के सभी उपयोगकर्ताओं के लिए उपलब्ध सार्वजनिक सफ़िक्स बन जाता है, इसलिए दूसरे उपयोगकर्ता भी उसके तहत मेलबॉक्स पते बना सकते हैं। सक्रिय होने के बाद इस डोमेन को हमारी सेवा पर पॉइंट करने वाले MX रिकॉर्ड को न हटाएँ, न बदलें और न उसमें कोई संशोधन करें। अन्यथा बाद की जाँचों में डोमेन को गलत तरीके से कॉन्फ़िगर माना जा सकता है। अगर बाद की किसी जाँच में MX रिकॉर्ड अमान्य पाया जाता है, तो डोमेन निष्क्रिय कर दिया जाएगा। अगर MX रिकॉर्ड लगातार 3 जाँचों तक अमान्य रहता है, तो संबंधित API कुंजी भी निष्क्रिय कर दी जाएगी। अगर बाद में MX रिकॉर्ड फिर से मान्य हो जाता है, तो डोमेन अपने-आप फिर से सक्रिय हो जाएगा।

डोमेन

सार्वजनिक परीक्षण कुंजी

परीक्षण के लिए नीचे दिखाई गई साझा सार्वजनिक कुंजी को X-API-Key हेडर में भेजें। यह हर दिन बदलती है और इसकी दैनिक सीमा 2,00,000 अनुरोध है, जो सभी उपयोगकर्ताओं में साझा होती है।

आज शेष

रीसेट होगा

सार्वजनिक कुंजी का लाइव कोटा लोड हो रहा है...

नीचे दिया गया API संदर्भ AI टूल, नॉलेज बेस या README के लिए Markdown के रूप में कॉपी किया जा सकता है।

बेस URL: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

त्वरित प्रारंभ

  • X-API-Key: YOUR_KEY सबसे आसान विकल्प है। त्वरित परीक्षणों के लिए YOUR_KEY की जगह ऊपर दिखाई गई दैनिक सार्वजनिक कुंजी इस्तेमाल करें।

  • अधिकांश मेलबॉक्स endpoints को email पैरामीटर चाहिए, उदाहरण ?email=demo@example.com।

  • GPTMail API के जवाब success, data और error फ़ील्ड वाले JSON का उपयोग करते हैं, और API कुंजी इस्तेमाल होने पर usage भी होता है। Cloudflare की त्रुटियाँ, जिनमें दर-सीमा वाले जवाब भी शामिल हैं, इसके बजाय HTML लौटा सकती हैं। JSON पार्स करने से पहले HTTP स्थिति और Content-Type जाँचें।

  • यदि आपको इस साइट पर वर्तमान में समर्थित domain पता है, तो पहले email जनरेशन endpoint कॉल करना ज़रूरी नहीं। आप स्थानीय रूप से prefix@domain बना सकते हैं और सीधे मेलबॉक्स APIs कॉल कर सकते हैं — एक API अनुरोध बचता है।

अनुरोध दर सीमाएँ और पुनः प्रयास

  • GET और POST /api/generate-email प्रति स्रोत IP हर 10 सेकंड में 30 अनुरोधों की एक साझा सीमा रखते हैं। यह सार्वजनिक और व्यक्तिगत दोनों API कुंजियों पर लागू होता है। एक ही IP के पीछे की अलग-अलग कुंजियाँ और क्लाइंट यह सीमा साझा करते हैं।

  • यह सीमा पार करने पर HTTP 429 मिलता है और 10 सेकंड के लिए पते बनाना बंद हो जाता है। दोबारा कोशिश करने से पहले Retry-After में बताई गई अवधि तक प्रतीक्षा करें। अगर यह हेडर न हो, तो कम से कम 10 सेकंड रुकें, फिर बढ़ते अंतराल के साथ दोबारा कोशिश करें। एक ही IP साझा करने वाले क्लाइंट से एक साथ पुनः प्रयास करने से बचें।

  • यह नियम इनबॉक्स सूची देखने या अलग-अलग ईमेल पढ़ने पर लागू नहीं होता। API कुंजी के दैनिक और कुल कोटे अलग से लागू रहते हैं। 10 सेकंड प्रतीक्षा करने से खत्म हो चुका कुंजी कोटा वापस नहीं आता।

मुख्य Endpoints

POST / GET
/api/generate-email

एक अस्थायी इनबॉक्स बनाएँ। सबसे सरल यादृच्छिक इनबॉक्स फ़्लो के लिए GET उपयोग करें, या स्पष्ट नियंत्रण चाहने पर prefix और domain के साथ POST।

GET
/api/emails?email=...

एक मेलबॉक्स के लिए email लाएँ।

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

एक email लाएँ — टेक्स्ट, HTML, कच्चे headers और metadata सहित।

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

ID से एक email DELETE करें।

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

मेलबॉक्स में सभी email DELETE करें।

GET
/api/stats

साइट-वाइड आँकड़े पढ़ें।

उदाहरण फ़्लो

नीचे दो सामान्य पैटर्न हैं: सेवा को आपके लिए इनबॉक्स बनाने दें, या निश्चित prefix माँगें। यदि आपको पहले से कोई समर्थित domain पता है, तो आप mailbox को स्थानीय रूप से जोड़ सकते हैं और सीधे query कर सकते हैं।

1) यादृच्छिक अस्थायी email पता बनाएँ

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
प्रतिक्रिया उदाहरण
{
  "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) निश्चित prefix के साथ बनाएँ (उदा. 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"}'
प्रतिक्रिया उदाहरण
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) इनबॉक्स में email सूचीबद्ध करें

यदि समर्थित domain पता है, तो चरण 1 छोड़ें और सीधे query करें।

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
प्रतिक्रिया उदाहरण
{
  "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) एक email पढ़ें — सादा टेक्स्ट, HTML बॉडी और metadata सहित

EMAIL_ID को चरण 3 में लौटाए गए id से बदलें। इनबॉक्स का पता भी email के रूप में भेजें (हटाने और अटैचमेंट डाउनलोड करने पर भी): तब ईमेल ID से खोजे जाने के बजाय सीधे अपने इनबॉक्स से पढ़ा जाता है। API कुंजी के साथ email पैरामीटर वैकल्पिक है, लेकिन इसे भेजने से खोज तेज़ होती है।

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
प्रतिक्रिया उदाहरण
{
  "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) ID से एक email DELETE करें

API कुंजी के साथ email पैरामीटर वैकल्पिक है, लेकिन इसे भेजने से खोज तेज़ होती है।

curl -X DELETE 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
प्रतिक्रिया उदाहरण
{
  "success": true,
  "data": {
    "message": "Email deleted"
  }
}

6) पूरा इनबॉक्स खाली करें — इस पते के सभी email हटाता है

हर कॉल एक बैच हटाती है। जब तक प्रतिक्रिया में "has_more": true हो, इसे तब तक दोबारा कॉल करें जब तक यह false न लौटाए।

curl -X DELETE 'https://mail.chatgpt.org.uk/api/emails/clear?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
प्रतिक्रिया उदाहरण
{
  "success": true,
  "data": {
    "message": "Deleted 3 emails",
    "count": 3,
    "has_more": false
  }
}

प्रतिक्रिया संरचना

सफल प्रतिक्रियाएँ आमतौर पर ऐसी दिखती हैं। API key से प्रमाणित होने पर 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
  }
}

विस्तारित आँकड़े

  • /api/statistics/24h 24 घंटे की एक प्रति घंटा वितरण विंडो लौटाता है; पुरानी विंडो के लिए offset=1,2,... का उपयोग करें।
  • /api/statistics/top-subjects सबसे आम ईमेल विषय लौटाता है।
  • /api/statistics/top-domains सबसे सक्रिय domains लौटाता है।
  • /api/statistics/top-senders सबसे सक्रिय senders लौटाता है।
GPTMail