{ "openapi": "3.0.1", "info": { "title": "White-Label WCAG Audit Report Generator", "description": "Crawl client websites, detect WCAG 2.2 accessibility issues, and generate branded HTML and PDF reports with selectors, evidence, risk scores, and developer-ready remediation guidance.", "version": "0.1", "x-build-id": "o0rDeCx1KzactNcPN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cardinal_lecturer~a11ybatch/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cardinal_lecturer-a11ybatch", "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/cardinal_lecturer~a11ybatch/runs": { "post": { "operationId": "runs-sync-cardinal_lecturer-a11ybatch", "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/cardinal_lecturer~a11ybatch/run-sync": { "post": { "operationId": "run-sync-cardinal_lecturer-a11ybatch", "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", "maxItems": 100, "type": "array", "description": "Public HTTP or HTTPS website URLs to scan. Up to 100 starting URLs are accepted.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxPagesPerSite": { "title": "Max pages per site", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of same-site pages to audit for each starting URL.", "default": 10 }, "useSitemap": { "title": "Use sitemap", "type": "boolean", "description": "Try sitemap.xml and sitemap indexes before falling back to same-site link discovery.", "default": true }, "includeSubdomains": { "title": "Include subdomains", "type": "boolean", "description": "Allow pages on subdomains of the starting host.", "default": false }, "wcagLevel": { "title": "WCAG level", "enum": [ "A", "AA" ], "type": "string", "description": "Highest WCAG conformance level to include in automated axe rules.", "default": "AA" }, "standards": { "title": "Standards", "uniqueItems": true, "type": "array", "description": "WCAG standards to include in the axe runOnly tags.", "items": { "type": "string", "enum": [ "WCAG_2_0", "WCAG_2_1", "WCAG_2_2" ], "enumTitles": [ "WCAG 2.0", "WCAG 2.1", "WCAG 2.2" ] }, "default": [ "WCAG_2_0", "WCAG_2_1", "WCAG_2_2" ] }, "includePasses": { "title": "Include passed checks", "type": "boolean", "description": "Include axe passes in each page dataset item. This can make output larger.", "default": false }, "generateHtmlReport": { "title": "Generate HTML report", "type": "boolean", "description": "Create a polished responsive HTML report in the default key-value store.", "default": true }, "generatePdfReport": { "title": "Generate PDF report", "type": "boolean", "description": "Create a PDF copy of the HTML report in the default key-value store.", "default": true }, "brandName": { "title": "Brand name", "maxLength": 100, "type": "string", "description": "Optional customer or agency name shown in reports." }, "brandColor": { "title": "Brand color", "pattern": "^#[0-9a-fA-F]{6}$", "type": "string", "description": "Hex color used for report accents.", "default": "#111827" }, "logoUrl": { "title": "Logo URL", "pattern": "^https://", "type": "string", "description": "Optional public HTTPS image URL displayed in the HTML and PDF reports, for example https://example.com/logo.png." }, "waitAfterLoadMs": { "title": "Wait after load", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Additional delay after DOMContentLoaded before running axe.", "default": 1000 }, "pageTimeoutSecs": { "title": "Page timeout", "minimum": 10, "maximum": 90, "type": "integer", "description": "Navigation timeout per page.", "default": 30 }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip URLs disallowed for A11yBatchBot by robots.txt.", "default": true } } }, "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 } } } } } } } } } }