{ "openapi": "3.0.1", "info": { "title": "PDF Redaction: Remove Names, Emails, IBANs and Card Numbers", "description": "Redact PDF files from their links. Black out names or words, emails, phone numbers, IBANs, card numbers and US SSNs, or fixed areas. The text is removed, not hidden. One row per file with counts and the redacted PDF. USD 0.025 per file.", "version": "0.1", "x-build-id": "R1rGE4qgxVFaQdmsa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tanod~pdf-redactor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tanod-pdf-redactor", "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/tanod~pdf-redactor/runs": { "post": { "operationId": "runs-sync-tanod-pdf-redactor", "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/tanod~pdf-redactor/run-sync": { "post": { "operationId": "run-sync-tanod-pdf-redactor", "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", "required": [ "urls" ], "properties": { "urls": { "title": "PDF links", "type": "array", "description": "Public http(s) links to the PDFs (at most 20 MB each, at most 200 per run). Private, internal and IP-address hosts are refused. Each file is one redaction and one row.", "items": { "type": "string" } }, "terms": { "title": "Words and names to remove", "type": "array", "description": "Literal strings to black out, for example a person's name or an account number (up to 100, each 1 to 200 characters). Not regular expressions. Spaces match any run of whitespace.", "items": { "type": "string" } }, "patterns": { "title": "Kinds of data to remove", "type": "array", "description": "Fixed detectors applied to the text of every page: email, phone, iban, credit_card, us_ssn. Custom regular expressions are not accepted.", "items": { "type": "string", "enum": [ "email", "phone", "iban", "credit_card", "us_ssn" ], "enumTitles": [ "Email addresses", "Phone numbers", "IBANs (checksum checked)", "Card numbers (Luhn checked)", "US Social Security numbers" ] } }, "boxes": { "title": "Areas to black out (optional)", "type": "array", "description": "Fixed areas, for scanned pages or places with no text, each {\"page\": 1, \"x0\": 50, \"y0\": 700, \"x1\": 300, \"y1\": 740} in PDF points (1/72 inch, origin bottom-left of the page). Up to 500. Applied to every file in the run." }, "caseInsensitive": { "title": "Ignore case for words and names", "type": "boolean", "description": "Match the strings in 'Words and names' whatever their capital letters.", "default": true }, "dpi": { "title": "Resolution of redacted pages", "minimum": 100, "maximum": 300, "type": "integer", "description": "Pages with a match are redrawn as images at this resolution (100 to 300). Higher is sharper and makes a bigger file.", "default": 150 } } }, "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 } } } } } } } } } }