Skip to main content
Server path: /ocr | Type: Embedded | PCID required: No Extract text from images and PDF files using OCR. Supports 30+ languages, synchronous and asynchronous processing, and detailed layout analysis with bounding boxes.

Tools

ToolDescription
ocr_processExtract text from images and PDFs

ocr_process

Extract text from one or more images or PDF files using Optical Character Recognition. Parameters:
ParameterTypeRequiredDefaultDescription
fileUrlsstring[]YesURLs of the image or PDF files to process
languageHintsenum[]NoLanguage hints to improve OCR accuracy: "eng", "spa", "fra", "deu", "ita", "por", "rus", "chi_sim", "chi_tra", "jpn", "kor", "nld", "pol", "tur", "ara", "hin", "tha", "vie", "ukr", "ces", "hun", "ron", "bul", "hrv", "slk", "slv", "lit", "lav", "est", "fin", "swe", "nor", "dan", "ell", "heb"
extractTextOnlybooleanNotrueWhen true, returns only extracted text. When false, includes detailed layout analysis with bounding boxes.
collectionIdstringNoCollection ID to store the OCR results
asyncbooleanNofalseWhether to process asynchronously
Response fields:
FieldTypeDescription
artifactIdstringID of the OCR result artifact
artifactNamestringName of the OCR result artifact
artifactUrlstringURL to access the OCR results
mimeTypestringMIME type of the result