{ "openapi": "3.0.1", "info": { "title": "OCR API: Image to Text & PDF to Text (Scanned PDFs)", "description": "Image to text and PDF to text with Tesseract OCR in 11 languages. Reads the PDF text layer first, OCR for scans. One row per page with text, confidence and line boxes. Errors are never charged.", "version": "1.0", "x-build-id": "Sm4bq1vAdIY7rfp6a" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/altronite~image-pdf-ocr/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-altronite-image-pdf-ocr", "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/altronite~image-pdf-ocr/runs": { "post": { "operationId": "runs-sync-altronite-image-pdf-ocr", "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/altronite~image-pdf-ocr/run-sync": { "post": { "operationId": "run-sync-altronite-image-pdf-ocr", "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": [ "sources" ], "properties": { "sources": { "title": "Image and PDF links", "type": "array", "description": "Public http(s) links to images (PNG, JPEG, WebP, TIFF, BMP, GIF) or PDFs, up to 50 MB each and 1,000 per run. The file type is detected from the file itself, not the link.", "items": { "type": "string" } }, "languages": { "title": "Languages", "type": "array", "description": "Languages in the text, up to 3. Pages in several languages work best when you list all of them. Fewer languages is faster and more accurate.", "items": { "type": "string", "enum": [ "eng", "hin", "spa", "fra", "deu", "por", "ita", "ara", "rus", "chi_sim", "jpn" ], "enumTitles": [ "English", "Hindi", "Spanish", "French", "German", "Portuguese", "Italian", "Arabic", "Russian", "Chinese (Simplified)", "Japanese" ] }, "default": [ "eng" ] }, "pdfMode": { "title": "PDF mode", "enum": [ "auto", "ocr", "text" ], "type": "string", "description": "Auto reads the text already inside a PDF page and runs OCR only on pages that have none (scans). Choose OCR to force it on every page; choose text to skip OCR completely.", "default": "auto" }, "maxPagesPerPdf": { "title": "Max pages per PDF", "minimum": 1, "maximum": 500, "type": "integer", "description": "Only the first pages of a longer PDF are processed. The rest is reported as one uncharged page_limit row.", "default": 50 }, "outputFormat": { "title": "Output format", "enum": [ "text", "lines" ], "type": "string", "description": "Text is always included. Lines adds a lines array with each line's text, confidence and bounding box [left, top, width, height] in pixels.", "default": "text" } } }, "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 } } } } } } } } } }