{ "openapi": "3.0.1", "info": { "title": "PDF Change Monitor & Linked Document Tracker", "description": "Monitor public PDFs even when their download URL changes. Give a stable webpage or a direct PDF URL and get typed link, content, page and metadata changes across runs, with last-good state that failures never overwrite.", "version": "0.1", "x-build-id": "fVlhZAQaMxjSPX2wJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automa-flow~pdf-link-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automa-flow-pdf-link-change-monitor", "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/automa-flow~pdf-link-change-monitor/runs": { "post": { "operationId": "runs-sync-automa-flow-pdf-link-change-monitor", "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/automa-flow~pdf-link-change-monitor/run-sync": { "post": { "operationId": "run-sync-automa-flow-pdf-link-change-monitor", "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": [ "targets" ], "properties": { "targets": { "title": "Documents to monitor", "minItems": 1, "maxItems": 100, "type": "array", "description": "1-100 logical documents. Each needs a stable targetId plus either pageUrl (the webpage that links to the PDF, with linkText, hrefRegex and/or cssSelector selecting exactly one link) or directPdfUrl. Zero matches is LINK_NOT_FOUND, several matches is AMBIGUOUS_LINK; the Actor never guesses.", "items": { "type": "object", "required": [ "targetId" ], "properties": { "targetId": { "type": "string", "title": "Stable target ID", "description": "Your identity for the logical document; keep it unchanged across runs.", "maxLength": 120 }, "label": { "type": "string", "title": "Label", "maxLength": 200, "description": "Optional human-readable name echoed on every row." }, "pageUrl": { "type": "string", "title": "Parent webpage URL", "description": "Public webpage that links to the current PDF. Use with linkText, hrefRegex or cssSelector.", "maxLength": 2048 }, "directPdfUrl": { "type": "string", "title": "Direct PDF URL", "description": "Public PDF URL. Cannot be combined with pageUrl.", "maxLength": 2048 }, "linkText": { "type": "string", "title": "Link text", "description": "Exact visible anchor text (case and whitespace insensitive), for example 'Form 1040 PDF'.", "maxLength": 500 }, "hrefRegex": { "type": "string", "title": "Link URL regex", "description": "Regular expression tested against each absolute link URL, for example 'f1040\\\\.pdf$'.", "maxLength": 500 }, "cssSelector": { "type": "string", "title": "CSS scope selector", "description": "Descendant selector subset (tag, #id, .class, [attr=value]) that must contain or match the link, for example 'div.current-products a'.", "maxLength": 500 } } } }, "monitorKey": { "title": "Monitor key", "maxLength": 80, "type": "string", "description": "Namespace for saved state. Keep it stable for a scheduled monitor; use a different key for an independent watchlist.", "default": "default" }, "mode": { "title": "Output mode", "enum": [ "all", "changesOnly" ], "type": "string", "description": "all emits one row per target per run, including NO_CHANGE, so a scheduled run always documents what was verified. changesOnly emits only baselines, changes and unresolved targets (use for alert webhooks).", "default": "all" }, "baselineMode": { "title": "First observation", "enum": [ "emitBaseline", "silentBaseline" ], "type": "string", "description": "How a target seen for the first time is reported. The baseline is always stored.", "default": "emitBaseline" }, "includeTextDiff": { "title": "Include text diff", "type": "boolean", "description": "Add a bounded unified diff of the normalized text on CONTENT_CHANGED rows.", "default": true }, "maxPdfSizeMb": { "title": "Max PDF size (MB)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Larger downloads fail explicitly as PDF_TOO_LARGE and never touch stored state.", "default": 25 }, "maxPagesPerPdf": { "title": "Max pages per PDF", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Documents with more pages fail explicitly as PDF_PAGE_LIMIT.", "default": 500 } } }, "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 } } } } } } } } } }