{
  "openapi": "3.0.1",
  "info": {
    "title": "Temp Email | Disposable Inbox, OTP & Verification Catcher",
    "description": "Create a disposable email inbox and read incoming messages on demand: OTP codes, sign-up confirmations and verification links. Wait for a specific email, auto-extract codes and magic-link tokens, read attachments and headers. Keyless, no signup. For QA, automation and signup testing.",
    "version": "1.1",
    "x-build-id": "Zfvoucqda4xSiNPG9"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/apivault_labs~temp-email/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-apivault_labs-temp-email",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/apivault_labs~temp-email/runs": {
      "post": {
        "operationId": "runs-sync-apivault_labs-temp-email",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/apivault_labs~temp-email/run-sync": {
      "post": {
        "operationId": "run-sync-apivault_labs-temp-email",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "action": {
            "title": "Action",
            "enum": [
              "create",
              "read"
            ],
            "type": "string",
            "description": "create = make a new inbox (returns its address + key instantly). read = check an existing inbox for messages.",
            "default": "create"
          },
          "domain": {
            "title": "Domain",
            "enum": [
              "auto",
              "swagpapa.com",
              "rulersonline.com",
              "besttempmail.com",
              "deepmails.org",
              "embassybase.com",
              "justdefinition.com",
              "gongjua.com",
              "123mails.org",
              "gmail-dot",
              "gmail-plus",
              "googlemail"
            ],
            "type": "string",
            "description": "Only for Action = Create. Pick the address domain: Auto (fastest random), a branded domain, or a Gmail alias.",
            "default": "auto"
          },
          "username": {
            "title": "Username (optional)",
            "type": "string",
            "description": "Only for the Auto domain - the local part of the address. Random if empty. Ignored for branded/Gmail domains."
          },
          "count": {
            "title": "Number of inboxes",
            "minimum": 1,
            "maximum": 25,
            "type": "integer",
            "description": "Only for Action = Create. Create this many disposable inboxes in one run (1-25). Each inbox is one result.",
            "default": 1
          },
          "allowFallback": {
            "title": "Fall back to Auto if a branded inbox fails",
            "type": "boolean",
            "description": "Only for Action = Create. If a branded/Gmail inbox can't be set up, create a reliable Auto inbox instead (recommended).",
            "default": true
          },
          "address": {
            "title": "Inbox address",
            "type": "string",
            "description": "The email address to check (the one a Create run returned). The Domain field is ignored when reading."
          },
          "inboxes": {
            "title": "Multiple inboxes (optional)",
            "type": "array",
            "description": "Only for Action = Read. Check several inboxes in one run. Paste a list of objects like [{\"address\":\"a@x.com\",\"key\":\"...\"}]. Branded/Gmail inboxes open with just the address; Auto inboxes need their key/token. Takes a single snapshot per inbox (no long polling)."
          },
          "key": {
            "title": "Inbox key (optional for branded/Gmail)",
            "type": "string",
            "description": "For an Auto inbox: paste the 'token' from create (required). For branded/Gmail inboxes you can leave this EMPTY - they open with just the address."
          },
          "password": {
            "title": "Inbox password (optional)",
            "type": "string",
            "description": "Only for an Auto-domain inbox if its key/token expired - the password returned at create time."
          },
          "waitTimeout": {
            "title": "Max wait for mail (seconds)",
            "minimum": 0,
            "maximum": 120,
            "type": "integer",
            "description": "For action=read. Default 0 = check once and return instantly (fast & cheap). Set a value (e.g. 60) only if you want to keep waiting for a mail to arrive. Max 120s.",
            "default": 0
          },
          "pollInterval": {
            "title": "Poll interval (seconds)",
            "minimum": 2,
            "maximum": 30,
            "type": "integer",
            "description": "How often to check the inbox while waiting. Branded inboxes are rate-limited, so a minimum of ~12s is enforced automatically.",
            "default": 6
          },
          "matchFrom": {
            "title": "Match sender (optional)",
            "type": "string",
            "description": "Only for Action = Read. Only return emails whose sender address or name contains this text (case-insensitive). The run keeps waiting until a matching mail arrives."
          },
          "matchSubject": {
            "title": "Match subject (optional)",
            "type": "string",
            "description": "Only for Action = Read. Only return emails whose subject contains this text (case-insensitive)."
          },
          "matchKeyword": {
            "title": "Match keyword in body (optional)",
            "type": "string",
            "description": "Only for Action = Read. Only return emails that contain this text anywhere (subject or body). Enables full-body fetch automatically."
          },
          "onlyUnseen": {
            "title": "Only unread messages",
            "type": "boolean",
            "description": "Only for Action = Read. Skip messages already marked as seen.",
            "default": false
          },
          "waitForNew": {
            "title": "Only mail that arrives after this run starts",
            "type": "boolean",
            "description": "Only for Action = Read. Ignore messages already in the inbox when the run begins - handy when re-testing the same address.",
            "default": false
          },
          "latestOnly": {
            "title": "Return only the newest message",
            "type": "boolean",
            "description": "Only for Action = Read. Return just the most recent matching email (e.g. to grab the latest OTP). Reduces results.",
            "default": false
          },
          "maxMessages": {
            "title": "Max messages to return",
            "minimum": 0,
            "maximum": 50,
            "type": "integer",
            "description": "Only for Action = Read. Cap how many matching emails are returned (0 = no limit). Ignored when 'Return only the newest message' is on.",
            "default": 0
          },
          "extractCodes": {
            "title": "Extract OTP / verification codes",
            "type": "boolean",
            "description": "Scan message bodies and pull out likely one-time codes and verification links.",
            "default": true
          },
          "includeBody": {
            "title": "Include full message body",
            "type": "boolean",
            "description": "Include the full text/HTML body of each message.",
            "default": true
          },
          "codeMinLength": {
            "title": "Min OTP code length",
            "minimum": 3,
            "maximum": 12,
            "type": "integer",
            "description": "Shortest digit/alphanumeric code to treat as an OTP.",
            "default": 4
          },
          "codeMaxLength": {
            "title": "Max OTP code length",
            "minimum": 3,
            "maximum": 12,
            "type": "integer",
            "description": "Longest digit/alphanumeric code to treat as an OTP.",
            "default": 8
          },
          "codeRegex": {
            "title": "Custom code pattern (optional)",
            "type": "string",
            "description": "Advanced: a regex to extract the code yourself (first capture group, or whole match, is used). Overrides the length-based detection."
          },
          "includeRaw": {
            "title": "Include raw EML & headers",
            "type": "boolean",
            "description": "Also return the raw email source plus parsed headers and SPF/DKIM/DMARC verdicts (Auto inboxes only). Useful for deliverability QA.",
            "default": false
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}