{ "openapi": "3.0.1", "info": { "title": "Provided List Contact Subtraction", "description": "Expand authorized top-level emails[] and export unique addresses absent from your explicitly supplied email list, with bounded provenance.", "version": "1.1", "x-build-id": "jJmzFJa7T7FT0LLGe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/remarkable_whipscorpion~provided-list-contact-subtraction/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-remarkable_whipscorpion-provided-list-contact-subtraction", "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/remarkable_whipscorpion~provided-list-contact-subtraction/runs": { "post": { "operationId": "runs-sync-remarkable_whipscorpion-provided-list-contact-subtraction", "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/remarkable_whipscorpion~provided-list-contact-subtraction/run-sync": { "post": { "operationId": "run-sync-remarkable_whipscorpion-provided-list-contact-subtraction", "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": "Mode", "enum": [ "demo", "subtract" ], "type": "string", "description": "demo returns one useful original example contact with no custom contact fee. subtract processes your authorized input; each useful stored unmatched contact has a custom fee.", "default": "demo" }, "sourceDatasetId": { "title": "Source Dataset (custom mode)", "pattern": "^[a-zA-Z0-9]{1,64}$", "minLength": 1, "maxLength": 64, "type": "string", "description": "Select one Dataset owned by the same Apify account. Read-only access. Use this field OR sourceRows, never both. Supply the Dataset ID, not a name. Maximum 10,000 records and 10 MiB. Incomplete reads, inaccessible resources, changed datasets or limit failures abort." }, "sourceRows": { "title": "Inline source rows (custom mode)", "maxItems": 10000, "type": "array", "description": "Alternative to sourceDatasetId. JSON object rows; only top-level emails[] strings are compared. Optional domain and originalStartUrl are retained as bounded provenance. Maximum 10,000 rows, 50,000 email values and 10 MiB in UTF-8 serialized JSON.", "items": { "type": "object" } }, "providedEmailsCsv": { "title": "Explicit provided email list (custom mode)", "maxLength": 10485760, "type": "string", "description": "Required in subtract mode, even for an empty list: send an explicit empty string, or a header-only CSV. Nonempty CSV requires every exact selected header. Invalid email values or parse/read/limit failures abort rather than becoming an empty list. Maximum 50,000 rows/values, 200 columns and 10 MiB UTF-8." }, "providedEmailColumns": { "title": "Exact email column headers (custom mode)", "minItems": 1, "maxItems": 200, "uniqueItems": true, "type": "array", "description": "Exact existing CSV headers to compare; defaults at runtime to [\"Email\"]. Selected headers must be unique and present once. Declare all relevant primary/secondary email columns; no translated or CRM-specific header guessing.", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "multiValueSeparator": { "title": "Declared cell separator (optional, custom mode)", "pattern": "^[^\r\n\u0000]{1,10}$", "minLength": 1, "maxLength": 10, "type": "string", "description": "Split email cells only by this explicit separator, such as a semicolon. Omit for one address per cell. No automatic CRM delimiter detection. One to ten characters, no newline or NUL." }, "comparisonPolicy": { "title": "Comparison policy (custom mode)", "enum": [ "exact", "case_insensitive_full_address" ], "type": "string", "description": "Runtime default is exact after trimming boundary whitespace. Optional case_insensitive_full_address lowercases the entire address. Plus tags and dots are preserved. Neither policy validates a mailbox or identifies a person." }, "rightsConfirmed": { "title": "I am authorized to process these inputs", "type": "boolean", "description": "Custom mode requires true: you own or are authorized to process the source websites, contact records and provided CRM/email export. No Google Maps, LinkedIn, social-source or person-enrichment presets. Default original demo is exempt." } } }, "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 } } } } } } } } } }