{ "openapi": "3.0.1", "info": { "title": "AI Website Content Checker", "description": "AI Content Checker monitors web pages for content changes and provides AI-powered summaries, visual comparisons, and smart notifications. It helps track competitors, compliance updates, and critical information.", "version": "0.0", "x-build-id": "z7gS5X5GuXDHbJpJJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraping_samurai~ai-website-content-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraping_samurai-ai-website-content-checker", "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/scraping_samurai~ai-website-content-checker/runs": { "post": { "operationId": "runs-sync-scraping_samurai-ai-website-content-checker", "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/scraping_samurai~ai-website-content-checker/run-sync": { "post": { "operationId": "run-sync-scraping_samurai-ai-website-content-checker", "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": [ "url", "aiMode" ], "properties": { "url": { "title": "URL to check", "type": "string", "description": "URL of a web page to be monitored" }, "aiMode": { "title": "AI Mode", "enum": [ "true", "false" ], "type": "string", "description": "When enabled, AI Mode allows you to compare the entire page or the content within specific CSS selectors using AI analysis, providing better quality of the output.", "default": "false" }, "contentSelector": { "title": "Monitored area selector", "type": "string", "description": "CSS selector of an area you want to monitor" }, "screenshotSelector": { "title": "Screenshot selector", "type": "string", "description": "CSS selector of a screenshot you want to get" }, "sendNotificationTo": { "title": "Email address", "type": "string", "description": "Email address where you want to get the notification" }, "sendNotificationText": { "title": "Notification Text", "type": "string", "description": "Optional text to include in the email notification." }, "informOnError": { "title": "Notification in case of error", "enum": [ "true", "false" ], "type": "string", "description": "In case of the problem with selectors on the page, you will get notification mail \n with the screenshot of the page attached.", "default": "false" }, "navigationTimeout": { "title": "Navigation Timeout", "type": "integer", "description": "How long it should wait, in milliseconds, until the page times out", "default": 30000 }, "retryStrategy": { "title": "How to retry", "enum": [ "on-block", "on-all-errors", "never-retry" ], "type": "string", "description": "Sometimes the page doesn't load properly or the actor gets blocked so retrying those helps. On the other hand retrying wrong selector doesn't help. The recognition of blocked pages is not perfect (about 80%).", "default": "on-block" }, "loaderSelector": { "title": "Until which page readiness status should the scraper wait?", "enum": [ "networkidle", "domcontentloaded", "load" ], "type": "string", "description": "Until which page readiness status should the scraper wait — networkidle or another state (networkidle should cover 90% of use cases)?", "default": "networkidle" }, "maxRetries": { "title": "Maximum number of retries", "type": "integer", "description": "How many times the actor should retry in case of error.", "default": 5 } } }, "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 } } } } } } } } } }