{ "openapi": "3.0.1", "info": { "title": "Image OCR - Image to Text in Bulk, Tesseract & AI Vision", "description": "Extract text from many images at once: links, web pages or uploaded files. Fast Tesseract mode with line positions, or AI vision for handwriting, receipts, invoices and business cards. From $2 per 1,000 images.", "version": "0.1", "x-build-id": "cIfAU5HQca1LvLnhc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plotpointtech~image-to-text-ocr-bulk/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plotpointtech-image-to-text-ocr-bulk", "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/plotpointtech~image-to-text-ocr-bulk/runs": { "post": { "operationId": "runs-sync-plotpointtech-image-to-text-ocr-bulk", "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/plotpointtech~image-to-text-ocr-bulk/run-sync": { "post": { "operationId": "run-sync-plotpointtech-image-to-text-ocr-bulk", "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": { "imageUrls": { "title": "Image URLs", "type": "array", "description": "Direct links to images (JPG, PNG, WebP, GIF, BMP, TIFF). One result per image.", "default": [ { "url": "https://raw.githubusercontent.com/tesseract-ocr/tessdoc/main/images/eurotext.png" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "pageUrls": { "title": "Web pages (OCR every image on the page)", "type": "array", "description": "Pages whose images should be read. The tool finds the images on each page (img, srcset, og:image) and OCRs them. Pages are fetched without a browser.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "keyValueStoreId": { "title": "Key-value store ID or name", "type": "string", "description": "OCR image files stored in an Apify key-value store (for example files you uploaded or another Actor saved). Pick the store or paste its ID." }, "keyPrefix": { "title": "Key prefix", "type": "string", "description": "Only process key-value store records whose key starts with this text." }, "mode": { "title": "OCR mode", "enum": [ "fast", "ai" ], "type": "string", "description": "Fast uses Tesseract and returns line and block bounding boxes. AI uses a vision model and is far better on handwriting, receipts, screenshots, photos of signs and low-quality images.", "default": "fast" }, "languages": { "title": "Languages (fast mode)", "type": "array", "description": "Languages the text is in. Pick only what you need: each extra language slows OCR. In AI mode this is only a hint.", "items": { "type": "string", "enum": [ "eng", "spa", "fra", "deu", "ita", "por", "nld", "pol", "swe", "ces", "rus", "ukr", "ell", "tur", "ara", "heb", "hin", "chi_sim", "chi_tra", "jpn", "kor", "vie", "tha", "ind" ], "enumTitles": [ "English", "Spanish", "French", "German", "Italian", "Portuguese", "Dutch", "Polish", "Swedish", "Czech", "Russian", "Ukrainian", "Greek", "Turkish", "Arabic", "Hebrew", "Hindi", "Chinese (Simplified)", "Chinese (Traditional)", "Japanese", "Korean", "Vietnamese", "Thai", "Indonesian" ] }, "default": [ "eng" ] }, "autoRotate": { "title": "Auto-rotate (fast mode)", "type": "boolean", "description": "Detect page orientation and turn sideways or upside-down images upright before OCR.", "default": true }, "includeBoundingBoxes": { "title": "Include line and block boxes (fast mode)", "type": "boolean", "description": "Return each text line and block with its position (x, y, width, height in pixels) and confidence.", "default": true }, "includeWords": { "title": "Include word boxes (fast mode)", "type": "boolean", "description": "Also return every word with its box. Makes results much larger.", "default": false }, "structuredData": { "title": "Structured fields (AI mode)", "enum": [ "none", "auto", "receipt", "invoice", "business_card" ], "type": "string", "description": "Also return typed fields for receipts, invoices or business cards. Auto detects which kind the image is.", "default": "none" }, "anthropicApiKey": { "title": "Your own Anthropic API key (AI mode, optional)", "type": "string", "description": "Use your own key and pay a lower per-image price. Stored encrypted and never logged." }, "skipImagesWithoutText": { "title": "Skip images without text", "type": "boolean", "description": "Do not save (or charge for) images where no text was found. Useful for web pages full of photos and icons.", "default": false }, "maxImagesPerPage": { "title": "Max images per page", "minimum": 1, "maximum": 200, "type": "integer", "description": "Limit for each web page.", "default": 20 }, "minImageSize": { "title": "Minimum image size (px)", "minimum": 1, "type": "integer", "description": "Images whose shorter side is smaller than this are skipped without charge (icons, spacers).", "default": 60 }, "maxImages": { "title": "Max images in total", "minimum": 0, "type": "integer", "description": "Stop after this many images. 0 means no limit.", "default": 0 }, "maxConcurrency": { "title": "Images at once", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many images to process in parallel.", "default": 4 } } }, "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 } } } } } } } } } }