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: اپنا ڈومین شامل کریں

عوامی ڈومین کی MX تصدیق کے بعد: لاگ ان کیے بغیر جمع کرایا → API کلید (20000 درخواستیں)؛ لاگ ان کر کے جمع کرایا → 200 پوائنٹس۔ ہر ڈومین کو صرف ایک انعام ملتا ہے۔ اہم: منسلک ہونے کے بعد وہ ڈومین suffix اس سائٹ کے تمام صارفین کے لیے عوامی suffix بن جاتا ہے، دوسرے صارف بھی اس کے تحت میل باکس پتے بنا سکتے ہیں۔ فعالیت کے بعد، اس ڈومین کو ہماری سروس کی طرف اشارہ کرنے والے MX ریکارڈ کو حذف، تبدیل یا ترمیم نہ کریں۔ ورنہ بعد کی جانچیں ڈومین کو غلط ترتیب سمجھ سکتی ہیں۔ اگر MX غلط پایا جائے تو ڈومین غیر فعال ہو جائے گا۔ اگر MX مسلسل 3 بار غلط رہے تو متعلقہ API Key بھی غیر فعال ہو جائے گی۔ بعد میں MX دوبارہ درست ہونے پر ڈومین خودکار طور پر دوبارہ فعال ہو جائے گا۔

ڈومینز

ٹیسٹنگ کے لیے عوامی کلید

ٹیسٹنگ کے لیے نیچے دکھائی گئی مشترکہ عوامی کلید X-API-Key ہیڈر میں بھیجیں۔ یہ ہر روز بدلتی ہے اور اس کی روزانہ حد 200,000 درخواستیں ہے، جو تمام صارفین میں مشترک ہے۔

آج باقی

ری سیٹ میں

عوامی key کے لیے لائیو کوٹا لوڈ ہو رہا ہے...

ذیل میں API حوالہ AI ٹولز، علم کے ذخیرے یا README کے لیے Markdown کے طور پر نقل کیا جا سکتا ہے۔

بیس یو آر ایل: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

فوری آغاز

  • X-API-Key: YOUR_KEY سب سے آسان طریقہ ہے۔ فوری ٹیسٹ کے لیے YOUR_KEY کی جگہ اوپر دکھائی گئی روزانہ عوامی کلید استعمال کریں۔

  • زیادہ تر میل باکس اینڈ پوائنٹس کو email پیرامیٹر درکار ہوتا ہے، مثال ?email=demo@example.com۔

  • GPTMail API کے جوابات success، data اور error فیلڈز والا JSON استعمال کرتے ہیں، اور API کی استعمال ہونے پر usage بھی شامل ہوتا ہے۔ Cloudflare کی غلطیاں، بشمول شرح کی حد کے جوابات، اس کے بجائے HTML واپس کر سکتی ہیں۔ JSON پارس کرنے سے پہلے HTTP اسٹیٹس اور Content-Type چیک کریں۔

  • اگر آپ کو اس سائٹ پر فی الوقت معاون ڈومین معلوم ہے تو پہلے email جنریشن اینڈ پوائنٹ کال کرنے کی ضرورت نہیں۔ آپ مقامی طور پر prefix@domain بنا کر براہ راست میل باکس APIs کال کر سکتے ہیں، جس سے ایک API درخواست بچتی ہے۔

درخواستوں کی شرح کی حدیں اور دوبارہ کوشش

  • GET اور POST /api/generate-email ہر سورس IP کے لیے 10 سیکنڈ میں 30 درخواستوں کی مشترکہ حد رکھتے ہیں۔ یہ عوامی اور ذاتی دونوں API کیز پر لاگو ہوتی ہے۔ ایک ہی IP کے پیچھے موجود مختلف کیز اور کلائنٹس یہ حد بانٹتے ہیں۔

  • یہ حد عبور کرنے پر HTTP 429 واپس آتا ہے اور 10 سیکنڈ کے لیے ای میل بنانا روک دیا جاتا ہے۔ دوبارہ کوشش سے پہلے Retry-After میں بتائی گئی مدت تک انتظار کریں۔ اگر یہ ہیڈر موجود نہ ہو تو کم از کم 10 سیکنڈ انتظار کریں، پھر بڑھتے وقفوں کے ساتھ دوبارہ کوشش کریں۔ ایک ہی IP استعمال کرنے والے کلائنٹس سے بیک وقت دوبارہ کوشش سے گریز کریں۔

  • یہ قاعدہ ان باکس کی فہرست دیکھنے یا الگ الگ ای میلز پڑھنے پر لاگو نہیں ہوتا۔ API کی کے روزانہ اور کل کوٹے بدستور الگ سے لاگو رہتے ہیں۔ 10 سیکنڈ انتظار کرنے سے ختم شدہ کی کا کوٹا بحال نہیں ہوتا۔

بنیادی اینڈ پوائنٹس

POST / GET
/api/generate-email

عارضی ان باکس بنائیں۔ سادہ ترین بے ترتیب ان باکس کے لیے GET استعمال کریں، یا واضح کنٹرول کے لیے prefix اور domain کے ساتھ POST۔

GET
/api/emails?email=...

ایک میل باکس کے لیے email حاصل کریں۔

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

ایک email حاصل کریں — متن، HTML، خام ہیڈرز اور میٹا ڈیٹا سمیت۔

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

ID سے ایک email حذف کریں۔

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

ایک میل باکس میں تمام email حذف کریں۔

GET
/api/stats

پوری سائٹ کے اعدادوشمار پڑھیں۔

مثال کا بہاؤ

ذیل میں دو عام نمونے ہیں: سروس کو آپ کے لیے ان باکس بنانے دیں، یا مقررہ prefix طلب کریں۔ اگر آپ کو پہلے سے معاون ڈومین معلوم ہے تو مقامی طور پر prefix@domain بنا کر براہ راست پوچھ گچھ کریں۔

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 فہرست کریں

اگر معاون ڈومین معلوم ہے تو مرحلہ 1 چھوڑ کر براہ راست پوچھ گچھ کریں۔

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 باڈی اور میٹا ڈیٹا سمیت

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 حذف کریں

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 سب سے زیادہ فعال ڈومینز واپس کرتا ہے۔
  • /api/statistics/top-senders سب سے زیادہ فعال بھیجنے والوں کی فہرست واپس کرتا ہے۔
GPTMail