{ "openapi": "3.0.1", "info": { "title": "EPUB Accessibility Checker - EAA & Ace by DAISY Report", "description": "Is your ebook backlist accessible? Runs Ace by DAISY and EPUBCheck on each EPUB URL and returns a pass, review or fail EAA summary with violations and missing accessibility metadata. Automated checks cover only part of WCAG and need a human review.", "version": "1.0", "x-build-id": "9xzbVJlA8fyu0Hk0y" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/that_red_bird~epub-accessibility-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-that_red_bird-epub-accessibility-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/that_red_bird~epub-accessibility-checker/runs": { "post": { "operationId": "runs-sync-that_red_bird-epub-accessibility-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/that_red_bird~epub-accessibility-checker/run-sync": { "post": { "operationId": "run-sync-that_red_bird-epub-accessibility-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", "properties": { "epubUrls": { "title": "EPUB URLs", "type": "array", "description": "Direct links to .epub files. The default is one public sample book so you can try the Actor; replace it with your own list.", "default": [ "https://github.com/IDPF/epub3-samples/releases/download/20230704/childrens-literature.epub" ], "items": { "type": "string" } }, "keyValueStoreId": { "title": "Key-value store with EPUB files (optional)", "type": "string", "description": "Pick a key-value store that holds .epub records, for example one filled by your own upload job. All records ending in .epub (or the keys below) are checked, in addition to the URLs." }, "recordKeys": { "title": "Record keys", "type": "array", "description": "Only check these records of the selected key-value store. Leave empty to check all records that end in .epub.", "default": [], "items": { "type": "string" } }, "runEpubCheck": { "title": "Run EPUBCheck", "type": "boolean", "description": "Validate the EPUB package and content documents with the W3C reference validator (Java). A book with fatal or error messages fails.", "default": true }, "runAce": { "title": "Run Ace by DAISY", "type": "boolean", "description": "Run the DAISY accessibility checker (axe-core in headless Chromium) against EPUB Accessibility 1.1 and WCAG 2.x. This is the slower part of the check.", "default": true }, "saveFullReports": { "title": "Save full reports", "type": "boolean", "description": "Store the complete Ace report.json and EPUBCheck JSON for each book in the key-value store and add the links to the result row.", "default": true }, "lang": { "title": "Report language", "type": "string", "description": "Language code for the Ace messages, for example fr or de. Leave empty for English.", "default": "" }, "maxBooks": { "title": "Max books", "minimum": 1, "maximum": 500, "type": "integer", "description": "Upper limit of EPUB files checked per run. Each book takes about 20 to 90 seconds.", "default": 10 }, "maxEpubMb": { "title": "Max EPUB size (MB)", "minimum": 1, "maximum": 150, "type": "integer", "description": "Books larger than this are skipped with an error row.", "default": 50 }, "bookTimeoutSecs": { "title": "Time limit per book (seconds)", "minimum": 60, "maximum": 1200, "type": "integer", "description": "Maximum time for Ace on one book. Large illustrated books can need more.", "default": 300 } } }, "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 } } } } } } } } } }