{ "openapi": "3.0.1", "info": { "title": "Disposable Temporary Email API", "description": "Create disposable email addresses and poll normalized inbox messages for bounded signup-flow, OTP, and transactional email-delivery QA.", "version": "0.1", "x-build-id": "qMRckfb6oGYH4XA8s" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~temporary-email-inbox-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-temporary-email-inbox-api", "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/automation-lab~temporary-email-inbox-api/runs": { "post": { "operationId": "runs-sync-automation-lab-temporary-email-inbox-api", "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/automation-lab~temporary-email-inbox-api/run-sync": { "post": { "operationId": "run-sync-automation-lab-temporary-email-inbox-api", "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": { "mode": { "title": "Workflow mode", "enum": [ "createAndPoll", "createOnly", "pollExisting", "listDomains" ], "type": "string", "description": "Create and poll a new mailbox, create it without waiting, poll an existing mailbox, or list currently available mail.tm domains.", "default": "createAndPoll" }, "address": { "title": "Existing mailbox address", "pattern": "^\\S+@\\S+\\.\\S+$", "type": "string", "description": "Full mail.tm address to access in pollExisting mode. It is treated as sensitive run input and is not logged." }, "password": { "title": "Mailbox password", "type": "string", "description": "Password for pollExisting mode, or an optional password for a newly created mailbox. Store Actor inputs securely because this grants inbox access." }, "usernamePrefix": { "title": "Address prefix", "pattern": "^[a-zA-Z0-9._-]{1,30}$", "type": "string", "description": "Optional readable prefix for a generated address. A random suffix is always added to prevent collisions." }, "domain": { "title": "Preferred mail.tm domain", "type": "string", "description": "Optional active public mail.tm domain. Leave empty to use the first currently available domain." }, "pollDurationSecs": { "title": "Polling duration (seconds)", "minimum": 0, "maximum": 240, "type": "integer", "description": "How long createAndPoll or pollExisting waits for messages. Use 0 for one immediate inbox read.", "default": 30 }, "pollIntervalSecs": { "title": "Polling interval (seconds)", "minimum": 2, "maximum": 30, "type": "integer", "description": "Delay between inbox checks. The minimum protects the provider's public API rate limit.", "default": 5 }, "maxMessages": { "title": "Maximum messages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of matching, fully downloaded messages written to the dataset.", "default": 10 }, "subjectContains": { "title": "Subject contains", "type": "string", "description": "Optional case-insensitive subject substring, such as verification or one-time code." }, "senderContains": { "title": "Sender contains", "type": "string", "description": "Optional case-insensitive substring matched against the sender email address." }, "deleteAfterRun": { "title": "Delete generated mailbox after the run", "type": "boolean", "description": "Deletes a mailbox created by this run after polling. Enabled by default for createAndPoll; disable only when you need to reuse the inbox.", "default": true }, "includeCredentialsInOutput": { "title": "Include generated password in output", "type": "boolean", "description": "Writes the generated mailbox password to the mailbox dataset row. Enable only when you need a later pollExisting run, and protect the dataset as a secret.", "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }