{ "openapi": "3.0.1", "info": { "title": "PDF Text Extractor — OCR for scanned PDFs (Arabic + English)", "description": "Turn scanned or image-only PDFs into structured text that keeps its reading order: per-block bounding boxes, per-block OCR confidence, column-aware ordering, and a spatial plain-text rendering. Arabic and English OCR built in. Pay per document plus per page.", "version": "0.1", "x-build-id": "Gl1hg3aBtAJhfnieH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/amanatools~pdf-ocr-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-amanatools-pdf-ocr-extractor", "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/amanatools~pdf-ocr-extractor/runs": { "post": { "operationId": "runs-sync-amanatools-pdf-ocr-extractor", "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/amanatools~pdf-ocr-extractor/run-sync": { "post": { "operationId": "run-sync-amanatools-pdf-ocr-extractor", "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": [ "pdf_urls" ], "properties": { "pdf_urls": { "title": "PDF URLs", "type": "array", "description": "Direct links to the PDF files to process (up to 50 per run).", "items": { "type": "string" } }, "pages": { "title": "Pages", "type": "string", "description": "Which pages to read: 'all', a range like '1-5', or a list like '1,3,7-9'.", "default": "all" }, "ocr_mode": { "title": "OCR mode", "enum": [ "auto", "always", "never" ], "type": "string", "description": "Auto is the cheapest and the default: pages that already contain digital text are read directly, only image pages are OCR'd.", "default": "auto" }, "language": { "title": "OCR language", "enum": [ "auto", "eng", "ara", "ara+eng", "fra", "deu", "spa", "por", "ita", "nld", "tur", "rus", "fas", "urd" ], "type": "string", "description": "Language of the scanned text. 'Auto' detects Latin vs Arabic vs Cyrillic script from the first OCR'd page of each document.", "default": "auto" }, "preserve_layout": { "title": "Preserve layout (blocks, bounding boxes, spatial text)", "type": "boolean", "description": "Return per-block bounding boxes, confidence and column index, plus a spatially laid-out plain-text rendering of each page. Turn off for smaller dataset items when you only need raw text.", "default": true }, "dpi": { "title": "OCR render resolution", "minimum": 72, "maximum": 400, "type": "integer", "description": "Higher DPI is more accurate on small print and much slower. 200 suits most scans; use 300 for dense or small text.", "default": 200 }, "auto_rotate": { "title": "Auto-detect page rotation", "type": "boolean", "description": "Detect sideways or upside-down scans and rotate before OCR.", "default": true }, "min_word_confidence": { "title": "Minimum word confidence", "minimum": 0, "maximum": 100, "type": "integer", "description": "Drop OCR words below this confidence (0-100). Leave at 0 to keep everything and filter on the reported confidence yourself.", "default": 0 }, "max_pages_per_document": { "title": "Max pages per document", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap on pages read per PDF — this is also your cost ceiling: max spend = $0.05 x documents + $0.02 x this number x documents. The default is deliberately modest so a full run finishes inside the run timeout; raise it for long scans.", "default": 20 }, "include_failed_documents": { "title": "Include failed / empty documents in output", "type": "boolean", "description": "If enabled, documents that fail to download or yield no text still appear in the dataset with their status and error.", "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 } } } } } } } } } }