API-dokumentation

GPTMail API

Brug GPTMail API'et til at oprette midlertidige indbakker, vise og læse beskeder og slette post via HTTPS med en X-API-Key-header. Det er velegnet til automatiserede tests, CI/CD-pipelines og QA-arbejdsgange.

Sådan får 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

Mulighed 2: Tilføj dit eget domæne

Når et offentligt domæne består MX-kontrollen: indsendt uden login → API-nøgle (20000 anmodninger); indsendt som logget ind → 200 point. Hvert domæne får kun én belønning. Vigtigt: når det er tilkoblet, bliver domænesuffikset et offentligt suffiks for alle brugere her, så andre også kan oprette adresser under det. Efter aktivering må du ikke slette, erstatte eller ændre MX-posten, der peger domænet til vores service — ellers kan senere tjek betragte domænet som fejlkonfigureret. Finder et senere tjek MX ugyldig, deaktiveres domænet. Forbliver MX ugyldig ved 3 tjek i træk, deaktiveres også den tilknyttede API Key. Bliver MX gyldig igen, genaktiveres domænet automatisk.

Domæner

Offentlig testnøgle

Til test skal du sende den delte offentlige nøgle, der vises nedenfor, i headeren X-API-Key. Den skifter hver dag og har en daglig grænse på 200.000 anmodninger, som deles af alle brugere.

Resterende i dag

Nulstilles om

Indlæser live-kvote for den offentlige nøgle...

API-referencen nedenfor kan kopieres som Markdown til AI-værktøjer, vidensbaser eller en README.

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

AI
llms.txt

·

llms-full.txt

(Markdown)

Hurtig start

  • X-API-Key: YOUR_KEY er den enkleste mulighed. Til hurtige tests kan du bruge den daglige offentlige nøgle, der vises ovenfor, i stedet for YOUR_KEY.

  • De fleste postkasse-endpoints kræver parameteren email, f.eks. ?email=demo@example.com.

  • GPTMail API-svar bruger JSON med felterne success, data og error samt usage, når der bruges en API-nøgle. Cloudflare-fejl, herunder svar om hastighedsgrænser, kan i stedet returnere HTML. Tjek HTTP-status og Content-Type, før du parser JSON.

  • Kender du allerede et understøttet domæne på dette site, behøver du ikke kalde genererings-endpointet først. Du kan sammensætte prefix@domain lokalt og kalde postkasse-API'erne direkte — det sparer ét kald.

Hastighedsgrænser og genforsøg

  • GET og POST /api/generate-email deler en grænse på 30 anmodninger pr. 10 sekunder pr. kilde-IP. Det gælder både offentlige og personlige API-nøgler. Forskellige nøgler og klienter bag samme IP deler denne grænse.

  • Overskridelse af denne grænse returnerer HTTP 429 og blokerer oprettelse af e-mails i 10 sekunder. Vent den tid, Retry-After angiver, før du prøver igen. Hvis headeren mangler, så vent mindst 10 sekunder, og prøv derefter igen med stigende pauser. Undgå samtidige genforsøg fra klienter, der deler en IP.

  • Denne regel gælder ikke for visning af indbakken eller læsning af enkelte e-mails. API-nøglers daglige og samlede kvoter gælder stadig uafhængigt. At vente 10 sekunder genopretter ikke en opbrugt nøglekvote.

Kerne-endpoints

POST / GET
/api/generate-email

Opret en midlertidig indbakke. Brug GET til den simpleste tilfældige flow, eller POST med prefix og domain, når du vil styre det eksplicit.

GET
/api/emails?email=...

Hent e-mails til en postkasse.

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

Hent en enkelt e-mail med tekst, HTML, rå headers og metadata.

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

Slet én e-mail efter ID.

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

Slet alle e-mails i en postkasse.

GET
/api/stats

Læs statistik for hele sitet.

Eksempelflow

Her er to almindelige mønstre: lad tjenesten oprette en indbakke til dig, eller anmod om et fast præfiks. Kender du allerede et understøttet domæne, kan du også sammensætte adressen lokalt og forespørge direkte.

1) Generér en tilfældig midlertidig e-mailadresse

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) Generér med fast præfiks (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-mails i en indbakke

Kender du allerede et understøttet domæne, spring trin 1 over og forespørg 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) Læs én e-mail — inkl. ren tekst, HTML-krop og metadata

Erstat EMAIL_ID med et id, der blev returneret i trin 3. Send også indbakkens adresse som email (også ved sletning og download af vedhæftede filer): Så læses e-mailen direkte fra dens indbakke i stedet for at blive søgt frem via id. Med en API-nøgle er email-parameteren valgfri, men hvis du sender den, går opslaget hurtigere.

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) Slet én e-mail efter ID

Med en API-nøgle er email-parameteren valgfri, men hvis du sender den, går opslaget hurtigere.

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 indbakken — sletter alle e-mails for denne adresse

Hvert kald sletter én batch. Så længe svaret indeholder "has_more": true, skal du kalde igen, indtil 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 typisk sådan ud. Med API Key — vær opmærksom på kvoteinfo 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
  }
}

Udvidet statistik

  • /api/statistics/24h returnerer ét 24-timers vindue med fordelingen pr. time; brug offset=1,2,... for ældre vinduer.
  • /api/statistics/top-subjects returnerer de hyppigste emnelinjer.
  • /api/statistics/top-domains returnerer de mest aktive domæner.
  • /api/statistics/top-senders returnerer de mest aktive afsendere.
GPTMail