{ "openapi": "3.0.1", "info": { "title": "ADA Website Accessibility Checker: WCAG 2.1 AA, plain language", "description": "Tests web pages against WCAG 2.1 Level A and AA, the standard the US Department of Justice names for state and local government websites under ADA Title II, and explains every problem found in plain language with what to fix. Automated tests only; not a compliance certificate or legal advice.", "version": "0.1", "x-build-id": "SJMPcWG8W8Y9FWfR7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/examsens.ai~ada-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-examsens.ai-ada-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/examsens.ai~ada-checker/runs": { "post": { "operationId": "runs-sync-examsens.ai-ada-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/examsens.ai~ada-checker/run-sync": { "post": { "operationId": "run-sync-examsens.ai-ada-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": [ "startUrls" ], "properties": { "startUrls": { "title": "Pages or sites", "type": "array", "description": "Pages to test against WCAG 2.1 Level A and AA. With crawling on, each one is also a starting point for finding more pages on the same site.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "crawl": { "title": "Crawl the site", "type": "boolean", "description": "Follow links from each start page to other pages on the same site, up to the page and depth limits below.", "default": false }, "maxPagesPerSite": { "title": "Maximum pages per site", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Crawling stops adding pages for a site once this many are queued, start pages included. Each page tested is one billable event.", "default": 20 }, "maxCrawlDepth": { "title": "Maximum crawl depth", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many clicks away from a start page the crawl may go. 1 tests the pages linked from the start page.", "default": 2 }, "excludePatterns": { "title": "Exclude URLs (regular expressions)", "type": "array", "description": "Crawled links that match any of these are skipped, for example /blog/ or \\?page=", "items": { "type": "string" } }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip crawled links that the robots.txt file of the site disallows. Start pages you list are always tested.", "default": true }, "includeManualReview": { "title": "List what needs a person to check", "type": "boolean", "description": "List the checks the automated tests could not decide, such as text over a background image.", "default": true }, "device": { "title": "Device", "enum": [ "desktop", "mobile" ], "type": "string", "description": "Desktop uses a 1366 by 900 window. Mobile uses an iPhone 13 profile (390 by 664 CSS pixels, phone user agent, touch).", "default": "desktop" }, "issueRows": { "title": "One row per affected element", "type": "boolean", "description": "Also add a dataset row for every affected element listed, for a flat CSV or Excel export to hand to a web team.", "default": false }, "maxElementsPerRule": { "title": "Examples per problem", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many affected elements to list as examples for each issue on a page. The full count is always given.", "default": 5 }, "htmlReport": { "title": "HTML report", "type": "boolean", "description": "Save a plain language report of the whole run as report.html in the key value store. Its link is in each summary row.", "default": true }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When the page counts as loaded before testing starts.", "default": "load" }, "waitForSelector": { "title": "Wait for selector", "type": "string", "description": "Optional CSS selector to wait for before testing, for pages that build their content with JavaScript." }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Wait this long after loading before testing.", "default": 1000 }, "timeoutSecs": { "title": "Page timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Give up on a page that does not load within this time.", "default": 30 }, "maxConcurrency": { "title": "Pages at once", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many pages to test in parallel.", "default": 3 } } }, "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 } } } } } } } } } }