{ "openapi": "3.0.1", "info": { "title": "SiteVerdict — Accessibility Statement & VPAT/ACR Generator", "description": "Audit your site for WCAG 2.2 (axe-core + keyboard, reflow, motion checks) and get a draft UK public-sector or EAA accessibility statement plus a VPAT-style conformance report (ACR) in HTML, Markdown and Word. Honest drafts: failures listed, nothing claimed that automation can't prove.", "version": "1.1", "x-build-id": "Q3C1xzWPf8t1MWtTr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/siteverdict~siteverdict-accessibility-statement-generator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-siteverdict-siteverdict-accessibility-statement-generator", "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-accessibility-statement-generator/runs": { "post": { "operationId": "runs-sync-siteverdict-siteverdict-accessibility-statement-generator", "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-accessibility-statement-generator/run-sync": { "post": { "operationId": "run-sync-siteverdict-siteverdict-accessibility-statement-generator", "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": { "jurisdiction": { "title": "Statement type", "enum": [ "uk-psbar", "eaa", "voluntary" ], "type": "string", "description": "Which statement template to draft. The ACR (WCAG 2.2 conformance table) is produced for every type.", "default": "uk-psbar" }, "startUrls": { "title": "Pages to audit", "type": "array", "description": "Public pages of the website (max 20). robots.txt is respected; private/internal addresses are refused.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "crawl": { "title": "Also crawl same-site links", "type": "boolean", "description": "Follow internal links from the first page to build a sample (up to Max pages). Choose a representative sample: home page, key journeys, forms, templates.", "default": false }, "maxPages": { "title": "Max pages to audit", "minimum": 1, "maximum": 50, "type": "integer", "description": "Each audited page is one billable event.", "default": 10 }, "auditDatasetId": { "title": "…or import an Accessibility Auditor dataset (ID)", "type": "string", "description": "Dataset ID from a SiteVerdict Accessibility Auditor run. When set, no pages are audited (and none are charged); the statement is built from those results." }, "manualFindings": { "title": "Manual test findings (optional)", "type": "array", "description": "Results of your manual / assistive-technology testing. They override automation per criterion: {\"sc\": \"2.4.3\", \"status\": \"fails|partially|passes|not-applicable|not-tested\", \"description\": \"Focus jumps to the footer after the search form\", \"pages\": [\"https://…\"], \"plannedFix\": \"…\", \"fixBy\": \"March 2027\"}." }, "organisationName": { "title": "Organisation name", "type": "string", "description": "Who runs the website." }, "websiteName": { "title": "Website / service name", "type": "string", "description": "Defaults to the host name." }, "websiteUrl": { "title": "Website URL", "type": "string", "description": "Defaults to the first audited page's origin." }, "statementScope": { "title": "What the statement covers", "type": "string", "description": "e.g. \"the example.gov.uk website, excluding the planning portal subdomain\"." }, "contactEmail": { "title": "Accessibility contact email (organisation)", "type": "string", "description": "Published organisational contact, e.g. accessibility@… (not a personal address)." }, "contactPhone": { "title": "Accessibility contact phone", "type": "string", "description": "Optional." }, "responseDays": { "title": "Response time (days)", "minimum": 1, "maximum": 90, "type": "integer", "description": "How quickly you reply to accessibility requests.", "default": 5 }, "enforcementRegion": { "title": "Enforcement body (UK)", "enum": [ "england-scotland-wales", "northern-ireland" ], "type": "string", "description": "Used in the UK public-sector enforcement section.", "default": "england-scotland-wales" }, "testedBy": { "title": "Who tested", "type": "string", "description": "e.g. \"our digital team using SiteVerdict automated checks and manual testing\"." }, "disproportionateBurden": { "title": "Disproportionate burden claims", "type": "array", "description": "Only if you have a documented assessment. One per line.", "items": { "type": "string" } }, "outOfScope": { "title": "Content not within scope", "type": "array", "description": "Adds the matching exemption text (UK public sector).", "items": { "type": "string", "enum": [ "pdfs-before-2018", "video-before-2020", "live-video", "maps", "third-party", "archived" ], "enumTitles": [ "PDFs/documents before 23 Sept 2018", "Pre-recorded video before 23 Sept 2020", "Live video", "Online maps", "Third-party content", "Archived content" ] } }, "improvementPlan": { "title": "What you're doing to improve", "type": "string", "description": "Your roadmap text. Leave empty for a [REVIEW] placeholder (or let the AI step draft one)." }, "productName": { "title": "ACR: product name", "type": "string", "description": "Defaults to the website name." }, "productVersion": { "title": "ACR: version / date", "type": "string", "description": "e.g. \"October 2026 release\"." }, "productDescription": { "title": "Product / service description", "type": "string", "description": "Used in the ACR and the EAA service description." }, "marketSurveillanceAuthority": { "title": "EAA: market surveillance authority", "type": "string", "description": "Name of the authority in your Member State (EAA mode)." }, "includeAAA": { "title": "ACR: include Level AAA table", "type": "boolean", "description": "Adds Table 3 (Level AAA).", "default": false }, "statementDate": { "title": "Statement date (YYYY-MM-DD)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Defaults to today." }, "devices": { "title": "Devices", "type": "array", "description": "Viewports to test (live audits).", "items": { "type": "string", "enum": [ "desktop", "mobile" ] }, "default": [ "desktop", "mobile" ] }, "navigationTimeoutSecs": { "title": "Navigation timeout (seconds)", "minimum": 10, "maximum": 120, "type": "integer", "description": "Per page.", "default": 45 }, "aiProvider": { "title": "Optional AI plain-English rewrite: provider", "enum": [ "none", "anthropic", "openai" ], "type": "string", "description": "Rewrites each failure into plain English for the public statement and drafts the improvement plan, using YOUR OWN key. Only issue titles, descriptions and WCAG numbers are sent — never page content.", "default": "none" }, "aiApiKey": { "title": "AI API key (your own)", "type": "string", "description": "Stored encrypted, never logged or output." }, "aiModel": { "title": "AI model (optional)", "type": "string", "description": "Default: claude-sonnet-5-5 (Anthropic) or gpt-4.1-mini (OpenAI)." }, "sampleMode": { "title": "Sample mode (bundled audit results, free)", "type": "boolean", "description": "Generates all documents from two bundled real audit results (an inaccessible demo page and a GOV.UK page). No browser, no charges. If no start URL, audit dataset or manual findings are given, the run uses sample mode automatically, every row is marked isSampleData: true and the documents carry a SAMPLE DATA banner.", "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 } } } } } } } } } }