API દસ્તાવેજીકરણ

GPTMail API

X-API-Key હેડર સાથે HTTPS દ્વારા અસ્થાયી ઇનબોક્સ બનાવવા, સંદેશાઓની યાદી જોવા અને વાંચવા તથા મેઇલ કાઢી નાખવા માટે GPTMail API નો ઉપયોગ કરો. તે સ્વચાલિત પરીક્ષણો, 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 પૉઇન્ટ. દરેક ડોમેનને માત્ર એક પુરસ્કાર મળે છે. મહત્વપૂર્ણ: કનેક્ટ થયા પછી તે domain suffix આ સાઇટ પરના બધા વપરાશકર્તાઓ માટે ઉપલબ્ધ public suffix બને છે, તેથી અન્ય વપરાશકર્તાઓ પણ તે હેઠળ mailbox સરનામાં બનાવી શકે છે. સક્રિય કર્યા પછી, અમારી સેવા તરફ આ domain નિર્દેશિત કરતો MX રેકોર્ડ કાઢી નાખશો નહીં, બદલશો નહીં અથવા સંશોધિત કરશો નહીં. નહીંતર પછીની તપાસો domain ખોટી રીતે કોન્ફિગર થયેલ માની શકે છે. MX રેકોર્ડ અમાન્ય મળ્યો તો domain નિષ્ક્રિય થશે. MX રેકોર્ડ 3 સતત તપાસોમાં અમાન્ય રહે તો સંબંધિત API Key પણ નિષ્ક્રિય થશે. MX રેકોર્ડ પછી ફરી માન્ય થાય તો domain આપમેળે ફરી સક્રિય થશે.

ડોમેન્સ

જાહેર પરીક્ષણ કી

પરીક્ષણ માટે, નીચે દર્શાવેલી વહેંચાયેલ જાહેર કી X-API-Key હેડરમાં મોકલો. તે દરરોજ બદલાય છે અને તેની દૈનિક મર્યાદા 200,000 વિનંતીઓની છે, જે બધા વપરાશકર્તાઓ વચ્ચે વહેંચાયેલી છે.

આજે બાકી

રીસેટ થશે

public key માટે live quota લોડ થઈ રહ્યું છે...

નીચેનો API સંદર્ભ AI સાધનો, નોલેજ બેઝ અથવા README માટે Markdown તરીકે નકલ કરી શકાય છે.

બેઝ URL: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

ઝડપી શરૂઆત

  • X-API-Key: YOUR_KEY સૌથી સરળ વિકલ્પ છે. ઝડપી પરીક્ષણ માટે YOUR_KEY ને બદલે ઉપર દર્શાવેલી દૈનિક જાહેર કીનો ઉપયોગ કરો.

  • મોટાભાગના mailbox endpoints માટે email પેરામીટર જોઈએ, ઉદા. ?email=demo@example.com.

  • GPTMail API ના પ્રતિભાવો success, data અને error ફીલ્ડ સાથેના JSON નો ઉપયોગ કરે છે, અને API કી વપરાય ત્યારે usage પણ હોય છે. Cloudflare ની ભૂલો, જેમાં વિનંતી દર મર્યાદાના પ્રતિભાવો પણ સામેલ છે, તેના બદલે HTML પરત કરી શકે છે. JSON પાર્સ કરતાં પહેલાં HTTP સ્થિતિ અને Content-Type તપાસો.

  • જો આ સાઇટ પર હાલમાં સમર્થિત domain તમને ખબર હોય તો પહેલા email generation endpoint કૉલ કરવું જરૂરી નથી. તમે locally prefix@domain બનાવી mailbox 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

તાત્કાલિક inbox બનાવો. સૌથી સરળ random inbox પ્રવાહ માટે GET વાપરો, અથવા સ્પષ્ટ નિયંત્રણ જોઈતું હોય ત્યારે prefix અને domain સાથે POST.

GET
/api/emails?email=...

એક mailbox માટે email લાવો.

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

એક email લાવો — ટેક્સ્ટ, HTML, raw headers અને metadata સહિત.

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

ID દ્વારા એક email કાઢી નાખો.

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

એક mailbox માં બધા email કાઢી નાખો.

GET
/api/stats

સમગ્ર સાઇટની આંકડાકીય માહિતી વાંચો.

ઉદાહરણ પ્રવાહ

નીચે બે સામાન્ય પેટર્ન છે: સેવાને તમારા માટે inbox બનાવવા દો, અથવા નિશ્ચિત prefix માંગો. જો હાલમાં સમર્થિત domain તમને ખબર હોય તો તમે locally mailbox બનાવી સીધી query કરી શકો છો.

1) યાદૃચ્છિક તાત્કાલિક email સરનામું બનાવો

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
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) નિશ્ચિત 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"}'
response ઉદાહરણ
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) inbox માં email યાદી

સમર્થિત domain ખબર હોય તો પગલું 1 છોડીને સીધી query કરો.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
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) એક ઇમેઇલ વાંચો — તેમાં સાદો લખાણ, 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'
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) 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'
response ઉદાહરણ
{
  "success": true,
  "data": {
    "message": "Email deleted"
  }
}

6) સમગ્ર inbox સાફ કરો — આ સરનામાં માટે બધા 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'
response ઉદાહરણ
{
  "success": true,
  "data": {
    "message": "Deleted 3 emails",
    "count": 3,
    "has_more": false
  }
}

Response આકાર

સફળ responses સામાન્ય રીતે આવા દેખાય છે. API Key થી પ્રમાણીકરણ કરતા usage અંદરની quota માહિતી ધ્યાનમાં લો.

{
  "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 સૌથી સક્રિય domain પાછા આપે છે.
  • /api/statistics/top-senders સૌથી સક્રિય મોકલનારાઓ પાછા આપે છે.
GPTMail