{ "openapi": "3.0.3", "info": { "title": "OCR Image to Text - Receipt, Invoice & ID Document Parser", "version": "1.0.0", "description": "AI OCR for images and PDFs: plain text and Markdown (tables kept), plus structured JSON for receipts, invoices, ID documents/passports and your own custom fields. Upload a file (multipart), send base64, or pass a URL. PDFs: up to 5 pages per request. Max 10 MB.\n\nBilling: 1 request per page processed (X-RapidAPI-Billing: Requests=N). Errors, refused URLs, timeouts and unreadable model output are never billed. Documents are processed in memory and deleted immediately; nothing is stored." }, "servers": [ { "url": "https://ocr.cystall.com" } ], "tags": [ { "name": "OCR" }, { "name": "Parse" }, { "name": "Info" } ], "paths": { "/v1/ocr": { "post": { "operationId": "ocr", "tags": [ "OCR" ], "summary": "Image or PDF to text and Markdown", "description": "Extracts all text from an image or PDF in reading order. Returns plain text, GitHub-flavoured Markdown (headings, lists and tables preserved), the main language, and per-page results. Billing: 1 request per page processed.", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "The document: JPEG, PNG, WebP, GIF, BMP image or PDF (first pages up to max_pages). Max 10 MB. Send exactly one of file, base64 or url." }, "base64": { "type": "string", "description": "The document as base64 (a data: URI prefix is accepted). Max 10 MB decoded." }, "url": { "type": "string", "description": "Public http/https URL of the document (ports 80/443, max 3 redirects, 15 s). Private, loopback, link-local and cloud-metadata addresses are refused, also after redirects." }, "max_pages": { "type": "integer", "minimum": 1, "maximum": 5, "default": 5, "description": "PDF only: process at most this many pages from the start. Each processed page is billed as 1 request." }, "language_hint": { "type": "string", "maxLength": 50, "description": "Optional hint such as 'German' or 'ja'. Improves accuracy on mixed or rare scripts." } } } }, "application/json": { "schema": { "type": "object", "properties": { "base64": { "type": "string", "description": "The document as base64 (a data: URI prefix is accepted). Max 10 MB decoded." }, "url": { "type": "string", "description": "Public http/https URL of the document (ports 80/443, max 3 redirects, 15 s). Private, loopback, link-local and cloud-metadata addresses are refused, also after redirects." }, "max_pages": { "type": "integer", "minimum": 1, "maximum": 5, "default": 5, "description": "PDF only: process at most this many pages from the start. Each processed page is billed as 1 request." }, "language_hint": { "type": "string", "maxLength": 50, "description": "Optional hint such as 'German' or 'ja'. Improves accuracy on mixed or rare scripts." } } }, "example": { "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/0/0b/ReceiptSwiss.jpg/500px-ReceiptSwiss.jpg" } } } }, "responses": { "200": { "description": "Text, markdown, language and pages.", "headers": { "X-RapidAPI-Billing": { "schema": { "type": "string" }, "description": "Requests=N, N = pages processed." }, "X-Pages-Processed": { "schema": { "type": "integer" } } }, "content": { "application/json": { "example": { "success": true, "data": { "text": "NORTHWIND CONSULTING LTD\n42 Harbour Road, Dublin D02 X285, Ireland | VAT IE6388047V\n\nInvoice No: INV-2026-0347\nInvoice Date: 15 Oct 2026\nDue Date: 14 Nov 2026\nPO: 7781-B\n\nBill To:\nContoso GmbH\nFriedrichstrasse 12\n10117 Berlin, Germany\nVAT DE811569869\n\nDescription\tQty\tUnit Price\tAmount\nCloud architecture review\t1\t€2,400.00\t€2,400.00\nKubernetes migration (hours)\t32\t€120.00\t€3,840.00\nSecurity audit report\t1\t€1,850.00\t€1,850.00\nMonthly support retainer\t1\t€600.00\t€600.00\n\nSubtotal | | | €8,690.00 |\nVAT 23% | | | €1,998.70 |\nTotal Due | | | €10,688.70 |\n\nPayment: IBAN IE29 AIBK 9311 5212 3456 78 BIC AIBKIE2D", "markdown": "NORTHWIND CONSULTING LTD\n42 Harbour Road, Dublin D02 X285, Ireland | VAT IE6388047V\n\nInvoice No: INV-2026-0347\nInvoice Date: 15 Oct 2026\nDue Date: 14 Nov 2026\nPO: 7781-B\n\nBill To:\nContoso GmbH\nFriedrichstrasse 12\n10117 Berlin, Germany\nVAT DE811569869\n\n| Description | Qty | Unit Price | Amount |\n|------------------------------|-----|--------------|------------|\n| Cloud architecture review | 1 | €2,400.00 | €2,400.00 |\n| Kubernetes migration (hours) | 32 | €120.00 | €3,840.00 |\n| Security audit report | 1 | €1,850.00 | €1,850.00 |\n| Monthly support retainer | 1 | €600.00 | €600.00 |\n\nSubtotal | | | €8,690.00 |\nVAT 23% | | | €1,998.70 |\nTotal Due | | | €10,688.70 |\n\nPayment: IBAN IE29 AIBK 9311 5212 3456 78 BIC AIBKIE2D", "language": "en", "page_count": 1, "pages_total": 1, "truncated": false, "pages": [ { "page": 1, "text": "NORTHWIND CONSULTING LTD\n42 Harbour Road, Dublin D02 X285, Ireland | VAT IE6388047V\n\nInvoice No: INV-2026-0347\nInvoice Date: 15 Oct 2026\nDue Date: 14 Nov 2026\nPO: 7781-B\n\nBill To:\nContoso GmbH\nFriedrichstrasse 12\n10117 Berlin, Germany\nVAT DE811569869\n\nDescription\tQty\tUnit Price\tAmount\nCloud architecture review\t1\t€2,400.00\t€2,400.00\nKubernetes migration (hours)\t32\t€120.00\t€3,840.00\nSecurity audit report\t1\t€1,850.00\t€1,850.00\nMonthly support retainer\t1\t€600.00\t€600.00\n\nSubtotal | | | €8,690.00 |\nVAT 23% | | | €1,998.70 |\nTotal Due | | | €10,688.70 |\n\nPayment: IBAN IE29 AIBK 9311 5212 3456 78 BIC AIBKIE2D", "markdown": "NORTHWIND CONSULTING LTD\n42 Harbour Road, Dublin D02 X285, Ireland | VAT IE6388047V\n\nInvoice No: INV-2026-0347\nInvoice Date: 15 Oct 2026\nDue Date: 14 Nov 2026\nPO: 7781-B\n\nBill To:\nContoso GmbH\nFriedrichstrasse 12\n10117 Berlin, Germany\nVAT DE811569869\n\n| Description | Qty | Unit Price | Amount |\n|------------------------------|-----|--------------|------------|\n| Cloud architecture review | 1 | €2,400.00 | €2,400.00 |\n| Kubernetes migration (hours) | 32 | €120.00 | €3,840.00 |\n| Security audit report | 1 | €1,850.00 | €1,850.00 |\n| Monthly support retainer | 1 | €600.00 | €600.00 |\n\nSubtotal | | | €8,690.00 |\nVAT 23% | | | €1,998.70 |\nTotal Due | | | €10,688.70 |\n\nPayment: IBAN IE29 AIBK 9311 5212 3456 78 BIC AIBKIE2D", "language": "en", "width": 1240, "height": 1754 } ], "source": { "type": "image", "mime": "image/png", "size_bytes": 99723 }, "processing_ms": 2694 }, "meta": { "timestamp": "2026-10-27T18:58:49+00:00" } } } } }, "401": { "description": "Missing or invalid RapidAPI proxy secret." }, "413": { "description": "file_too_large: over 10 MB. Not billed." }, "415": { "description": "unsupported_media_type: not JPEG/PNG/WebP/GIF/BMP/PDF. Not billed." }, "422": { "description": "missing_input, invalid_base64, invalid_image, image_too_large, invalid_pdf, pdf_encrypted, invalid_url, blocked_target, dns_failed, fetch_failed, too_many_redirects or validation_error. Not billed." }, "429": { "description": "Per-minute plan limit reached. Not billed." }, "502": { "description": "model_output_invalid or model_unavailable (after one automatic retry on a second model). Not billed." }, "503": { "description": "daily_capacity_reached / service_unavailable. Retry later (Retry-After header). Not billed." }, "504": { "description": "fetch_timeout or model_timeout. Not billed." } } } }, "/v1/parse/receipt": { "post": { "operationId": "parseReceipt", "tags": [ "Parse" ], "summary": "Receipt to JSON", "description": "Merchant, date, time, receipt number, currency, line items, subtotal, discount, tax, tax rate, tip, total, payment method and card last 4. Numbers are numbers, dates are YYYY-MM-DD, missing values are null. Billing: 1 request per page.", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "The document: JPEG, PNG, WebP, GIF, BMP image or PDF (first pages up to max_pages). Max 10 MB. Send exactly one of file, base64 or url." }, "base64": { "type": "string", "description": "The document as base64 (a data: URI prefix is accepted). Max 10 MB decoded." }, "url": { "type": "string", "description": "Public http/https URL of the document (ports 80/443, max 3 redirects, 15 s). Private, loopback, link-local and cloud-metadata addresses are refused, also after redirects." }, "max_pages": { "type": "integer", "minimum": 1, "maximum": 5, "default": 5, "description": "PDF only: process at most this many pages from the start. Each processed page is billed as 1 request." }, "language_hint": { "type": "string", "maxLength": 50, "description": "Optional hint such as 'German' or 'ja'. Improves accuracy on mixed or rare scripts." } } } }, "application/json": { "schema": { "type": "object", "properties": { "base64": { "type": "string", "description": "The document as base64 (a data: URI prefix is accepted). Max 10 MB decoded." }, "url": { "type": "string", "description": "Public http/https URL of the document (ports 80/443, max 3 redirects, 15 s). Private, loopback, link-local and cloud-metadata addresses are refused, also after redirects." }, "max_pages": { "type": "integer", "minimum": 1, "maximum": 5, "default": 5, "description": "PDF only: process at most this many pages from the start. Each processed page is billed as 1 request." }, "language_hint": { "type": "string", "maxLength": 50, "description": "Optional hint such as 'German' or 'ja'. Improves accuracy on mixed or rare scripts." } } }, "example": { "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/0/0b/ReceiptSwiss.jpg/500px-ReceiptSwiss.jpg" } } } }, "responses": { "200": { "description": "Structured receipt.", "headers": { "X-RapidAPI-Billing": { "schema": { "type": "string" }, "description": "Requests=N, N = pages processed." }, "X-Pages-Processed": { "schema": { "type": "integer" } } }, "content": { "application/json": { "example": { "success": true, "data": { "document_type": "receipt", "data": { "merchant": { "name": "Berghotel Grosse Scheidegg", "address": "3818 Grindelwald", "phone": "033 853 67 16", "tax_id": "430 234" }, "date": "2007-07-30", "time": "13:29", "receipt_number": "4572", "currency": "CHF", "line_items": [ { "description": "Latte Macchiato", "quantity": 2, "unit_price": 4.5, "total": 9 }, { "description": "Gloki", "quantity": 1, "unit_price": 5, "total": 5 }, { "description": "Schweinschnitzel", "quantity": 1, "unit_price": 22, "total": 22 }, { "description": "Chässpätzli", "quantity": 1, "unit_price": 18.5, "total": 18.5 } ], "subtotal": 54.5, "discount": null, "tax": 3.85, "tax_rate": 7.6, "tip": null, "total": 54.5, "payment_method": null, "card_last4": null, "language": "de" }, "page_count": 1, "pages_total": 1, "truncated": false, "source": { "type": "image", "mime": "image/jpeg", "size_bytes": 88568 }, "processing_ms": 2803 }, "meta": { "timestamp": "2026-10-27T19:03:05+00:00" } } } } }, "401": { "description": "Missing or invalid RapidAPI proxy secret." }, "413": { "description": "file_too_large: over 10 MB. Not billed." }, "415": { "description": "unsupported_media_type: not JPEG/PNG/WebP/GIF/BMP/PDF. Not billed." }, "422": { "description": "missing_input, invalid_base64, invalid_image, image_too_large, invalid_pdf, pdf_encrypted, invalid_url, blocked_target, dns_failed, fetch_failed, too_many_redirects or validation_error. Not billed." }, "429": { "description": "Per-minute plan limit reached. Not billed." }, "502": { "description": "model_output_invalid or model_unavailable (after one automatic retry on a second model). Not billed." }, "503": { "description": "daily_capacity_reached / service_unavailable. Retry later (Retry-After header). Not billed." }, "504": { "description": "fetch_timeout or model_timeout. Not billed." } } } }, "/v1/parse/invoice": { "post": { "operationId": "parseInvoice", "tags": [ "Parse" ], "summary": "Invoice to JSON", "description": "Invoice number, dates, PO, currency, seller and buyer (name, address, tax/VAT id, email, phone), line items, subtotal, discount, shipping, tax, total, amount due and payment details (IBAN, BIC, account, terms). Multi-page PDFs are read as one invoice. Billing: 1 request per page.", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "The document: JPEG, PNG, WebP, GIF, BMP image or PDF (first pages up to max_pages). Max 10 MB. Send exactly one of file, base64 or url." }, "base64": { "type": "string", "description": "The document as base64 (a data: URI prefix is accepted). Max 10 MB decoded." }, "url": { "type": "string", "description": "Public http/https URL of the document (ports 80/443, max 3 redirects, 15 s). Private, loopback, link-local and cloud-metadata addresses are refused, also after redirects." }, "max_pages": { "type": "integer", "minimum": 1, "maximum": 5, "default": 5, "description": "PDF only: process at most this many pages from the start. Each processed page is billed as 1 request." }, "language_hint": { "type": "string", "maxLength": 50, "description": "Optional hint such as 'German' or 'ja'. Improves accuracy on mixed or rare scripts." } } } }, "application/json": { "schema": { "type": "object", "properties": { "base64": { "type": "string", "description": "The document as base64 (a data: URI prefix is accepted). Max 10 MB decoded." }, "url": { "type": "string", "description": "Public http/https URL of the document (ports 80/443, max 3 redirects, 15 s). Private, loopback, link-local and cloud-metadata addresses are refused, also after redirects." }, "max_pages": { "type": "integer", "minimum": 1, "maximum": 5, "default": 5, "description": "PDF only: process at most this many pages from the start. Each processed page is billed as 1 request." }, "language_hint": { "type": "string", "maxLength": 50, "description": "Optional hint such as 'German' or 'ja'. Improves accuracy on mixed or rare scripts." } } }, "example": { "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/0/0b/ReceiptSwiss.jpg/500px-ReceiptSwiss.jpg" } } } }, "responses": { "200": { "description": "Structured invoice.", "headers": { "X-RapidAPI-Billing": { "schema": { "type": "string" }, "description": "Requests=N, N = pages processed." }, "X-Pages-Processed": { "schema": { "type": "integer" } } }, "content": { "application/json": { "example": { "success": true, "data": { "document_type": "invoice", "data": { "invoice_number": "INV-2026-0347", "invoice_date": "2026-10-15", "due_date": "2026-11-14", "po_number": "7781-B", "currency": "EUR", "seller": { "name": "NORTHWIND CONSULTING LTD", "address": "42 Harbour Road, Dublin D02 X285, Ireland", "tax_id": "IE6388047V", "email": null, "phone": null }, "buyer": { "name": "Contoso GmbH", "address": "Friedrichstrasse 12, 10117 Berlin, Germany", "tax_id": "DE811569869", "email": null, "phone": null }, "line_items": [ { "description": "Cloud architecture review", "quantity": 1, "unit_price": 2400, "tax_rate": null, "amount": 2400 }, { "description": "Kubernetes migration (hours)", "quantity": 32, "unit_price": 120, "tax_rate": null, "amount": 3840 }, { "description": "Security audit report", "quantity": 1, "unit_price": 1850, "tax_rate": null, "amount": 1850 }, { "description": "Monthly support retainer", "quantity": 1, "unit_price": 600, "tax_rate": null, "amount": 600 } ], "subtotal": 8690, "discount": null, "shipping": null, "tax_rate": 23, "tax_total": 1998.7, "total": 10688.7, "amount_due": 10688.7, "payment": { "terms": null, "iban": "IE29 AIBK 9311 5212 3456 78", "bic": "AIBKIE2D", "account_number": null, "bank_name": null }, "notes": null, "language": "en" }, "page_count": 1, "pages_total": 1, "truncated": false, "source": { "type": "image", "mime": "image/png", "size_bytes": 99723 }, "processing_ms": 3223 }, "meta": { "timestamp": "2026-10-27T18:59:20+00:00" } } } } }, "401": { "description": "Missing or invalid RapidAPI proxy secret." }, "413": { "description": "file_too_large: over 10 MB. Not billed." }, "415": { "description": "unsupported_media_type: not JPEG/PNG/WebP/GIF/BMP/PDF. Not billed." }, "422": { "description": "missing_input, invalid_base64, invalid_image, image_too_large, invalid_pdf, pdf_encrypted, invalid_url, blocked_target, dns_failed, fetch_failed, too_many_redirects or validation_error. Not billed." }, "429": { "description": "Per-minute plan limit reached. Not billed." }, "502": { "description": "model_output_invalid or model_unavailable (after one automatic retry on a second model). Not billed." }, "503": { "description": "daily_capacity_reached / service_unavailable. Retry later (Retry-After header). Not billed." }, "504": { "description": "fetch_timeout or model_timeout. Not billed." } } } }, "/v1/parse/id-document": { "post": { "operationId": "parseIdDocument", "tags": [ "Parse" ], "summary": "ID card, passport or driving licence to JSON", "description": "Document type, issuing country, number, names, birth date, sex, nationality, issue and expiry dates, personal number, address and MRZ lines, plus mrz_valid (ICAO 9303 check digits verified for TD1/TD3). Documents are processed in memory and never stored. Billing: 1 request per page/image.", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "The document: JPEG, PNG, WebP, GIF, BMP image or PDF (first pages up to max_pages). Max 10 MB. Send exactly one of file, base64 or url." }, "base64": { "type": "string", "description": "The document as base64 (a data: URI prefix is accepted). Max 10 MB decoded." }, "url": { "type": "string", "description": "Public http/https URL of the document (ports 80/443, max 3 redirects, 15 s). Private, loopback, link-local and cloud-metadata addresses are refused, also after redirects." }, "max_pages": { "type": "integer", "minimum": 1, "maximum": 5, "default": 5, "description": "PDF only: process at most this many pages from the start. Each processed page is billed as 1 request." }, "language_hint": { "type": "string", "maxLength": 50, "description": "Optional hint such as 'German' or 'ja'. Improves accuracy on mixed or rare scripts." } } } }, "application/json": { "schema": { "type": "object", "properties": { "base64": { "type": "string", "description": "The document as base64 (a data: URI prefix is accepted). Max 10 MB decoded." }, "url": { "type": "string", "description": "Public http/https URL of the document (ports 80/443, max 3 redirects, 15 s). Private, loopback, link-local and cloud-metadata addresses are refused, also after redirects." }, "max_pages": { "type": "integer", "minimum": 1, "maximum": 5, "default": 5, "description": "PDF only: process at most this many pages from the start. Each processed page is billed as 1 request." }, "language_hint": { "type": "string", "maxLength": 50, "description": "Optional hint such as 'German' or 'ja'. Improves accuracy on mixed or rare scripts." } } }, "example": { "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/0/0b/ReceiptSwiss.jpg/500px-ReceiptSwiss.jpg" } } } }, "responses": { "200": { "description": "Structured identity document.", "headers": { "X-RapidAPI-Billing": { "schema": { "type": "string" }, "description": "Requests=N, N = pages processed." }, "X-Pages-Processed": { "schema": { "type": "integer" } } }, "content": { "application/json": { "example": { "success": true, "data": { "document_type": "id_document", "data": { "document_type": "id_card", "issuing_country": "EXL", "document_number": "X7K2938415", "surname": "MARTINEZ GARCIA", "given_names": "ELENA SOFIA", "date_of_birth": "1991-04-12", "sex": "F", "nationality": "EXL", "place_of_birth": null, "issue_date": null, "expiry_date": "2031-09-03", "personal_number": null, "address": null, "mrz": [ "IDEXLX7K2938415<<<<<<<<<<<<<<<<", "9104127F3109031EXL<<<<<<<<<<<<6" ], "mrz_valid": null }, "page_count": 1, "pages_total": 1, "truncated": false, "source": { "type": "image", "mime": "image/png", "size_bytes": 45981 }, "processing_ms": 4022 }, "meta": { "timestamp": "2026-10-27T18:59:29+00:00" } } } } }, "401": { "description": "Missing or invalid RapidAPI proxy secret." }, "413": { "description": "file_too_large: over 10 MB. Not billed." }, "415": { "description": "unsupported_media_type: not JPEG/PNG/WebP/GIF/BMP/PDF. Not billed." }, "422": { "description": "missing_input, invalid_base64, invalid_image, image_too_large, invalid_pdf, pdf_encrypted, invalid_url, blocked_target, dns_failed, fetch_failed, too_many_redirects or validation_error. Not billed." }, "429": { "description": "Per-minute plan limit reached. Not billed." }, "502": { "description": "model_output_invalid or model_unavailable (after one automatic retry on a second model). Not billed." }, "503": { "description": "daily_capacity_reached / service_unavailable. Retry later (Retry-After header). Not billed." }, "504": { "description": "fetch_timeout or model_timeout. Not billed." } } } }, "/v1/parse": { "post": { "operationId": "parseCustom", "tags": [ "Parse" ], "summary": "Extract your own fields (custom schema)", "description": "Send a list of fields (name, type, description) or a JSON Schema with properties, and get exactly those keys back. Types: string, number, integer, boolean, date (YYYY-MM-DD), array, object. Max 40 fields. In multipart requests send fields or schema as a JSON string. Billing: 1 request per page.", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "The document: JPEG, PNG, WebP, GIF, BMP image or PDF (first pages up to max_pages). Max 10 MB. Send exactly one of file, base64 or url." }, "base64": { "type": "string", "description": "The document as base64 (a data: URI prefix is accepted). Max 10 MB decoded." }, "url": { "type": "string", "description": "Public http/https URL of the document (ports 80/443, max 3 redirects, 15 s). Private, loopback, link-local and cloud-metadata addresses are refused, also after redirects." }, "max_pages": { "type": "integer", "minimum": 1, "maximum": 5, "default": 5, "description": "PDF only: process at most this many pages from the start. Each processed page is billed as 1 request." }, "language_hint": { "type": "string", "maxLength": 50, "description": "Optional hint such as 'German' or 'ja'. Improves accuracy on mixed or rare scripts." }, "fields": { "type": "array", "maxItems": 40, "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "type": { "type": "string", "enum": [ "string", "number", "integer", "boolean", "date", "array", "object" ], "default": "string" }, "description": { "type": "string", "maxLength": 300 } } }, "description": "Fields to extract (send fields OR schema)." }, "schema": { "type": "object", "description": "JSON Schema object with properties (send fields OR schema). Max 8 KB." }, "instructions": { "type": "string", "maxLength": 1000, "description": "Optional extra extraction instructions." } } } }, "application/json": { "schema": { "type": "object", "properties": { "base64": { "type": "string", "description": "The document as base64 (a data: URI prefix is accepted). Max 10 MB decoded." }, "url": { "type": "string", "description": "Public http/https URL of the document (ports 80/443, max 3 redirects, 15 s). Private, loopback, link-local and cloud-metadata addresses are refused, also after redirects." }, "max_pages": { "type": "integer", "minimum": 1, "maximum": 5, "default": 5, "description": "PDF only: process at most this many pages from the start. Each processed page is billed as 1 request." }, "language_hint": { "type": "string", "maxLength": 50, "description": "Optional hint such as 'German' or 'ja'. Improves accuracy on mixed or rare scripts." }, "fields": { "type": "array", "maxItems": 40, "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "type": { "type": "string", "enum": [ "string", "number", "integer", "boolean", "date", "array", "object" ], "default": "string" }, "description": { "type": "string", "maxLength": 300 } } }, "description": "Fields to extract (send fields OR schema)." }, "schema": { "type": "object", "description": "JSON Schema object with properties (send fields OR schema). Max 8 KB." }, "instructions": { "type": "string", "maxLength": 1000, "description": "Optional extra extraction instructions." } } }, "example": { "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/0/0b/ReceiptSwiss.jpg/500px-ReceiptSwiss.jpg", "fields": [ { "name": "store", "type": "string" }, { "name": "total", "type": "number", "description": "grand total" }, { "name": "date", "type": "date" } ] } } } }, "responses": { "200": { "description": "Only the requested keys.", "headers": { "X-RapidAPI-Billing": { "schema": { "type": "string" }, "description": "Requests=N, N = pages processed." }, "X-Pages-Processed": { "schema": { "type": "integer" } } }, "content": { "application/json": { "example": { "success": true, "data": { "document_type": "custom", "data": { "vendor": "NORTHWIND CONSULTING LTD", "total": 10688.7, "due": "2026-11-14", "iban": "IE29 AIBK 9311 5212 3456 78", "is_paid": false }, "page_count": 1, "pages_total": 1, "truncated": false, "source": { "type": "image", "mime": "image/png", "size_bytes": 99723 }, "processing_ms": 1807 }, "meta": { "timestamp": "2026-10-27T18:59:32+00:00" } } } } }, "401": { "description": "Missing or invalid RapidAPI proxy secret." }, "413": { "description": "file_too_large: over 10 MB. Not billed." }, "415": { "description": "unsupported_media_type: not JPEG/PNG/WebP/GIF/BMP/PDF. Not billed." }, "422": { "description": "missing_input, invalid_base64, invalid_image, image_too_large, invalid_pdf, pdf_encrypted, invalid_url, blocked_target, dns_failed, fetch_failed, too_many_redirects or validation_error. Not billed." }, "429": { "description": "Per-minute plan limit reached. Not billed." }, "502": { "description": "model_output_invalid or model_unavailable (after one automatic retry on a second model). Not billed." }, "503": { "description": "daily_capacity_reached / service_unavailable. Retry later (Retry-After header). Not billed." }, "504": { "description": "fetch_timeout or model_timeout. Not billed." } } } }, "/v1/document-types": { "get": { "operationId": "documentTypes", "tags": [ "Info" ], "summary": "Supported document types, formats and limits (free)", "description": "Lists the endpoints, their output keys and the limits. Not billed (Requests=0).", "responses": { "200": { "description": "Document types.", "content": { "application/json": { "example": { "success": true, "data": { "formats": [ "image/jpeg", "image/png", "image/webp", "image/gif", "image/bmp", "application/pdf" ], "limits": { "max_pages": 5, "max_file_bytes": 10485760 }, "endpoints": [ { "method": "POST", "path": "/v1/ocr", "document_type": "ocr", "output_keys": [ "text", "markdown", "language", "page_count", "pages_total", "truncated", "pages", "source", "processing_ms" ] }, { "method": "POST", "path": "/v1/parse/receipt", "document_type": "receipt", "output_keys": [ "document_type", "data", "page_count", "pages_total", "truncated", "source", "processing_ms" ] }, { "method": "POST", "path": "/v1/parse/invoice", "document_type": "invoice", "output_keys": [ "document_type", "data", "page_count", "pages_total", "truncated", "source", "processing_ms" ] }, { "method": "POST", "path": "/v1/parse/id-document", "document_type": "id_document", "output_keys": [ "document_type", "data", "page_count", "pages_total", "truncated", "source", "processing_ms" ] }, { "method": "POST", "path": "/v1/parse", "document_type": "custom", "output_keys": [ "document_type", "data", "page_count", "pages_total", "truncated", "source", "processing_ms" ], "inputs": [ "fields", "schema", "instructions" ] } ] }, "meta": { "timestamp": "2026-10-27T18:59:35+00:00" } } } } }, "401": { "description": "Missing or invalid RapidAPI proxy secret." } } } } } }