{ "openapi": "3.0.1", "info": { "title": "Website Change Detector", "description": "Monitor websites for content changes on a schedule. Diffs main content between runs, ignores noise via regex patterns, optionally summarizes changes with an LLM, and alerts via webhook (n8n, Make, Slack).", "version": "0.0", "x-build-id": "mxOOeWQ1Y545w5mao" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ichigowa~website-change-detector/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ichigowa-website-change-detector", "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/ichigowa~website-change-detector/runs": { "post": { "operationId": "runs-sync-ichigowa-website-change-detector", "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/ichigowa~website-change-detector/run-sync": { "post": { "operationId": "run-sync-ichigowa-website-change-detector", "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": { "startUrls": { "title": "URLs to monitor", "type": "array", "description": "List of web pages to monitor for content changes. Each run compares the current content against the snapshot from the previous run.", "default": [ { "url": "https://example.com" }, { "url": "https://www.wikipedia.org" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "cssSelector": { "title": "CSS selector (optional)", "type": "string", "description": "Only monitor the part of the page matched by this CSS selector (e.g. `#main-content`, `.price`, `article`). Leave empty to monitor the main content of the whole page." }, "checkMode": { "title": "Check mode", "enum": [ "text", "html" ], "type": "string", "description": "`text` extracts readable article/main text (recommended, robust against markup noise). `html` compares normalized raw HTML (scripts, styles, and whitespace stripped) — use it to detect attribute or structure changes.", "default": "text" }, "ignorePatterns": { "title": "Ignore patterns (regex)", "type": "array", "description": "Regular expressions removed from both old and new content before comparing. Use them to ignore volatile fragments like timestamps, view counters, or session IDs. One pattern per line, e.g. `\\d{2}:\\d{2}:\\d{2}` or `\\d+ views`.", "default": [], "items": { "type": "string" } }, "minChangePercent": { "title": "Minimum change percent", "type": "string", "description": "Minimum percentage of content that must change (0–100) for a page to be reported as `changed`. Smaller edits are reported as `unchanged`. Default: 0.5.", "default": "0.5" }, "webhookUrl": { "title": "Webhook URL (optional)", "type": "string", "description": "If set, a JSON array of all changed rows is POSTed to this URL at the end of the run. Perfect for n8n, Make, Zapier, or Slack incoming webhooks." }, "llmApiKey": { "title": "LLM API key (optional)", "type": "string", "description": "OpenAI-compatible API key. When provided, each detected change gets a 2–3 sentence AI summary. Leave empty to skip summaries — the Actor works fully without any key." }, "llmModel": { "title": "LLM model", "type": "string", "description": "Model name used for change summaries (only used when an LLM API key is provided).", "default": "gpt-4o-mini" }, "llmApiBase": { "title": "LLM API base URL", "type": "string", "description": "Base URL of the OpenAI-compatible API. Change it to use providers like Groq, Together, OpenRouter, or a local server.", "default": "https://api.openai.com/v1" }, "notifyOnFirstRun": { "title": "Treat first snapshot as a change", "type": "boolean", "description": "When enabled, the very first snapshot of a URL is reported as `changed` (and sent to the webhook). When disabled (default), the first run only stores a baseline.", "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 } } } } } } } } } }