API-dokumentation

GPTMail API

Använd GPTMail API för att skapa tillfälliga inkorgar, lista och läsa meddelanden och radera e-post över HTTPS med en X-API-Key-header. Det passar automatiserade tester, CI/CD-pipelines och QA-flöden.

Så skaffar 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: Lägg till egen domän

När en offentlig domän klarar MX-kontrollen: inskickad utan inloggning → API-nyckel (20000 förfrågningar); inskickad som inloggad → 200 poäng. Varje domän får bara en belöning. Viktigt: när den är kopplad blir domänsuffixet ett publikt suffix för alla användare här, så andra kan också skapa adresser under det. Efter aktivering — ta inte bort, byt inte ut och ändra inte MX-posten som pekar domänen till vår tjänst, annars kan senare kontroller se domänen som felkonfigurerad. Om MX bedöms ogiltig inaktiveras domänen. Om MX förblir ogiltig vid 3 kontroller i rad inaktiveras även den kopplade API Key. Blir MX giltig igen aktiveras domänen automatiskt.

Domäner

Offentlig testnyckel

För tester skickar du den delade offentliga nyckeln som visas nedan i headern X-API-Key. Den byts varje dag och har en daglig gräns på 200 000 förfrågningar som delas av alla användare.

Kvar idag

Återställs om

Laddar aktuell kvot för den publika nyckeln...

API-referensen nedan kan kopieras som Markdown för AI-verktyg, kunskapsbaser eller en README.

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

AI
llms.txt

·

llms-full.txt

(Markdown)

Snabbstart

  • X-API-Key: YOUR_KEY är det enklaste alternativet. För snabba tester använder du den dagliga offentliga nyckeln som visas ovan i stället för YOUR_KEY.

  • De flesta brevlåde-endpoints kräver parametern email, t.ex. ?email=demo@example.com.

  • Svaren från GPTMail API är JSON med fälten success, data och error, samt usage när en API-nyckel används. Fel från Cloudflare, även svar när hastighetsgränsen nåtts, kan i stället returnera HTML. Kontrollera HTTP-status och Content-Type innan du tolkar JSON.

  • Om du redan känner till en domän som stöds behöver du inte anropa genererings-endpointen först. Du kan sätta ihop prefix@domain lokalt och anropa brevlåde-API:erna direkt — du sparar ett anrop.

Hastighetsgränser och nya försök

  • GET och POST /api/generate-email delar en gräns på 30 förfrågningar per 10 sekunder och käll-IP. Det gäller både offentliga och personliga API-nycklar. Olika nycklar och klienter bakom samma IP delar på gränsen.

  • Om gränsen överskrids returneras HTTP 429 och adressgenereringen blockeras i 10 sekunder. Vänta den tid som anges i Retry-After innan du försöker igen. Om headern saknas väntar du minst 10 sekunder och försöker sedan igen med allt längre intervall. Undvik samtidiga nya försök från klienter som delar en IP-adress.

  • Regeln gäller inte för att lista meddelanden i en inkorg eller läsa enskilda meddelanden. API-nyckelns dagliga och totala kvoter gäller fortfarande separat. Att vänta 10 sekunder återställer inte en förbrukad nyckelkvot.

Kärn-endpoints

POST / GET
/api/generate-email

Skapa en tillfällig inkorg. Använd GET för det enklaste slumpmässiga flödet, eller POST med prefix och domain när du vill ha full kontroll.

GET
/api/emails?email=...

Hämta e-post för en brevlåda.

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

Hämta ett enskilt meddelande med text, HTML, råa rubriker och metadata.

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

Ta bort ett meddelande med ID.

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

Ta bort alla meddelanden i en brevlåda.

GET
/api/stats

Läs webbplatsövergripande statistik.

Exempelflöde

Här är två vanliga mönster: låt tjänsten skapa en inkorg åt dig, eller begär ett fast prefix. Om du redan känner till en domän som stöds kan du också sätta ihop adressen lokalt och fråga direkt.

1) Generera en slumpmässig tillfällig e-postadress

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

3) Lista meddelanden i en inkorg

Om du redan känner till en domän som stöds, hoppa över steg 1 och fråga direkt.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Exempelsvar
{
  "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 ett meddelande — inkluderar ren text, HTML-kropp och metadata

Ersätt EMAIL_ID med ett id som returnerades i steg 3. Skicka också inkorgens adress som email (även vid radering och nedladdning av bilagor): då läses meddelandet direkt från sin inkorg i stället för att sökas upp via ID. Med en API-nyckel är parametern email valfri, men om du skickar den går sökningen snabbare.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Exempelsvar
{
  "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) Ta bort ett meddelande med ID

Med en API-nyckel är parametern email valfri, men om du skickar den går sökningen snabbare.

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

6) Töm hela inkorgen — tar bort alla meddelanden för denna adress

Varje anrop raderar en omgång. Så länge svaret innehåller "has_more": true, anropa igen tills det returnerar false.

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

Svarsform

Lyckade svar ser oftast ut så här. Med API Key — titta på kvotinformationen 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
  }
}

Utökad statistik

  • /api/statistics/24h returnerar ett 24-timmarsfönster med fördelning per timme; använd offset=1,2,... för äldre fönster.
  • /api/statistics/top-subjects returnerar de vanligaste ämnesraderna.
  • /api/statistics/top-domains returnerar mest aktiva domäner.
  • /api/statistics/top-senders returnerar mest aktiva avsändare.
GPTMail