Documentación API

API de GPTMail

Usa a API de GPTMail para xerar caixas de entrada temporais, listar e ler mensaxes e eliminar correo a través de HTTPS cunha cabeceira X-API-Key. É axeitada para probas automatizadas, fluxos CI/CD e procesos de QA.

Como obter unha 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ón 2: Engade o teu propio dominio

Cando un dominio público supera a verificación MX: enviado sen iniciar sesión → chave API (20000 solicitudes); enviado coa sesión iniciada → 200 puntos. Cada dominio recibe unha soa recompensa. Importante: unha vez conectado, ese sufixo de dominio convértese nun sufixo público para todos os usuarios deste sitio, así que outros usuarios tamén poden xerar enderezos de caixa baixo el. Tras a activación, non elimines, substituas nin modifiques o rexistro MX que apunta este dominio ao noso servizo. Se non, comprobacións posteriores poden considerar o dominio mal configurado. Se unha comprobación posterior atopa o rexistro MX inválido, o dominio desactivarase. Se o rexistro MX segue inválido durante 3 comprobacións consecutivas, a API Key asociada tamén se desactivará. Se o rexistro MX volve ser válido máis tarde, o dominio reactivarase automaticamente.

Dominios

Chave pública de proba

Para probas, envía a chave pública compartida que se mostra abaixo na cabeceira X-API-Key. Cambia cada día e ten un límite diario de 200.000 solicitudes compartido por todas as persoas usuarias.

Restante hoxe

Restablece en

Cargando cota en vivo da chave pública...

A referencia API de abixo pódese copiar como Markdown para ferramentas de IA, bases de coñecemento ou un README.

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

AI
llms.txt

·

llms-full.txt

(Markdown)

Inicio rápido

  • X-API-Key: YOUR_KEY é a opción máis sinxela. Para probas rápidas, usa a chave pública diaria que aparece arriba en lugar de YOUR_KEY.

  • A maioría dos endpoints de caixa requiren un parámetro email, por exemplo ?email=demo@example.com.

  • As respostas da API de GPTMail usan JSON cos campos success, data e error, ademais de usage cando se usa unha chave da API. Os erros de Cloudflare, incluídas as respostas por límite de frecuencia, poden devolver HTML no seu lugar. Comproba o estado HTTP e o Content-Type antes de analizar o JSON.

  • Se xa coñeces un dominio admitido neste sitio, non tes que chamar primeiro ao endpoint de xeración de correo. Podes compoñer prefix@domain en local e chamar directamente ás API de caixa, o que aforra unha API request.

Límites de frecuencia e reintentos

  • GET e POST /api/generate-email comparten un límite de 30 solicitudes cada 10 segundos por IP de orixe. Aplícase tanto ás chaves da API públicas como ás persoais. As distintas chaves e clientes detrás da mesma IP comparten este límite.

  • Se se supera este límite, devólvese HTTP 429 e bloquéase a xeración de correos durante 10 segundos. Agarda o tempo indicado en Retry-After antes de tentalo de novo. Se esta cabeceira non está presente, agarda polo menos 10 segundos e despois reinténtao con intervalos cada vez maiores. Evita reintentos simultáneos desde clientes que comparten unha IP.

  • Esta regra non se aplica á listaxe da caixa de entrada nin á lectura de correos individuais. As cotas diarias e totais das chaves da API seguen aplicándose de forma independente. Agardar 10 segundos non restablece a cota esgotada dunha chave.

Endpoints principais

POST / GET
/api/generate-email

Xera unha caixa de entrada temporal. Usa GET para o fluxo aleatorio máis simple, ou POST con prefix e domain cando queiras control explícito.

GET
/api/emails?email=...

Obter correos dunha caixa.

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

Obter un só correo, incluíndo texto, HTML, cabeceiras en bruto e metadatos.

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

Eliminar un correo por ID.

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

Eliminar todos os correos dunha caixa.

GET
/api/stats

Ler estatísticas de todo o sitio.

Fluxo de exemplo

Abaixo hai dous patróns habituais: deixa que o servizo xere unha caixa para ti, ou solicita un prefixo fixo. Se xa coñeces un dominio admitido actualmente, tamén podes compoñer a caixa en local e consultala directamente.

1) Xerar un enderezo de correo temporal aleatorio

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

3) Listar correos nunha caixa de entrada

Se xa coñeces un dominio admitido, omite o paso 1 e consulta directamente.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Exemplo 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) Ler un só correo — inclúe texto plano, corpo HTML e metadatos

Substitúe EMAIL_ID por un id devolto no paso 3. Pasa tamén o enderezo da caixa como email (tamén para eliminar e descargar anexos): así o correo lese directamente da súa caixa en vez de buscarse por ID. Cunha chave API o parámetro email é opcional, pero envialo fai que a busca sexa máis rápida.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Exemplo 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) Eliminar un correo por ID

Cunha chave API o parámetro email é opcional, pero envialo fai que a busca sexa máis 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'
Exemplo de resposta
{
  "success": true,
  "data": {
    "message": "Email deleted"
  }
}

6) Baleirar toda a caixa — elimina todos os correos deste enderezo

Cada chamada elimina un lote. Mentres a resposta inclúa "has_more": true, volve chamala ata que devolva false.

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

Forma da resposta

As respostas correctas adoitan verse así. Se te autenticas cunha API Key, presta atención á información de cota dentro 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
  }
}

Estatísticas ampliadas

  • /api/statistics/24h devolve unha xanela de distribución horaria de 24 horas; usa offset=1,2,... para xanelas anteriores.
  • /api/statistics/top-subjects devolve os asuntos de correo máis frecuentes.
  • /api/statistics/top-domains devolve os dominios máis activos.
  • /api/statistics/top-senders devolve os remitentes máis activos.
GPTMail