Documentació de l'API

API GPTMail

Utilitzeu l'API de GPTMail per generar safates temporals, llistar i llegir missatges i eliminar correu a través d'HTTPS amb una capçalera X-API-Key. És adequada per a proves automatitzades, pipelines de CI/CD i fluxos de QA.

Com obtenir una 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

Opció 2: Afegeix el teu propi domini

Quan un domini públic supera la verificació MX: enviat sense iniciar sessió → clau API (20000 sol·licituds); enviat amb la sessió iniciada → 200 punts. Cada domini rep una sola recompensa. Important: un cop connectat, aquest sufix de domini esdevé un sufix públic per a tots els usuaris d'aquest lloc, de manera que altres usuaris també poden generar adreces de bústia sota ell. Després de l'activació, no suprimeixis, substitueixis ni modifiquis el registre MX que apunta aquest domini al nostre servei. En cas contrari, comprovacions posteriors poden considerar el domini mal configurat. Si una comprovació posterior troba el registre MX invàlid, el domini es desactivarà. Si el registre MX continua invàlid durant 3 comprovacions consecutives, l'API Key associada també es desactivarà. Si el registre MX torna a ser vàlid més endavant, el domini es reactivarà automàticament.

Dominis

Clau pública de proves

Per fer proves, envieu la clau pública compartida que es mostra a continuació a la capçalera X-API-Key. Canvia cada dia i té un límit diari de 200.000 sol·licituds compartit entre tots els usuaris.

Restant avui

Es restableix en

Carregant la quota en viu de la clau pública...

La referència API següent es pot copiar com a Markdown per a eines d'IA, bases de coneixement o un README.

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

AI
llms.txt

·

llms-full.txt

(Markdown)

Inici ràpid

  • X-API-Key: YOUR_KEY és l'opció més senzilla. Per a proves ràpides, utilitzeu la clau pública diària que es mostra més amunt en lloc de YOUR_KEY.

  • La majoria d'endpoints de bústia requereixen un paràmetre email, per exemple ?email=demo@example.com.

  • Les respostes de l'API de GPTMail fan servir JSON amb els camps success, data i error, a més de usage quan s'utilitza una clau d'API. Els errors de Cloudflare, incloses les respostes per límit de freqüència, poden retornar HTML. Comproveu l'estat HTTP i el Content-Type abans d'analitzar el JSON.

  • Si ja coneixes un domini compatible actualment en aquest lloc, no cal que cridis primer l'endpoint de generació de correu. Pots compondre prefix@domain en local i cridar directament les API de bústia, cosa que estalvia una API request.

Límits de freqüència i reintents

  • GET i POST /api/generate-email comparteixen un límit de 30 sol·licituds cada 10 segons per IP d'origen. S'aplica tant a les claus d'API públiques com a les personals. Diferents claus i clients darrere de la mateixa IP comparteixen aquest límit.

  • Superar aquest límit retorna HTTP 429 i bloqueja la generació d'adreces durant 10 segons. Espereu el temps indicat a Retry-After abans de tornar-ho a provar. Si aquesta capçalera no hi és, espereu almenys 10 segons i torneu-ho a provar amb intervals cada vegada més llargs. Eviteu reintents simultanis des de clients que comparteixen una IP.

  • Aquesta regla no s'aplica a llistar la safata ni a llegir correus individuals. Les quotes diàries i totals de les claus d'API continuen aplicant-se de manera independent. Esperar 10 segons no restableix la quota esgotada d'una clau.

Endpoints principals

POST / GET
/api/generate-email

Genera una bústia temporal. Utilitza GET per al flux de bústia aleatòria més simple, o POST amb prefix i domain quan vulguis control explícit.

GET
/api/emails?email=...

Obté els correus d'una bústia.

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

Obté un sol correu, incloent-hi text, HTML, capçaleres en brut i metadades.

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

Suprimeix un correu per ID.

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

Suprimeix tots els correus d'una bústia.

GET
/api/stats

Llegeix estadístiques de tot el lloc.

Flux d'exemple

A continuació hi ha dos patrons habituals: deixa que el servei generi una bústia per a tu, o sol·licita un prefix fix. Si ja coneixes un domini compatible actualment, també pots compondre la bústia en local i consultar-la directament.

1) Genera una adreça de correu temporal aleatòria

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Exemple de resposta
{
  "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) Genera amb prefix fix (p. ex. 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"}'
Exemple de resposta
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Llista els correus d'una bústia

Si ja coneixes un domini compatible, omet el pas 1 i consulta directament.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Exemple de resposta
{
  "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) Llegeix un sol correu — inclou text pla, cos HTML i metadades

Substituïu EMAIL_ID per un id retornat al pas 3. Passeu també l'adreça de la safata com a email (també per eliminar i per baixar adjunts): així el correu es llegeix directament de la seva safata en lloc de cercar-lo per ID. Amb una clau d'API el paràmetre email és opcional, però enviar-lo fa que la cerca sigui més ràpida.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Exemple de resposta
{
  "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) Suprimeix un correu per ID

Amb una clau d'API el paràmetre email és opcional, però enviar-lo fa que la cerca sigui més ràpida.

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

6) Buida tota la bústia — suprimeix tots els correus d'aquesta adreça

Cada crida suprimeix un lot. Mentre la resposta contingui "has_more": true, torneu-la a fer fins que retorni false.

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

Forma de la resposta

Les respostes correctes solen tenir aquest aspecte. Si t'autentiques amb una API Key, fixa't en la informació de quota dins de 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
  }
}

Estadístiques ampliades

  • /api/statistics/24h retorna una finestra de 24 hores amb la distribució per hores; utilitzeu offset=1,2,... per a finestres anteriors.
  • /api/statistics/top-subjects retorna els assumptes de correu més freqüents.
  • /api/statistics/top-domains retorna els dominis més actius.
  • /api/statistics/top-senders retorna els remitents més actius.
GPTMail