APIドキュメント

GPTMail API

GPTMail API を使うと、X-API-Key ヘッダーを付けた HTTPS リクエストで、一時的な受信トレイの生成、メッセージの一覧取得と読み取り、メールの削除ができます。自動テスト、CI/CD パイプライン、QA ワークフローに適しています。

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

方法 2：独自ドメインを追加

公開ドメインの MX 検証後：未ログインで申請 → API キー（20000 リクエスト）；ログインして申請 → 200 ポイント。各ドメインの特典はどちらか一つのみです。 重要：接続後、そのドメインのサフィックスは本サイトの全ユーザーに公開されるサフィックスとなり、他のユーザーもその下でメールアドレスを生成できます。有効化後、当サービスを指す MX レコードを削除・差し替え・変更しないでください。さもないと、後続のチェックでドメインが誤設定とみなされることがあります。後のチェックで MX が無効と判定された場合、ドメインは無効化されます。MX が 3 回連続で無効のままだと、関連する API Key も無効化されます。後から MX が再び有効になれば、ドメインは自動的に再有効化されます。

ドメイン

公開テストキー

テストには、下に表示されている共有の公開キーを X-API-Key ヘッダーで送信してください。このキーは毎日変わり、全ユーザー共通で 1 日 200,000 リクエストの上限があります。

本日の残り

リセットまで

公開キーのリアルタイム枠を読み込み中…

以下の API リファレンスは Markdown としてコピーでき、AI ツール、ナレッジベース、README などに使えます。

ベースURL: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

クイックスタート

  • X-API-Key: YOUR_KEY が最も簡単な方法です。手軽なテストには、YOUR_KEY の代わりに上に表示されている日替わりの公開キーを使用してください。

  • 多くのメールボックス系エンドポイントでは email パラメータが必要です。例：?email=demo@example.com。

  • GPTMail API の応答は JSON 形式で、success、data、error の各フィールドを含み、API キーを使用した場合は usage も含まれます。Cloudflare のエラー（レート制限の応答を含む）は、代わりに HTML を返すことがあります。JSON を解析する前に HTTP ステータスと Content-Type を確認してください。

  • 本サイトで現在サポートされているドメインが分かっていれば、メール生成エンドポイントを先に呼ぶ必要はありません。ローカルで prefix@domain を組み立て、メールボックス API を直接呼べば API リクエストを 1 回節約できます。

レート制限と再試行

  • GET と POST /api/generate-email は、送信元 IP ごとに 10 秒あたり 30 リクエストの制限を共有します。これは公開キーと個人キーの両方に適用されます。同じ IP の背後にある異なるキーやクライアントも、この制限を共有します。

  • この制限を超えると HTTP 429 が返され、メール生成が 10 秒間ブロックされます。Retry-After で示された時間待ってから再試行してください。このヘッダーがない場合は少なくとも 10 秒待ち、その後は間隔を徐々に延ばしながら再試行してください。同じ IP を共有するクライアントから同時に再試行しないでください。

  • このルールは、受信トレイの一覧取得や個々のメールの読み取りには適用されません。API キーの 1 日あたりの利用枠と合計の利用枠は、引き続き別途適用されます。キーの利用枠を使い切った場合、10 秒待っても回復しません。

コアエンドポイント

POST / GET
/api/generate-email

一時受信箱を生成します。最もシンプルなランダム受信箱の流れには GET を、prefix と domain を明示的に指定したい場合は POST を使います。

GET
/api/emails?email=...

メールボックスのメール一覧を取得します。

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

1 通のメールを取得します（テキスト、HTML、生ヘッダー、メタデータを含む）。

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

ID を指定して 1 通のメールを削除します。

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

メールボックス内のメールをすべて削除します。

GET
/api/stats

サイト全体の統計を取得します。

利用例の流れ

よくあるパターンは次の 2 つです。サービスに受信箱の生成を任せるか、固定のプレフィックスを指定するか。現在サポートされているドメインが分かっていれば、ローカルでメールボックスを組み立てて直接問い合わせることもできます。

1) ランダムな一時メールアドレスを生成

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
レスポンス例
{
  "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) 固定プレフィックスで生成（例：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"}'
レスポンス例
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) 受信箱内のメール一覧を取得

サポート対象のドメインが分かっている場合はステップ 1 を省略して直接問い合わせてください。

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
レスポンス例
{
  "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) 1 通のメールを読む — プレーンテキスト、HTML 本文、メタデータを含む

EMAIL_ID は手順 3 で返された ID に置き換えてください。あわせて受信トレイのアドレスを email として渡してください（削除や添付ファイルのダウンロードでも同様です）。こうすると、メールは ID で検索されるのではなく、その受信トレイから直接読み取られます。 API キーを使う場合 email パラメーターは省略可能ですが、指定すると検索が速くなります。

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
レスポンス例
{
  "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) ID を指定して 1 通のメールを削除

API キーを使う場合 email パラメーターは省略可能ですが、指定すると検索が速くなります。

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

6) 受信箱をまるごとクリア — このアドレスのメールをすべて削除

1 回の呼び出しで 1 バッチを削除します。レスポンスに "has_more": true がある間は、false が返るまで再度呼び出してください。

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

レスポンスの形

成功時のレスポンスはおおむね次のような形です。API Key で認証している場合は 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
  }
}

拡張統計

  • /api/statistics/24h 24 時間分の時間帯別分布ウィンドウを 1 つ返します。それより前のウィンドウには offset=1,2,... を使用します。
  • /api/statistics/top-subjects よく使われるメール件名の上位を返します。
  • /api/statistics/top-domains 最もアクティブなドメインを返します。
  • /api/statistics/top-senders 最もアクティブな送信者を返します。
GPTMail