{ "openapi": "3.0.1", "info": { "title": "Receipt OCR API", "description": "Receipt OCR API - Multi-Model Text Extraction : \nExtract structured data from receipt images using advanced OCR technology with support for multiple AI models including Google Vision, OpenAI, Azure, AWS Textract, Gemini, Hugging Face, DeepSeek, and Native OCR.", "version": "0.0", "x-build-id": "tfrgnTFgvO0Bih0Ap" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/happitap~receipt-ocr-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-happitap-receipt-ocr-api", "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/happitap~receipt-ocr-api/runs": { "post": { "operationId": "runs-sync-happitap-receipt-ocr-api", "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/happitap~receipt-ocr-api/run-sync": { "post": { "operationId": "run-sync-happitap-receipt-ocr-api", "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": [ "ocrModel", "receiptUrls" ], "properties": { "ocrModel": { "title": "OCR Model", "enum": [ "google-vision", "deepseek-ocr", "amazon-textract", "azure-vision", "openai", "huggingface", "gemini", "native" ], "type": "string", "description": "Select the OCR model to use for text extraction", "default": "native" }, "receiptUrls": { "title": "Receipt Image URLs", "minItems": 1, "type": "array", "description": "Array of receipt image URLs to process (supports JPG, PNG, PDF)", "items": { "type": "string" } }, "googleVisionApiKey": { "title": "Google Vision API Key", "type": "string", "description": "Required if using Google Vision API" }, "deepseekApiKey": { "title": "DeepSeek API Key", "type": "string", "description": "Required if using DeepSeek OCR" }, "awsAccessKeyId": { "title": "AWS Access Key ID", "type": "string", "description": "Required if using Amazon Textract" }, "awsSecretAccessKey": { "title": "AWS Secret Access Key", "type": "string", "description": "Required if using Amazon Textract" }, "awsRegion": { "title": "AWS Region", "type": "string", "description": "AWS region for Textract (e.g., us-east-1)", "default": "us-east-1" }, "azureEndpoint": { "title": "Azure Vision Endpoint", "type": "string", "description": "Required if using Azure AI Vision" }, "azureApiKey": { "title": "Azure Vision API Key", "type": "string", "description": "Required if using Azure AI Vision" }, "openaiApiKey": { "title": "OpenAI API Key", "type": "string", "description": "Required if using OpenAI GPT-4 Vision" }, "huggingfaceApiKey": { "title": "Hugging Face API Key", "type": "string", "description": "Required if using Hugging Face models" }, "geminiApiKey": { "title": "Google Gemini API Key", "type": "string", "description": "Required if using Gemini API" }, "extractLineItems": { "title": "Extract Line Items", "type": "boolean", "description": "Extract individual line items from receipt", "default": true }, "verifyCalculations": { "title": "Verify Calculations", "type": "boolean", "description": "Verify totals and tax calculations", "default": true }, "outputFormat": { "title": "Output Format", "enum": [ "json", "detailed" ], "type": "string", "description": "Format for extracted data", "default": "detailed" } } }, "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 } } } } } } } } } }