{ "openapi": "3.0.1", "info": { "title": "SiteVerdict — Schema Markup Validator & JSON-LD Generator", "description": "Extract and validate JSON-LD, Microdata and RDFa against schema.org and Google rich-result rules (Product, Article, FAQ, Recipe, Event, JobPosting, LocalBusiness...). Get exact errors, ready-to-paste JSON-LD for each page and optional AI generation with your own key.", "version": "1.0", "x-build-id": "1mD6giHjBHhifYEh9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/siteverdict~siteverdict-schema-markup-tool/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-siteverdict-siteverdict-schema-markup-tool", "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/siteverdict~siteverdict-schema-markup-tool/runs": { "post": { "operationId": "runs-sync-siteverdict-siteverdict-schema-markup-tool", "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/siteverdict~siteverdict-schema-markup-tool/run-sync": { "post": { "operationId": "run-sync-siteverdict-siteverdict-schema-markup-tool", "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": { "urls": { "title": "Pages to validate", "type": "array", "description": "One or more page URLs (max 2,000).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "crawl": { "title": "Crawl the site from these URLs", "type": "boolean", "description": "Follow internal links from each URL and validate every page found (up to 'Max pages').", "default": false }, "maxPages": { "title": "Max pages (crawl mode)", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Upper limit of pages validated when crawling.", "default": 50 }, "maxDepth": { "title": "Max click depth (crawl mode)", "minimum": 0, "maximum": 20, "type": "integer", "description": "How deep to follow links.", "default": 5 }, "includePatterns": { "title": "Only pages matching (crawl mode)", "type": "array", "description": "Globs (/products/**) or /regex/.", "items": { "type": "string" } }, "excludePatterns": { "title": "Skip pages matching (crawl mode)", "type": "array", "description": "Globs or /regex/.", "items": { "type": "string" } }, "html": { "title": "Or paste HTML", "type": "string", "description": "Paste a full HTML page or snippet to validate without fetching anything (max 2 MB)." }, "jsonLd": { "title": "Or paste JSON-LD", "type": "string", "description": "Paste a JSON-LD object/array to validate (max 2 MB)." }, "generateRecommendations": { "title": "Generate recommended JSON-LD", "type": "boolean", "description": "Build ready-to-paste JSON-LD for each page from facts on the page (title, description, images, prices, FAQs...). Unknown values are marked FILL_IN.", "default": true }, "aiGenerate": { "title": "AI JSON-LD generation (your own key)", "type": "boolean", "description": "For pages with errors or no markup, ask your own Anthropic/OpenAI key for complete JSON-LD; the result is re-validated by our rules before output.", "default": false }, "aiProvider": { "title": "AI provider", "enum": [ "anthropic", "openai" ], "type": "string", "description": "Which API your key belongs to.", "default": "anthropic" }, "aiApiKey": { "title": "AI API key", "type": "string", "description": "Your own API key (we never use ours). Stored encrypted as an Apify secret, never logged or written to the output." }, "aiModel": { "title": "AI model (optional)", "type": "string", "description": "Leave empty for a fast, low-cost default (claude-haiku-4-5 / gpt-4.1-mini)." }, "maxAiPages": { "title": "Max pages for AI generation", "minimum": 1, "maximum": 50, "type": "integer", "description": "Cap on AI calls per run.", "default": 5 }, "monitoring": { "title": "Monitoring (compare with last run)", "type": "boolean", "description": "Remember markup types and rich-result eligibility per URL (named store 'siteverdict-schema-history') and report pages that lost markup or eligibility.", "default": true }, "projectName": { "title": "Project name (monitoring key)", "type": "string", "description": "Optional stable name used to store the monitoring snapshot, e.g. 'client-acme'. Defaults to the site host." }, "alertWebhookUrl": { "title": "Alert webhook URL (Slack or any HTTPS webhook)", "type": "string", "description": "Optional. Slack incoming-webhook URL or any https:// endpoint that receives a JSON POST when monitoring finds new problems. Stored encrypted as an Apify secret, never logged or written to the output." }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 4, "type": "integer", "description": "Parallel page fetches.", "default": 2 }, "requestDelayMs": { "title": "Delay between requests to one host (ms)", "minimum": 250, "maximum": 10000, "type": "integer", "description": "Polite spacing per host. robots.txt Crawl-delay is honoured when it is larger.", "default": 500 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 60, "type": "integer", "description": "Per request.", "default": 20 }, "sampleMode": { "title": "Sample mode (demo data, free)", "type": "boolean", "description": "Run on a built-in demo with planted problems. No network requests and nothing charged. Use it to see the output format.", "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 }, "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 } } } } } } } } } }