{ "openapi": "3.0.1", "info": { "title": "Image to Text OCR: Read Text from Images & Screenshots", "description": "Extract text from images at public URLs with OCR: PNG, JPEG, WebP, GIF, BMP, multi-page TIFF, HEIC and AVIF. Full text with line breaks, confidence, and optional line or word boxes. 7 languages. Pay only for images where text was found; empty images and errors are free.", "version": "1.0", "x-build-id": "E0AShIKqQGplWA91N" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/private_image_hg9~image-to-text-ocr/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-private_image_hg9-image-to-text-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/private_image_hg9~image-to-text-ocr/runs": { "post": { "operationId": "runs-sync-private_image_hg9-image-to-text-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/private_image_hg9~image-to-text-ocr/run-sync": { "post": { "operationId": "run-sync-private_image_hg9-image-to-text-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": [ "imageUrls" ], "properties": { "imageUrls": { "title": "Image addresses", "type": "array", "description": "One public http(s) address of an image per line: PNG, JPEG, WebP, GIF (first frame), BMP, TIFF (every page), HEIC or AVIF. Each image gets one row. Repeats are read once. Redirects are followed, and an image sent with the wrong content type is still read.", "items": { "type": "string" } }, "languages": { "title": "Languages", "type": "array", "description": "Languages of the text in the images, up to 4. Pick only the ones you need: each extra language makes OCR slower and can add mistakes. English, Spanish, French, German, Italian, Portuguese and Dutch.", "items": { "type": "string", "enum": [ "eng", "spa", "fra", "deu", "ita", "por", "nld" ], "enumTitles": [ "English", "Spanish", "French", "German", "Italian", "Portuguese", "Dutch" ] }, "default": [ "eng" ] }, "detail": { "title": "Detail", "enum": [ "text", "lines", "words" ], "type": "string", "description": "Text: the full text, word and line counts and mean confidence. Lines: also each line with its confidence and box (left, top, width, height in the image's pixels). Words: also each word with its confidence, box and line number.", "default": "text" }, "pageSegmentation": { "title": "Layout", "enum": [ "auto", "auto_rotate", "single_block", "sparse" ], "type": "string", "description": "How the text is laid out. Auto suits documents, scans, receipts and screenshots. Auto + turn upright also detects pages that are sideways or upside down (without a rotation tag) and reads them the right way up. Single block suits a cropped paragraph or one text box. Sparse text suits photos, signs, labels, memes and app screens where words are scattered.", "default": "auto" }, "preprocessing": { "title": "Image cleanup", "enum": [ "auto", "off" ], "type": "string", "description": "Auto turns the image to grayscale, enlarges small images (under 2,000 pixels on the longest side) so letters are big enough to read, stretches the contrast, and inverts light text on a dark background. Off sends the image as it is (still turned upright, with transparency on white, and scaled down if over 40 megapixels).", "default": "auto" }, "imageTimeoutSecs": { "title": "Time limit per image (seconds)", "minimum": 10, "maximum": 900, "type": "integer", "description": "OCR of one image (all pages of a TIFF) stops after this. The row then says so and costs nothing.", "default": 120 } } }, "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 } } } } } } } } } }