Akwụkwọ API

GPTMail API

Jiri GPTMail API mepụta igbe mbata nwa oge, depụta ma gụọ ozi, ma hichapụ ozi-e site na HTTPS jiri isi X-API-Key. Ọ dabara maka ule akpaaka, usoro CI/CD na usoro ọrụ QA.

Otu esi nweta 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

Nhọrọ 2: Tinye ngalaba nke gị

Mgbe ngalaba ọha gafere nkwenye MX: ezigara n'abanyeghị akaụntụ → igodo API (arịrịọ 20000); ezigara mgbe abanyechara → isi 200. Ngalaba ọ bụla na-enweta naanị otu ụgwọ ọrụ. Ihe dị mkpa: ozugbo ejikọrọ ya, suffix ngalaba ahụ ghọrọ suffix ọha dịịrị ndị ọrụ niile nke saịtị a, ya mere ndị ọrụ ọzọ nwekwara ike imepụta adreesị igbe ozi n'okpuru ya. Mgbe agbalitere ya, ehichapụla, edochila, ma ọ bụ agbanwela ndekọ MX na-atụ ngalaba a n'ọrụ anyị. Ma ọ bụghị ya, nyocha ndị ọzọ nwere ike ịhụ ngalaba ahụ dịka nke ahazighị nke ọma. Ọ bụrụ na nyocha ọzọ achọpụta na ndekọ MX ezighi ezi, a ga-agbanyụ ngalaba ahụ. Ọ bụrụ na ndekọ MX ka ezighi ezi maka nyocha 3 n'usoro, a ga-agbanyụkwa igodo API metụtara ya. Ọ bụrụ na ndekọ MX ziri ezi ọzọ ma e mesịa, a ga-eme ka ngalaba ahụ rụọ ọrụ ọzọ na-akpaghị aka.

Ngalaba

Igodo ọha maka ule

Maka ule, zipu igodo ọha a na-ekerịta nke egosiri n'okpuru n'isi X-API-Key. Ọ na-agbanwe kwa ụbọchị, ma nwee oke kwa ụbọchị nke arịrịọ 200,000 nke ndị ọrụ niile na-ekerịta.

Fọdụrụ taa

Mmalite ọhụrụ na

Na-ebugo quota ozugbo maka igodo ọha...

Ndenyeghi API n'okpuru ebe a nwere ike ịdeta dị ka Markdown maka ngwa AI, ọdịnaya ọmụmụ, ma ọ bụ README.

URL isi: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Bido ngwa ngwa

  • X-API-Key: YOUR_KEY bụ nhọrọ kachasị mfe. Maka ule ngwa ngwa, jiri igodo ọha kwa ụbọchị egosiri n'elu dochie YOUR_KEY.

  • Ọtụtụ endpoints igbe achọrọ paramita email, dị ka ?email=demo@example.com.

  • Nzaghachi GPTMail API na-eji JSON nwere mpaghara success, data na error, yana usage mgbe a na-eji igodo API. Njehie Cloudflare, gụnyere nzaghachi oke ọsọ arịrịọ, nwere ike iweghachi HTML kama. Lelee ọnọdụ HTTP na Content-Type tupu ị tụgharịa JSON.

  • Ọ bụrụ na ị maralarị ngalaba saịtị a na-akwado ugbu a, ọ dịghị mkpa ịkpọ endpoint mmepụta ozi-e mbụ. Ị nwere ike ịhazi prefix@domain n'onwe gị ma kpọọ API igbe mbata ozugbo, nke na-echekwa otu arịrịọ API.

Oke ọsọ arịrịọ na nnwaghachi

  • GET na POST /api/generate-email na-ekerịta oke nke arịrịọ 30 kwa sekọnd 10 maka adreesị IP isi mmalite ọ bụla. Nke a metụtara ma igodo API ọha ma nke nkeonwe. Igodo na ndị ahịa dị iche iche nọ n'azụ otu IP na-ekerịta oke a.

  • Ịgafe oke a na-eweghachi HTTP 429 ma gbochie imepụta adreesị ruo sekọnd 10. Chere oge Retry-After kwuru tupu ịnwaa ọzọ. Ọ bụrụ na isi ahụ adịghị, chere opekata mpe sekọnd 10, wee nwaa ọzọ na-agbatị oge nchere. Zere nnwaghachi n'otu oge site n'aka ndị ahịa na-ekerịta otu IP.

  • Iwu a anaghị emetụta ndepụta igbe mbata ma ọ bụ ịgụ otu ozi-e. Oke kwa ụbọchị na ngụkọta nke igodo API ka na-arụ ọrụ iche. Ichere sekọnd 10 anaghị eweghachi oke igodo agwụla.

