{ "openapi": "3.0.1", "info": { "title": "Hyper Reader", "description": "High-fidelity web extraction for AI agents. Clean Markdown optimized for Claude, GPT-4 & Gemini. 3-level stealth, Vision screenshots, Deep Read link following. Standby Mode for 1-second responses.", "version": "1.5", "x-build-id": "fxtTemTleTFNqB2Si" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ai_solutionist~hyper-reader/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ai_solutionist-hyper-reader", "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/ai_solutionist~hyper-reader/runs": { "post": { "operationId": "runs-sync-ai_solutionist-hyper-reader", "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/ai_solutionist~hyper-reader/run-sync": { "post": { "operationId": "run-sync-ai_solutionist-hyper-reader", "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": { "url": { "title": "Target URL", "type": "string", "description": "The web page URL to extract content from." }, "urls": { "title": "Multiple URLs", "type": "array", "description": "Extract from multiple URLs at once (one per line). Takes precedence over single URL.", "items": { "type": "string" } }, "agentPreset": { "title": "Agent Optimization", "enum": [ "Claude", "GPT-4", "Gemini", "SearchGPT", "Raw" ], "type": "string", "description": "Optimize output format for your target AI agent.", "default": "Claude" }, "outputFormat": { "title": "Output Format", "enum": [ "markdown", "json", "html_cleaned" ], "type": "string", "description": "The format of the extracted content.", "default": "markdown" }, "stealthLevel": { "title": "Stealth Level", "minimum": 1, "maximum": 3, "type": "integer", "description": "Anti-bot protection level. 1=Basic, 2=Standard, 3=Elite (heavy protection).", "default": 2 }, "useVision": { "title": "Capture Screenshot for Vision", "type": "boolean", "description": "Capture a 1280x720 screenshot for Vision model analysis.", "default": false }, "deepReadDepth": { "title": "Deep Read Depth", "minimum": 0, "maximum": 3, "type": "integer", "description": "Follow internal links to gather more context. 0 = single page only.", "default": 0 }, "deepReadMaxPages": { "title": "Deep Read Max Pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of pages to extract when using Deep Read.", "default": 10 }, "waitForSelector": { "title": "Wait for Selector", "type": "string", "description": "CSS selector to wait for before extracting (for JS-heavy pages)." }, "waitForTimeout": { "title": "Wait Timeout (ms)", "minimum": 1000, "maximum": 60000, "type": "integer", "description": "Maximum time to wait for page load.", "default": 30000 }, "excludeSelectors": { "title": "Exclude Selectors", "type": "string", "description": "CSS selectors to remove before extraction (comma-separated)." }, "includeMetadata": { "title": "Include Metadata", "type": "boolean", "description": "Include title, author, date, and other metadata in output.", "default": true }, "includeLinks": { "title": "Preserve Links", "type": "boolean", "description": "Keep hyperlinks in Markdown output.", "default": true }, "includeImages": { "title": "Include Image URLs", "type": "boolean", "description": "Include image URLs in Markdown output.", "default": false }, "maxContentLength": { "title": "Max Content Length", "minimum": 0, "type": "integer", "description": "Truncate content if it exceeds this character count. 0 = no limit.", "default": 0 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Configure proxy for requests. Leave empty to use Apify's automatic proxy.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }