Documentação API

API GPTMail

Use a API do GPTMail para gerar caixas de entrada temporárias, listar e ler mensagens e excluir e-mails via HTTPS com o cabeçalho X-API-Key. Ela é ideal para testes automatizados, pipelines de CI/CD e fluxos de QA.

Como obter uma 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

Opção 2: Adicionar seu próprio domínio

Após a verificação MX de um domínio público: enviado sem entrar na conta → chave API (20000 solicitações); enviado com a conta conectada → 200 pontos. Cada domínio recebe apenas uma recompensa. Importante: após a conexão, esse sufixo de domínio torna-se público para todos os usuários do site, e outros também podem gerar endereços de caixa sob ele. Após a ativação, não exclua, substitua nem altere o registro MX que aponta este domínio para nosso serviço. Caso contrário, verificações posteriores podem considerar o domínio mal configurado. Se uma verificação posterior encontrar o MX inválido, o domínio será desativado. Se o MX permanecer inválido por 3 verificações consecutivas, a API Key associada também será desativada. Se o MX voltar a ser válido depois, o domínio será reativado automaticamente.

Domínios

Chave pública de teste

Para testes, envie a chave pública compartilhada mostrada abaixo no cabeçalho X-API-Key. Ela muda todos os dias e tem um limite diário de 200.000 solicitações compartilhado por todos os usuários.

Restante hoje

Redefine em

Carregando cota ao vivo da chave pública…

A referência da API abaixo pode ser copiada como Markdown para ferramentas de IA, bases de conhecimento ou um README.

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

AI
llms.txt

·

llms-full.txt

(Markdown)

Início rápido

  • X-API-Key: YOUR_KEY é a opção mais simples. Para testes rápidos, use a chave pública diária mostrada acima no lugar de YOUR_KEY.

  • A maioria dos endpoints de caixa exige o parâmetro email, por exemplo ?email=demo@example.com.

  • As respostas da API do GPTMail usam JSON com os campos success, data e error, além de usage quando uma chave de API é usada. Erros da Cloudflare, incluindo respostas de limite de taxa, podem retornar HTML. Verifique o status HTTP e o Content-Type antes de analisar o JSON.

  • Se você já souber um domínio atualmente suportado neste site, não precisa chamar primeiro o endpoint de geração de email. Monte prefix@domain localmente e chame as APIs de caixa diretamente, economizando uma requisição.

Limites de taxa e novas tentativas

  • GET e POST /api/generate-email compartilham um limite de 30 solicitações a cada 10 segundos por IP de origem. Isso vale tanto para chaves de API públicas quanto pessoais. Chaves e clientes diferentes atrás do mesmo IP compartilham esse limite.

  • Exceder esse limite retorna HTTP 429 e bloqueia a geração de e-mails por 10 segundos. Aguarde o tempo indicado em Retry-After antes de tentar de novo. Se esse cabeçalho não vier, aguarde pelo menos 10 segundos e tente novamente com intervalos crescentes. Evite novas tentativas simultâneas de clientes que compartilham um IP.

  • Esta regra não se aplica à listagem da caixa de entrada nem à leitura de e-mails individuais. As cotas diárias e totais das chaves de API continuam valendo de forma independente. Aguardar 10 segundos não restaura uma cota de chave esgotada.

Endpoints principais

POST / GET
/api/generate-email

Gera uma caixa de entrada temporária. Use GET para o fluxo aleatório mais simples, ou POST com prefix e domain quando quiser controle explícito.

GET
/api/emails?email=...

Busca os emails de uma caixa de correio.

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

Busca um único email, incluindo texto, HTML, cabeçalhos brutos e metadados.

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

Exclui um email pelo ID.

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

Exclui todos os emails de uma caixa de correio.

GET
/api/stats

Lê estatísticas de todo o site.

Fluxo de exemplo

Dois padrões comuns: deixar o serviço gerar uma caixa de entrada ou solicitar um prefixo fixo. Se você já souber um domínio atualmente suportado, também pode montar a caixa localmente e consultá-la diretamente.

1) Gerar um endereço de email temporário aleatório

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) Gerar com prefixo fixo (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 emails em uma caixa de entrada

Se você já souber um domínio suportado, pule o passo 1 e consulte diretamente.

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 um único email — inclui texto simples, corpo HTML e metadados

Substitua EMAIL_ID por um id retornado no passo 3. Passe também o endereço da caixa de entrada como email (inclusive para exclusões e downloads de anexos): assim o e-mail é lido diretamente da caixa de entrada, em vez de ser procurado pelo ID. Com uma chave de API, o parâmetro email é opcional, mas enviá-lo torna a busca mais 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) Excluir um único email por ID

Com uma chave de API, o parâmetro email é opcional, mas enviá-lo torna a busca mais 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) Esvaziar toda a caixa — exclui todos os emails deste endereço

Cada chamada exclui um lote. Enquanto a resposta tiver "has_more": true, chame novamente até que retorne 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
  }
}

Formato da resposta

Respostas bem-sucedidas costumam ter esta forma. Se você autenticar com uma API Key, observe as informações de cota em 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 estendidas

  • /api/statistics/24h retorna uma janela de distribuição horária de 24 horas; use offset=1,2,... para janelas anteriores.
  • /api/statistics/top-subjects retorna os assuntos de e-mail mais frequentes.
  • /api/statistics/top-domains retorna os domínios mais ativos.
  • /api/statistics/top-senders retorna os remetentes mais ativos.
GPTMail