{ "openapi": "3.0.1", "info": { "title": "Image OCR Extractor 🖼️ (image to text extractor)", "description": "OCR for images: image to text with line and word boxes, confidence and orientation. PNG, JPG, WebP, GIF, BMP, TIFF. Clean-up for low-res photos, 7 languages. No API key.", "version": "0.1", "x-build-id": "tjBkr4lXSrvCyypA3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tagadanar~image-ocr-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tagadanar-image-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/tagadanar~image-ocr-extractor/runs": { "post": { "operationId": "runs-sync-tagadanar-image-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/tagadanar~image-ocr-extractor/run-sync": { "post": { "operationId": "run-sync-tagadanar-image-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", "properties": { "urls": { "title": "Image links", "type": "array", "description": "Links to images, one per line (or upload a list). PNG, JPG, WebP, GIF, BMP and TIFF work. Any public https link works, including files stored in an Apify key-value store. Animated GIFs and multi-page TIFFs use their first frame.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "output": { "title": "Output detail", "enum": [ "text", "lines", "words" ], "type": "string", "description": "Text: the recognized text and its confidence. Lines: also every line with its box and confidence. Words: also every word with its box and confidence. Boxes are in pixels of the upright original image.", "default": "lines" }, "languages": { "title": "Languages", "maxItems": 2, "type": "array", "description": "Languages printed in the images. Pick up to 2 for mixed text; each extra language slows OCR.", "items": { "type": "string", "enum": [ "eng", "fra", "deu", "spa", "ita", "por", "nld" ], "enumTitles": [ "English", "French", "German", "Spanish", "Italian", "Portuguese", "Dutch" ] }, "default": [ "eng" ] }, "imageType": { "title": "What the image contains", "enum": [ "document", "block", "line", "sparse" ], "type": "string", "description": "Helps the reader pick the right layout. Document suits scans, screenshots and photos of pages with columns or paragraphs. Use a single block for one paragraph, a single line for a cropped line (captcha-free codes, labels, plates), or scattered text for signs, memes and UI screenshots.", "default": "document" }, "preprocessing": { "title": "Image clean-up", "enum": [ "auto", "none", "grayscale", "threshold" ], "type": "string", "description": "Auto converts to grayscale, boosts contrast, enlarges small images and retries a weak read with a hard black-and-white copy. Pick another option to force one treatment or none.", "default": "auto" }, "autoRotate": { "title": "Fix sideways and upside-down images", "type": "boolean", "description": "When a read is weak or the text runs vertically, detect the orientation and read the image again turned upright. The turn applied is reported as orientationDegrees.", "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 }, "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 } } } } } } } } } }