{ "openapi": "3.0.1", "info": { "title": "PageSpeed & Lighthouse Bulk Audit + AI Readiness", "description": "Audit hundreds of URLs on mobile and desktop with Lighthouse 13: performance, accessibility, SEO and best-practice scores, Core Web Vitals, real-user CrUX data, top fixes and AI-agent readiness. No API key needed, or add your free Google key for results identical to PageSpeed Insights.", "version": "0.2", "x-build-id": "CZFEBa4mWKqMXc31V" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vemka~lighthouse-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vemka-lighthouse-auditor", "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/vemka~lighthouse-auditor/runs": { "post": { "operationId": "runs-sync-vemka-lighthouse-auditor", "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/vemka~lighthouse-auditor/run-sync": { "post": { "operationId": "run-sync-vemka-lighthouse-auditor", "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": [ "urls" ], "properties": { "urls": { "title": "URLs", "type": "array", "description": "Pages to audit, one per line. Bare domains are audited over https. Duplicates are removed and invalid entries are skipped for free.", "items": { "type": "string" } }, "strategies": { "title": "Devices", "type": "array", "description": "Run the audit as mobile (emulated phone on slow 4G, like PageSpeed Insights) and/or desktop. Each device counts as one audit.", "items": { "type": "string", "enum": [ "mobile", "desktop" ], "enumTitles": [ "Mobile", "Desktop" ] }, "default": [ "mobile" ] }, "categories": { "title": "Lighthouse categories", "type": "array", "description": "Which Lighthouse categories to run. 'AI readiness' (Lighthouse 13's Agentic browsing category) checks how well AI agents can use the page: accessibility tree, llms.txt and WebMCP. Fewer categories make audits a little faster.", "items": { "type": "string", "enum": [ "performance", "accessibility", "best-practices", "seo", "agentic-browsing" ], "enumTitles": [ "Performance", "Accessibility", "Best practices", "SEO", "AI readiness (Agentic browsing)" ] }, "default": [ "performance", "accessibility", "best-practices", "seo", "agentic-browsing" ] }, "googleApiKey": { "title": "Google API key (optional, recommended)", "type": "string", "description": "Your own free key from Google Cloud Console with the PageSpeed Insights API and Chrome UX Report API enabled (takes about 5 minutes – see README). With a key, audits run on Google's PageSpeed Insights servers, so the numbers match pagespeed.web.dev, and real-user Core Web Vitals (CrUX) are added. The key is used only for your runs and is stored encrypted." }, "engine": { "title": "Audit engine", "enum": [ "auto", "psi", "local" ], "type": "string", "description": "Auto: PageSpeed Insights when you provide a Google API key, otherwise Lighthouse runs inside the Actor. Local Lighthouse needs no key; on script-heavy pages its Total Blocking Time tends to read higher than PageSpeed Insights.", "default": "auto" }, "saveReports": { "title": "Save full HTML reports", "type": "boolean", "description": "Also save the complete Lighthouse HTML report for every audit (the same report you see in Chrome DevTools) and add its link as reportUrl. Handy for sharing with developers.", "default": false }, "minScore": { "title": "Problem threshold (score)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Category scores below this value are listed as problems.", "default": 90 }, "topOpportunities": { "title": "Number of top fixes", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many improvement opportunities (with estimated savings) to include per page.", "default": 5 }, "concurrency": { "title": "Parallel browsers (local engine)", "minimum": 1, "maximum": 3, "type": "integer", "description": "Local engine only. Lighthouse is CPU-heavy: parallel audits make results noisier. Use 1 for the most stable scores (recommended). The PageSpeed Insights engine always runs 6 audits in parallel.", "default": 1 }, "maxUrls": { "title": "Max URLs", "minimum": 1, "type": "integer", "description": "Safety limit for one run.", "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 }, "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 } } } } } } } } } }