Isi endpoints

POST / GET
/api/generate-email

Mepụta igbe ozi nwa oge. Jiri GET maka usoro kacha mfe nke igbe ozi ọ bụla, ma ọ bụ POST na prefix na domain mgbe ịchọrọ njikwa doro anya.

GET
/api/emails?email=...

Weta ozi-e maka igbe ozi.

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

Weta otu ozi-e, gụnyere ederede, HTML, isi okwu ndị nyere, na metadata.

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

Hichapụ otu ozi-e site na ID.

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

Hichapụ ozi-e niile na igbe ozi.

GET
/api/stats

Gụọ ọrụ ọgụgụ isi nke saịtị niile.

Ọmụmaatụ ọdịdị

N'okpuru ebe a e nwere usoro abụọ a na-ahụkarị: hapụ ọrụ ka ọ mepụta igbe, ma ọ bụ rịọ prefix ejikọtara ọnụ. Ọ bụrụ na ị ma domain akwadoro ugbu a, ị nwekwara ike ịmepụta igbe n'ụlọ ma jụọ ozugbo.

1) Mepụta adreesị ozi-e nwa oge nke ọ bụla

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Ọmụmaatụ nzaghachi
{
  "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) Mepụta na prefix ejikọtara ọnụ (dị ka 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"}'
Ọmụmaatụ nzaghachi
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Ndepụta ozi-e n'igbe

Ọ bụrụ na ị maralarị ngalaba a na-akwado, gafee nzọụkwụ 1 ma jụọ ozugbo.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Ọmụmaatụ nzaghachi
{
  "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) Gụọ otu ozi-e — gụnyere ederede dị mfe, ahụ HTML, na metadata

Dochie EMAIL_ID na id e nwetara na nzọụkwụ 3. Zipukwa adreesị igbe mbata dịka email (ọbụna maka nhichapụ na nbudata mgbakwunye): mgbe ahụ a na-agụ ozi-e ahụ ozugbo site n'igbe mbata ya kama ịchọ ya site na ID. Site na igodo API, paramita email bụ nhọrọ, mana iziga ya na-eme ka ọchụchọ dị ngwa.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Ọmụmaatụ nzaghachi
{
  "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) Hichapụ otu ozi-e site na ID

Site na igodo API, paramita email bụ nhọrọ, mana iziga ya na-eme ka ọchụchọ dị ngwa.

curl -X DELETE 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Ọmụmaatụ nzaghachi
{
  "success": true,
  "data": {
    "message": "Email deleted"
  }
}

6) Hichapụ igbe niile — hichapụ ozi-e niile maka adreesị a

Oku ọ bụla na-ehichapụ otu ogbe. Ọ bụrụhaala na nzaghachi nwere "has_more": true, kpọọ ya ọzọ ruo mgbe ọ ga-alaghachi false.

curl -X DELETE 'https://mail.chatgpt.org.uk/api/emails/clear?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Ọmụmaatụ nzaghachi
{
  "success": true,
  "data": {
    "message": "Deleted 3 emails",
    "count": 3,
    "has_more": false
  }
}

Ụdị nzaghachi

Nzaghachi nke ọma na-adịkarị otú a. Ọ bụrụ na ị nyochaa site na API Key, lee anya na ozi quota n'ime 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
  }
}

Ọgụgụ ndị ogologo oge

  • /api/statistics/24h na-eweghachi otu windo nkesa kwa awa nke awa 24; jiri offset=1,2,... maka windo ochie.
  • /api/statistics/top-subjects na-eweghachi isiokwu ozi-e a na-ahụkarị.
  • /api/statistics/top-domains na-egosi ngalaba a na-arụ ọrụ kachasị.
  • /api/statistics/top-senders na-egosi ndị ozi-e kacha arụ ọrụ.
GPTMail