API دستاويز

GPTMail API

GPTMail API استعمال ڪري عارضي انباڪس ٺاهيو، پيغامن جي فهرست ڏسو ۽ پڙهو، ۽ X-API-Key هيڊر سان HTTPS ذريعي ميل ختم ڪريو. اهو خودڪار ٽيسٽن، 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 پوائنٽون. هر ڊومين کي رڳو هڪ انعام ملي ٿو. اهم: ڳنڍڻ کان پوءِ اهو ڊومين سفڪس هن سائيٽ جي سڀني استعمال ڪندڙن لاءِ عوامي ٿي ويندو، ٻيا به ان هيٺ ميل بڪس پتا ٺاهي سگهن ٿا. فعاليت کان پوءِ، اسان جي سروس ڏانهن اشارو ڪندڙ MX رڪارڊ کي ختم، تبديل يا ترميم نه ڪريو. نه ته پوءِ پويون چيڪ ڊومين کي غلط ترتيب سمجهن ٿا. جيڪڏهن MX غلط ملي ته ڊومين غير فعال ٿيندو. جيڪڏهن MX لڳاتار 3 چيڪن تائين غلط رهي ته لاڳاپيل API Key به غير فعال ٿي ويندي. پوءِ MX ٻيهر صحيح ٿيڻ تي ڊومين پاڻمرادو ٻيهر فعال ٿيندو.

ڊومينز

عوامي ٽيسٽ ڪنجي

ٽيسٽ لاءِ، هيٺ ڏيکاريل گڏيل عوامي ڪنجي X-API-Key هيڊر ۾ موڪليو. اها هر روز بدلجي ٿي ۽ ان جي روزاني حد 200,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 جي جاءِ تي مٿي ڏيکاريل روزاني عوامي ڪنجي استعمال ڪريو.

  • گهڻن ميل باڪس اينڊ پوائنٽس کي email پيراميٽر گهرجي، مثال طور ?email=demo@example.com.

  • GPTMail API جا جواب JSON ۾ هوندا آهن، جن ۾ success، data ۽ error فيلڊ هوندا آهن، ۽ 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 ڪنجي سان تصديق ڪريو ٿا ته 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