API־דאָקומענטאַציע

GPTMail API

ניצט דעם GPTMail API צו שאַפֿן צײַטווײַליקע אינבאָקסן, אויסליסטן און לייענען אָנזאָגן און אויסמעקן פּאָסט איבער HTTPS מיט אַ X-API-Key־כעדער. ער פּאַסט פֿאַר אויטאָמאַטישע טעסטן, CI/CD־פּײַפּליינס און QA־אַרבעטספֿלוסן.

ווי צו באַקומען אַן API־שליסל

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־כעדער. ער ווערט געביטן יעדן טאָג און האָט אַ טעגלעכן גרענעץ פֿון 200,000 בקשות, געטיילט צווישן אַלע באַניצער.

היינט פֿאַרבליבן

באַנײַט זיך אין

מען לאָדט די לעבעדיקע קוואָטע פֿונעם עפֿנטלעכן שליסל...

די API־רעפֿערענץ אונטן קען מען קאָפּירן ווי Markdown פֿאַר AI־מכשירים, וויסן־באַזעס אָדער אַ README.

באַזע־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, און אויך usage ווען מען ניצט אַן API־שליסל. Cloudflare־פֿעלערן, אַרײַנגערעכנט ענטפֿערס וועגן דעם גרענעץ אויף דער אָפֿטקייט פֿון בקשות, קענען אַנשטאָט דעם צוריקגעבן HTML. קאָנטראָלירט דעם HTTP־סטאַטוס און Content-Type איידער איר פּאַרסירט JSON.

  • אויב איר ווייסט שוין אַ דאָמיין וואָס ווערט איצט געשטיצט אויף דער וועבזײַט, דאַרפֿט איר נישט קודם רופֿן דעם ענדפּוינט פֿאַר שאַפֿן אימעילן. איר קענט צונויפֿשטעלן prefix@domain לאָקאַל און גלײַך רופֿן די פּאָסטקאַסטן־APIs, וואָס שפּאָרט איין API־בקשה.

גרענעצן אויף דער אָפֿטקייט פֿון בקשות, און ווידערפּרוּוון

  • GET און POST /api/generate-email טיילן זיך מיט אַ גרענעץ פֿון 30 בקשות אין 10 סעקונדעס פֿאַר יעדן מקור־IP. דאָס גילט סײַ פֿאַר עפֿנטלעכע סײַ פֿאַר פּערזענלעכע API־שליסלען. פֿאַרשידענע שליסלען און קליענטן הינטער דעם זעלבן IP טיילן זיך מיט דעם גרענעץ.

  • ווען מען גייט אַריבער דעם גרענעץ, באַקומט מען HTTP 429, און דאָס שאַפֿן אימעילן ווערט בלאָקירט אויף 10 סעקונדעס. וואַרט די צײַט פֿון Retry-After איידער איר פּרוּווט ווידער. אויב דער כעדער פֿעלט, וואַרט כאָטש 10 סעקונדעס, און דערנאָך פּרוּווט ווידער מיט וואַקסנדיקע פּויזעס. מײַדט אויס גלײַכצײַטיקע ווידערפּרוּוון פֿון קליענטן וואָס טיילן זיך מיט איין IP.

  • דער כּלל גילט נישט פֿאַרן אויסליסטן אינבאָקסן אָדער לייענען איינצלנע אימעילן. די טעגלעכע און גאַנצע קוואָטעס פֿון API־שליסלען גילטן ווײַטער באַזונדער. וואַרטן 10 סעקונדעס שטעלט נישט צוריק אַן אויסגעשעפּטע שליסל־קוואָטע.

הויפּט־ענדפּוינטן

POST / GET
/api/generate-email

שאַפֿט אַ צײַטווײַליקן אינבאָקס. ניצט GET פֿאַרן פּשוטסטן פּראָצעס מיט אַ צופֿעליקן אינבאָקס, אָדער POST מיט prefix און domain ווען איר ווילט האָבן קלאָרע קאָנטראָל.

GET
/api/emails?email=...

ברענגט די אימעילן פֿון אַ פּאָסטקאַסטן.

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

ברענגט איין אימעיל, אַרײַנגערעכנט טעקסט, HTML, רויע כעדערס און מעטאַדאַטן.

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

מעקט אויס איין אימעיל לויט ID.

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

מעקט אויס אַלע אימעילן אין אַ פּאָסטקאַסטן.

GET
/api/stats

לייענט די סטאַטיסטיק פֿון דער גאַנצער וועבזײַט.

בײַשפּיל־פֿלוס

אונטן זענען צוויי געוויינטלעכע מוסטערן: לאָזט דעם סערוויס שאַפֿן פֿאַר אײַך אַן אינבאָקס, אָדער בעט אַ פֿיקסירטן פּרעפֿיקס. אויב איר ווייסט שוין אַ דאָמיין וואָס ווערט איצט געשטיצט, קענט איר אויך צונויפֿשטעלן דעם פּאָסט־אַדרעס לאָקאַל און אים גלײַך אָנפֿרעגן.

1) שאַפֿן אַ צופֿעליקן צײַטווײַליקן אימעיל־אַדרעס

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) שאַפֿן מיט אַ פֿיקסירטן פּרעפֿיקס (למשל 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) אויסליסטן אימעילן אין אַן אינבאָקס

אויב איר ווייסט שוין אַ געשטיצטן דאָמיין, שפּרינגט איבער שריט 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) לייענען איין אימעיל — אַרײַנגערעכנט פּשוטן טעקסט, HTML־אינהאַלט און מעטאַדאַטן

פֿאַרבײַט EMAIL_ID מיט אַן id וואָס איז צוריקגעקומען אין שריט 3. גיט אויך איבער דעם אינבאָקס־אַדרעס ווי 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

מיט אַן 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) אויסליידיקן אַ גאַנצן אינבאָקס — מעקט אויס אַלע אימעילן פֿון דעם אַדרעס

יעדער רוף מעקט אויס איין פּאַרטיע. כּל־זמן דער ענטפֿער האָט "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