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 ਅੰਕ। ਹਰ ਡੋਮੇਨ ਨੂੰ ਸਿਰਫ਼ ਇੱਕ ਇਨਾਮ ਮਿਲਦਾ ਹੈ। ਮਹੱਤਵਪੂਰਨ: ਜੁੜਨ ਤੋਂ ਬਾਅਦ ਉਹ ਡੋਮੇਨ ਸਫ਼ਿਕਸ ਇਸ ਸਾਈਟ ਦੇ ਸਾਰੇ ਵਰਤੋਂਕਾਰਾਂ ਲਈ ਉਪਲਬਧ ਇੱਕ ਜਨਤਕ ਸਫ਼ਿਕਸ ਬਣ ਜਾਂਦਾ ਹੈ, ਇਸ ਲਈ ਹੋਰ ਵਰਤੋਂਕਾਰ ਵੀ ਉਸ ਹੇਠ ਮੇਲਬਾਕਸ ਪਤੇ ਬਣਾ ਸਕਦੇ ਹਨ। ਸਰਗਰਮ ਹੋਣ ਤੋਂ ਬਾਅਦ ਇਸ ਡੋਮੇਨ ਨੂੰ ਸਾਡੀ ਸੇਵਾ ਵੱਲ ਪੁਆਇੰਟ ਕਰਨ ਵਾਲੇ 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 ਦੀ ਥਾਂ ਉੱਪਰ ਦਿਖਾਈ ਗਈ ਰੋਜ਼ਾਨਾ ਜਨਤਕ ਕੁੰਜੀ ਵਰਤੋ।

  • ਜ਼ਿਆਦਾਤਰ ਮੇਲਬਾਕਸ ਐਂਡਪੁਆਇੰਟ ਨੂੰ email ਪੈਰਾਮੀਟਰ ਚਾਹੀਦਾ ਹੈ, ਉਦਾਹਰਣ ?email=demo@example.com।

  • GPTMail API ਦੇ ਜਵਾਬ success, data ਅਤੇ error ਖੇਤਰਾਂ ਵਾਲਾ JSON ਵਰਤਦੇ ਹਨ, ਅਤੇ API ਕੁੰਜੀ ਵਰਤਣ 'ਤੇ usage ਵੀ ਹੁੰਦਾ ਹੈ। Cloudflare ਦੀਆਂ ਗਲਤੀਆਂ, ਦਰ-ਸੀਮਾ ਵਾਲੇ ਜਵਾਬਾਂ ਸਮੇਤ, ਇਸ ਦੀ ਬਜਾਏ HTML ਵਾਪਸ ਕਰ ਸਕਦੀਆਂ ਹਨ। JSON ਪਾਰਸ ਕਰਨ ਤੋਂ ਪਹਿਲਾਂ HTTP ਸਥਿਤੀ ਅਤੇ Content-Type ਜਾਂਚੋ।

  • ਜੇ ਤੁਹਾਨੂੰ ਇਸ ਸਾਈਟ ਤੇ ਪਹਿਲਾਂ ਹੀ ਇੱਕ ਸਮਰਥਿਤ domain ਪਤਾ ਹੈ, ਤਾਂ ਤੁਹਾਨੂੰ ਪਹਿਲਾਂ 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 ਮੰਗੋ। ਜੇ ਤੁਹਾਨੂੰ ਪਹਿਲਾਂ ਹੀ ਇੱਕ ਸਮਰਥਿਤ 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 ਸੂਚੀਬੱਧ ਕਰੋ

ਜੇ ਤੁਹਾਨੂੰ ਸਮਰਥਿਤ domain ਪਤਾ ਹੈ, ਕਦਮ 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