API-dokumentasjon

GPTMail API

Bruk GPTMail API til å opprette midlertidige innbokser, liste opp og lese meldinger og slette e-post over HTTPS med en X-API-Key-header. Passer for automatiserte tester, CI/CD-pipelines og QA-arbeidsflyter.

Slik skaffer du en 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

Alternativ 2: Legg til ditt eget domene

Når et offentlig domene består MX-kontrollen: sendt inn uten innlogging → API-nøkkel (20000 forespørsler); sendt inn som innlogget → 200 poeng. Hvert domene får bare én belønning. Viktig: når det er koblet til, blir domenesuffikset et offentlig suffiks for alle brukere her, så andre kan også opprette adresser under det. Etter aktivering — ikke slett, bytt ut eller endre MX-posten som peker domenet til vår tjeneste, ellers kan senere sjekker anse domenet som feilkonfigurert. Finner en senere sjekk at MX er ugyldig, deaktiveres domenet. Forblir MX ugyldig ved 3 sjekker på rad, deaktiveres også den tilknyttede API Key. Blir MX gyldig igjen, reaktiveres domenet automatisk.

Domener

Offentlig testnøkkel

For testing sender du den delte offentlige nøkkelen som vises nedenfor, i headeren X-API-Key. Den byttes ut hver dag og har en daglig grense på 200 000 forespørsler som deles av alle brukere.

Gjenstår i dag

Nullstilles om

Laster live-kvote for den offentlige nøkkelen...

API-referansen nedenfor kan kopieres som Markdown for AI-verktøy, kunnskapsbaser eller en README.

Base-URL: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Rask start

  • X-API-Key: YOUR_KEY er det enkleste alternativet. For raske tester kan du bruke den daglige offentlige nøkkelen som vises ovenfor, i stedet for YOUR_KEY.

  • De fleste postkasse-endepunktene krever parameteren email, f.eks. ?email=demo@example.com.

  • Svar fra GPTMail API bruker JSON med feltene success, data og error, samt usage når en API-nøkkel brukes. Cloudflare-feil, også svar ved hastighetsgrenser, kan i stedet returnere HTML. Sjekk HTTP-statusen og Content-Type før du tolker JSON.

  • Kjenner du allerede et støttet domene på dette nettstedet, trenger du ikke kalle genererings-endepunktet først. Du kan sette sammen prefix@domain lokalt og kalle postkasse-API-ene direkte — du sparer ett kall.

Hastighetsgrenser og nye forsøk

  • GET og POST /api/generate-email deler en grense på 30 forespørsler per 10 sekunder per kilde-IP. Dette gjelder både offentlige og personlige API-nøkler. Ulike nøkler og klienter bak samme IP deler denne grensen.

  • Overskrides grensen, returneres HTTP 429, og generering av e-postadresser blokkeres i 10 sekunder. Vent like lenge som Retry-After angir før du prøver igjen. Mangler denne headeren, venter du minst 10 sekunder og prøver deretter igjen med økende ventetid. Unngå samtidige nye forsøk fra klienter som deler en IP.

  • Denne regelen gjelder ikke for visning av innboksen eller lesing av enkeltstående e-poster. Daglige og samlede kvoter for API-nøkler gjelder fortsatt uavhengig av dette. Å vente 10 sekunder gjenoppretter ikke en oppbrukt nøkkelkvote.

Kjerne-endepunkter

POST / GET
/api/generate-email

Opprett en midlertidig innboks. Bruk GET for den enkleste tilfeldige flyten, eller POST med prefix og domain når du vil ha eksplisitt kontroll.

GET
/api/emails?email=...

Hent e-poster for en postkasse.

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

Hent én e-post med tekst, HTML, rå headere og metadata.

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

Slett én e-post etter ID.

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

Slett alle e-poster i en postkasse.

GET
/api/stats

Les statistikk for hele nettstedet.

Eksempelflyt

Under finner du to vanlige mønstre: la tjenesten generere en innboks for deg, eller be om et fast prefiks. Kjenner du allerede et støttet domene, kan du også sette sammen adressen lokalt og spørre direkte.

1) Generer en tilfeldig midlertidig e-postadresse

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Eksempel på svar
{
  "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) Generer med fast prefiks (f.eks. 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"}'
Eksempel på svar
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) List e-poster i en innboks

Kjenner du allerede et støttet domene, hopp over trinn 1 og spør direkte.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Eksempel på svar
{
  "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) Les én e-post — inkluderer ren tekst, HTML-kropp og metadata

Erstatt EMAIL_ID med en id fra trinn 3. Send også innboksadressen som email (også ved sletting og nedlasting av vedlegg): da leses e-posten direkte fra innboksen i stedet for å søkes opp etter ID. Med en API-nøkkel er parameteren email valgfri, men å sende den gjør oppslaget raskere.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Eksempel på svar
{
  "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) Slett én e-post etter ID

Med en API-nøkkel er parameteren email valgfri, men å sende den gjør oppslaget raskere.

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

6) Tøm hele innboksen — sletter alle e-poster for denne adressen

Hvert kall sletter én bunke. Så lenge svaret har "has_more": true, kall det igjen til det returnerer false.

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

Svarsform

Vellykkede svar ser vanligvis slik ut. Med API Key — se kvoteinformasjonen i 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
  }
}

Utvidet statistikk

  • /api/statistics/24h returnerer ett 24-timers vindu med fordeling per time; bruk offset=1,2,... for eldre vinduer.
  • /api/statistics/top-subjects returnerer de vanligste emnefeltene.
  • /api/statistics/top-domains returnerer de mest aktive domenene.
  • /api/statistics/top-senders returnerer de mest aktive avsenderne.
GPTMail