{ "openapi": "3.0.1", "info": { "title": "Docs Change Monitor for AI", "description": "Monitor public docs, changelogs, help centers, status pages, and pricing pages for changes, then output clean Markdown and RAG-ready chunks for AI knowledge bases.", "version": "0.1", "x-build-id": "lxikhEKZkVhnrvPQ2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/careybrown~docs-change-rag-ready-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-careybrown-docs-change-rag-ready-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/careybrown~docs-change-rag-ready-monitor/runs": { "post": { "operationId": "runs-sync-careybrown-docs-change-rag-ready-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/careybrown~docs-change-rag-ready-monitor/run-sync": { "post": { "operationId": "run-sync-careybrown-docs-change-rag-ready-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": [ "startUrls" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Public pages to monitor. MVP local validation requires matching fixturePages entries and does not fetch the network.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "title": "URL", "type": "string", "description": "Public page URL to monitor." }, "label": { "title": "Label", "type": "string", "description": "Optional readable label for the page." }, "pageType": { "title": "Page Type", "type": "string", "description": "Optional page classification.", "enum": [ "docs", "changelog", "help_center", "status", "pricing", "policy", "product_update", "other" ] } } }, "default": [ { "url": "https://example.com/docs/overview", "label": "Example Docs", "pageType": "docs" } ] }, "fixturePages": { "title": "Fixture Pages", "type": "object", "description": "Local MVP fixture HTML keyed by URL. This exists for offline validation only; live fetching remains approval-gated.", "default": {} }, "previousSnapshots": { "title": "Previous Snapshots", "type": "object", "description": "Optional prior snapshot state keyed by URL for local diff validation.", "default": {} }, "chunkSizeChars": { "title": "Chunk Size", "minimum": 500, "maximum": 5000, "type": "integer", "description": "Approximate character size for RAG chunks.", "default": 1800 }, "chunkOverlapChars": { "title": "Chunk Overlap", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Character overlap between adjacent chunks.", "default": 200 }, "changeThresholdRatio": { "title": "Change Threshold Ratio", "minimum": 0, "maximum": 1, "type": "number", "description": "Minimum approximate text-change ratio for changed events.", "default": 0.02 }, "emitUnchangedPages": { "title": "Emit Unchanged Pages", "type": "boolean", "description": "Include unchanged page events in output.", "default": false }, "emitBaselinePages": { "title": "Emit Baseline Pages", "type": "boolean", "description": "Include first-run baseline records in output.", "default": true }, "respectRobotsTxt": { "title": "Respect Robots.txt", "type": "boolean", "description": "Recorded in output source metadata. MVP does not fetch robots.txt.", "default": true }, "maxPages": { "title": "Maximum Pages", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum pages to process from startUrls in this local MVP.", "default": 25 }, "networkMode": { "title": "Network Mode", "enum": [ "fixtures_only", "live_fetch" ], "type": "string", "description": "MVP supports fixture-only validation. Live network fetching requires a later approval packet.", "default": "fixtures_only" }, "maxRequests": { "title": "Maximum HTTP Requests", "minimum": 1, "maximum": 12, "type": "integer", "description": "Maximum HTTP requests for approved local live_fetch validation. Includes robots.txt checks.", "default": 12 }, "requestDelayMs": { "title": "Request Delay", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Delay between live_fetch HTTP requests in milliseconds.", "default": 1000 }, "requestTimeoutSecs": { "title": "Request Timeout", "minimum": 1, "maximum": 60, "type": "integer", "description": "Timeout for each live_fetch HTTP request in seconds.", "default": 20 } } }, "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 } } } } } } } } } }