openapi-directory/api/cloudmersive.com/ocr.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"The powerful Optical Character Recognition (OCR) APIs let you convert scanned images of pages into recognized text.","title":"ocrapi","version":"v1","x-apisguru-categories":["text"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://cloudmersive.com/images/servers.jpeg"},"x-origin":[{"format":"swagger","url":"https://api.cloudmersive.com/ocr/docs/v1/swagger","version":"2.0"}],"x-providerName":"cloudmersive.com","x-serviceName":"ocr"},"paths":{"/ocr/image/to/lines-with-location":{"post":{"description":"Converts an uploaded image in common formats such as JPEG, PNG into lines/text with location information and other metdata via Optical Character Recognition.  This API is intended to be run on scanned documents.  If you want to OCR photos (e.g. taken with a smart phone camera), be sure to use the photo/toText API instead, as it is designed to unskew the image first.","operationId":"ImageOcr_ImageLinesWithLocation","parameters":[{"description":"Optional, language of the input document, default is English (ENG).  Possible values are ENG (English), ARA (Arabic), ZHO (Chinese - Simplified), ZHO-HANT (Chinese - Traditional), ASM (Assamese), AFR (Afrikaans), AMH (Amharic), AZE (Azerbaijani), AZE-CYRL (Azerbaijani - Cyrillic), BEL (Belarusian), BEN (Bengali), BOD (Tibetan), BOS (Bosnian), BUL (Bulgarian), CAT (Catalan; Valencian), CEB (Cebuano), CES (Czech), CHR (Cherokee), CYM (Welsh), DAN (Danish), DEU (German), DZO (Dzongkha), ELL (Greek), ENM (Archaic/Middle English), EPO (Esperanto), EST (Estonian), EUS (Basque), FAS (Persian), FIN (Finnish), FRA (French), FRK (Frankish), FRM (Middle-French), GLE (Irish), GLG (Galician), GRC (Ancient Greek), HAT (Hatian), HEB (Hebrew), HIN (Hindi), HRV (Croatian), HUN (Hungarian), IKU (Inuktitut), IND (Indonesian), ISL (Icelandic), ITA (Italian), ITA-OLD (Old - Italian), JAV (Javanese), JPN (Japanese), KAN (Kannada), KAT (Georgian), KAT-OLD (Old-Georgian), KAZ (Kazakh), KHM (Central Khmer), KIR (Kirghiz), KOR (Korean), KUR (Kurdish), LAO (Lao), LAT (Latin), LAV (Latvian), LIT (Lithuanian), MAL (Malayalam), MAR (Marathi), MKD (Macedonian), MLT (Maltese), MSA (Malay), MYA (Burmese), NEP (Nepali), NLD (Dutch), NOR (Norwegian), ORI (Oriya), PAN (Panjabi), POL (Polish), POR (Portuguese), PUS (Pushto), RON (Romanian), RUS (Russian), SAN (Sanskrit), SIN (Sinhala), SLK (Slovak), SLV (Slovenian), SPA (Spanish), SPA-OLD (Old Spanish), SQI (Albanian), SRP (Serbian), SRP-LAT (Latin Serbian), SWA (Swahili), SWE (Swedish), SYR (Syriac), TAM (Tamil), TEL (Telugu), TGK (Tajik), TGL (Tagalog), THA (Thai), TIR (Tigrinya), TUR (Turkish), UIG (Uighur), UKR (Ukrainian), URD (Urdu), UZB (Uzbek), UZB-CYR (Cyrillic Uzbek), VIE (Vietnamese), YID (Yiddish)","in":"header","name":"language","required":false,"schema":{"type":"string"}},{"description":"Optional, preprocessing mode, default is 'Auto'.  Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image before OCR is applied; this is recommended).","in":"header","name":"preprocessing","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ImageOcr_ImageLinesWithLocation"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageToLinesWithLocationResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/ImageToLinesWithLocationResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ImageToLinesWithLocationResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ImageToLinesWithLocationResult"}}}}},"security":[{"Apikey":[]}],"summary":"Convert a scanned image into words with location","tags":["ImageOcr"]}},"/ocr/image/to/words-with-location":{"post":{"description":"Converts an uploaded image in common formats such as JPEG, PNG into words/text with location information and other metdata via Optical Character Recognition.  This API is intended to be run on scanned documents.  If you want to OCR photos (e.g. taken with a smart phone camera), be sure to use the photo/toText API instead, as it is designed to unskew the image first.","operationId":"ImageOcr_ImageWordsWithLocation","parameters":[{"description":"Optional, language of the input document, default is English (ENG).  Possible values are ENG (English), ARA (Arabic), ZHO (Chinese - Simplified), ZHO-HANT (Chinese - Traditional), ASM (Assamese), AFR (Afrikaans), AMH (Amharic), AZE (Azerbaijani), AZE-CYRL (Azerbaijani - Cyrillic), BEL (Belarusian), BEN (Bengali), BOD (Tibetan), BOS (Bosnian), BUL (Bulgarian), CAT (Catalan; Valencian), CEB (Cebuano), CES (Czech), CHR (Cherokee), CYM (Welsh), DAN (Danish), DEU (German), DZO (Dzongkha), ELL (Greek), ENM (Archaic/Middle English), EPO (Esperanto), EST (Estonian), EUS (Basque), FAS (Persian), FIN (Finnish), FRA (French), FRK (Frankish), FRM (Middle-French), GLE (Irish), GLG (Galician), GRC (Ancient Greek), HAT (Hatian), HEB (Hebrew), HIN (Hindi), HRV (Croatian), HUN (Hungarian), IKU (Inuktitut), IND (Indonesian), ISL (Icelandic), ITA (Italian), ITA-OLD (Old - Italian), JAV (Javanese), JPN (Japanese), KAN (Kannada), KAT (Georgian), KAT-OLD (Old-Georgian), KAZ (Kazakh), KHM (Central Khmer), KIR (Kirghiz), KOR (Korean), KUR (Kurdish), LAO (Lao), LAT (Latin), LAV (Latvian), LIT (Lithuanian), MAL (Malayalam), MAR (Marathi), MKD (Macedonian), MLT (Maltese), MSA (Malay), MYA (Burmese), NEP (Nepali), NLD (Dutch), NOR (Norwegian), ORI (Oriya), PAN (Panjabi), POL (Polish), POR (Portuguese), PUS (Pushto), RON (Romanian), RUS (Russian), SAN (Sanskrit), SIN (Sinhala), SLK (Slovak), SLV (Slovenian), SPA (Spanish), SPA-OLD (Old Spanish), SQI (Albanian), SRP (Serbian), SRP-LAT (Latin Serbian), SWA (Swahili), SWE (Swedish), SYR (Syriac), TAM (Tamil), TEL (Telugu), TGK (Tajik), TGL (Tagalog), THA (Thai), TIR (Tigrinya), TUR (Turkish), UIG (Uighur), UKR (Ukrainian), URD (Urdu), UZB (Uzbek), UZB-CYR (Cyrillic Uzbek), VIE (Vietnamese), YID (Yiddish)","in":"header","name":"language","required":false,"schema":{"type":"string"}},{"description":"Optional, preprocessing mode, default is 'Auto'.  Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image before OCR is applied; this is recommended).","in":"header","name":"preprocessing","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ImageOcr_ImageLinesWithLocation"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageToWordsWithLocationResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/ImageToWordsWithLocationResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ImageToWordsWithLocationResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ImageToWordsWithLocationResult"}}}}},"security":[{"Apikey":[]}],"summary":"Convert a scanned image into words with location","tags":["ImageOcr"]}},"/ocr/image/toText":{"post":{"description":"Converts an uploaded image in common formats such as JPEG, PNG into text via Optical Character Recognition.  This API is intended to be run on scanned documents.  If you want to OCR photos (e.g. taken with a smart phone camera), be sure to use the photo/toText API instead, as it is designed to unskew the image first.","operationId":"ImageOcr_Post","parameters":[{"description":"Optional, language of the input document, default is English (ENG).  Possible values are ENG (English), ARA (Arabic), ZHO (Chinese - Simplified), ZHO-HANT (Chinese - Traditional), ASM (Assamese), AFR (Afrikaans), AMH (Amharic), AZE (Azerbaijani), AZE-CYRL (Azerbaijani - Cyrillic), BEL (Belarusian), BEN (Bengali), BOD (Tibetan), BOS (Bosnian), BUL (Bulgarian), CAT (Catalan; Valencian), CEB (Cebuano), CES (Czech), CHR (Cherokee), CYM (Welsh), DAN (Danish), DEU (German), DZO (Dzongkha), ELL (Greek), ENM (Archaic/Middle English), EPO (Esperanto), EST (Estonian), EUS (Basque), FAS (Persian), FIN (Finnish), FRA (French), FRK (Frankish), FRM (Middle-French), GLE (Irish), GLG (Galician), GRC (Ancient Greek), HAT (Hatian), HEB (Hebrew), HIN (Hindi), HRV (Croatian), HUN (Hungarian), IKU (Inuktitut), IND (Indonesian), ISL (Icelandic), ITA (Italian), ITA-OLD (Old - Italian), JAV (Javanese), JPN (Japanese), KAN (Kannada), KAT (Georgian), KAT-OLD (Old-Georgian), KAZ (Kazakh), KHM (Central Khmer), KIR (Kirghiz), KOR (Korean), KUR (Kurdish), LAO (Lao), LAT (Latin), LAV (Latvian), LIT (Lithuanian), MAL (Malayalam), MAR (Marathi), MKD (Macedonian), MLT (Maltese), MSA (Malay), MYA (Burmese), NEP (Nepali), NLD (Dutch), NOR (Norwegian), ORI (Oriya), PAN (Panjabi), POL (Polish), POR (Portuguese), PUS (Pushto), RON (Romanian), RUS (Russian), SAN (Sanskrit), SIN (Sinhala), SLK (Slovak), SLV (Slovenian), SPA (Spanish), SPA-OLD (Old Spanish), SQI (Albanian), SRP (Serbian), SRP-LAT (Latin Serbian), SWA (Swahili), SWE (Swedish), SYR (Syriac), TAM (Tamil), TEL (Telugu), TGK (Tajik), TGL (Tagalog), THA (Thai), TIR (Tigrinya), TUR (Turkish), UIG (Uighur), UKR (Ukrainian), URD (Urdu), UZB (Uzbek), UZB-CYR (Cyrillic Uzbek), VIE (Vietnamese), YID (Yiddish)","in":"header","name":"language","required":false,"schema":{"type":"string"}},{"description":"Optional, preprocessing mode, default is 'Auto'.  Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image before OCR is applied; this is recommended).","in":"header","name":"preprocessing","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ImageOcr_ImageLinesWithLocation"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageToTextResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ImageToTextResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ImageToTextResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ImageToTextResponse"}}}}},"security":[{"Apikey":[]}],"summary":"Convert a scanned image into text","tags":["ImageOcr"]}},"/ocr/pdf/to/words-with-location":{"post":{"description":"Converts a PDF into words/text with location information and other metdata via Optical Character Recognition.  This API is intended to be run on scanned documents.  If you want to OCR photos (e.g. taken with a smart phone camera), be sure to use the photo/toText API instead, as it is designed to unskew the image first.","operationId":"PdfOcr_PdfToWordsWithLocation","parameters":[{"description":"Optional, language of the input document, default is English (ENG).  Possible values are ENG (English), ARA (Arabic), ZHO (Chinese - Simplified), ZHO-HANT (Chinese - Traditional), ASM (Assamese), AFR (Afrikaans), AMH (Amharic), AZE (Azerbaijani), AZE-CYRL (Azerbaijani - Cyrillic), BEL (Belarusian), BEN (Bengali), BOD (Tibetan), BOS (Bosnian), BUL (Bulgarian), CAT (Catalan; Valencian), CEB (Cebuano), CES (Czech), CHR (Cherokee), CYM (Welsh), DAN (Danish), DEU (German), DZO (Dzongkha), ELL (Greek), ENM (Archaic/Middle English), EPO (Esperanto), EST (Estonian), EUS (Basque), FAS (Persian), FIN (Finnish), FRA (French), FRK (Frankish), FRM (Middle-French), GLE (Irish), GLG (Galician), GRC (Ancient Greek), HAT (Hatian), HEB (Hebrew), HIN (Hindi), HRV (Croatian), HUN (Hungarian), IKU (Inuktitut), IND (Indonesian), ISL (Icelandic), ITA (Italian), ITA-OLD (Old - Italian), JAV (Javanese), JPN (Japanese), KAN (Kannada), KAT (Georgian), KAT-OLD (Old-Georgian), KAZ (Kazakh), KHM (Central Khmer), KIR (Kirghiz), KOR (Korean), KUR (Kurdish), LAO (Lao), LAT (Latin), LAV (Latvian), LIT (Lithuanian), MAL (Malayalam), MAR (Marathi), MKD (Macedonian), MLT (Maltese), MSA (Malay), MYA (Burmese), NEP (Nepali), NLD (Dutch), NOR (Norwegian), ORI (Oriya), PAN (Panjabi), POL (Polish), POR (Portuguese), PUS (Pushto), RON (Romanian), RUS (Russian), SAN (Sanskrit), SIN (Sinhala), SLK (Slovak), SLV (Slovenian), SPA (Spanish), SPA-OLD (Old Spanish), SQI (Albanian), SRP (Serbian), SRP-LAT (Latin Serbian), SWA (Swahili), SWE (Swedish), SYR (Syriac), TAM (Tamil), TEL (Telugu), TGK (Tajik), TGL (Tagalog), THA (Thai), TIR (Tigrinya), TUR (Turkish), UIG (Uighur), UKR (Ukrainian), URD (Urdu), UZB (Uzbek), UZB-CYR (Cyrillic Uzbek), VIE (Vietnamese), YID (Yiddish)","in":"header","name":"language","required":false,"schema":{"type":"string"}},{"description":"Optional, preprocessing mode, default is 'Auto'.  Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image before OCR is applied; this is recommended).","in":"header","name":"preprocessing","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ImageOcr_ImageLinesWithLocation"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfToWordsWithLocationResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/PdfToWordsWithLocationResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PdfToWordsWithLocationResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PdfToWordsWithLocationResult"}}}}},"security":[{"Apikey":[]}],"summary":"Convert a PDF into words with location","tags":["PdfOcr"]}},"/ocr/pdf/toText":{"post":{"operationId":"PdfOcr_Post","parameters":[{"description":"Optional, language of the input document, default is English (ENG).  Possible values are ENG (English), ARA (Arabic), ZHO (Chinese - Simplified), ZHO-HANT (Chinese - Traditional), ASM (Assamese), AFR (Afrikaans), AMH (Amharic), AZE (Azerbaijani), AZE-CYRL (Azerbaijani - Cyrillic), BEL (Belarusian), BEN (Bengali), BOD (Tibetan), BOS (Bosnian), BUL (Bulgarian), CAT (Catalan; Valencian), CEB (Cebuano), CES (Czech), CHR (Cherokee), CYM (Welsh), DAN (Danish), DEU (German), DZO (Dzongkha), ELL (Greek), ENM (Archaic/Middle English), EPO (Esperanto), EST (Estonian), EUS (Basque), FAS (Persian), FIN (Finnish), FRA (French), FRK (Frankish), FRM (Middle-French), GLE (Irish), GLG (Galician), GRC (Ancient Greek), HAT (Hatian), HEB (Hebrew), HIN (Hindi), HRV (Croatian), HUN (Hungarian), IKU (Inuktitut), IND (Indonesian), ISL (Icelandic), ITA (Italian), ITA-OLD (Old - Italian), JAV (Javanese), JPN (Japanese), KAN (Kannada), KAT (Georgian), KAT-OLD (Old-Georgian), KAZ (Kazakh), KHM (Central Khmer), KIR (Kirghiz), KOR (Korean), KUR (Kurdish), LAO (Lao), LAT (Latin), LAV (Latvian), LIT (Lithuanian), MAL (Malayalam), MAR (Marathi), MKD (Macedonian), MLT (Maltese), MSA (Malay), MYA (Burmese), NEP (Nepali), NLD (Dutch), NOR (Norwegian), ORI (Oriya), PAN (Panjabi), POL (Polish), POR (Portuguese), PUS (Pushto), RON (Romanian), RUS (Russian), SAN (Sanskrit), SIN (Sinhala), SLK (Slovak), SLV (Slovenian), SPA (Spanish), SPA-OLD (Old Spanish), SQI (Albanian), SRP (Serbian), SRP-LAT (Latin Serbian), SWA (Swahili), SWE (Swedish), SYR (Syriac), TAM (Tamil), TEL (Telugu), TGK (Tajik), TGL (Tagalog), THA (Thai), TIR (Tigrinya), TUR (Turkish), UIG (Uighur), UKR (Ukrainian), URD (Urdu), UZB (Uzbek), UZB-CYR (Cyrillic Uzbek), VIE (Vietnamese), YID (Yiddish)","in":"header","name":"language","required":false,"schema":{"type":"string"}},{"description":"Optional, preprocessing mode, default is 'Auto'.  Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image before OCR is applied; this is recommended).","in":"header","name":"preprocessing","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ImageOcr_ImageLinesWithLocation"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfToTextResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/PdfToTextResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PdfToTextResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PdfToTextResponse"}}}}},"security":[{"Apikey":[]}],"summary":"Converts an uploaded image in common formats such as JPEG, PNG into text via Optical Character Recognition.","tags":["PdfOcr"]}},"/ocr/photo/toText":{"post":{"description":"Converts an uploaded photo of a document in common formats such as JPEG, PNG into text via Optical Character Recognition.  This API is intended to be run on photos of documents, e.g. taken with a smartphone and supports cases where other content, such as a desk, are in the frame and the camera is crooked.  If you want to OCR a scanned image, use the image/toText API call instead as it is designed for scanned images.","operationId":"ImageOcr_PhotoToText","parameters":[{"description":"Optional, language of the input document, default is English (ENG).  Possible values are ENG (English), ARA (Arabic), ZHO (Chinese - Simplified), ZHO-HANT (Chinese - Traditional), ASM (Assamese), AFR (Afrikaans), AMH (Amharic), AZE (Azerbaijani), AZE-CYRL (Azerbaijani - Cyrillic), BEL (Belarusian), BEN (Bengali), BOD (Tibetan), BOS (Bosnian), BUL (Bulgarian), CAT (Catalan; Valencian), CEB (Cebuano), CES (Czech), CHR (Cherokee), CYM (Welsh), DAN (Danish), DEU (German), DZO (Dzongkha), ELL (Greek), ENM (Archaic/Middle English), EPO (Esperanto), EST (Estonian), EUS (Basque), FAS (Persian), FIN (Finnish), FRA (French), FRK (Frankish), FRM (Middle-French), GLE (Irish), GLG (Galician), GRC (Ancient Greek), HAT (Hatian), HEB (Hebrew), HIN (Hindi), HRV (Croatian), HUN (Hungarian), IKU (Inuktitut), IND (Indonesian), ISL (Icelandic), ITA (Italian), ITA-OLD (Old - Italian), JAV (Javanese), JPN (Japanese), KAN (Kannada), KAT (Georgian), KAT-OLD (Old-Georgian), KAZ (Kazakh), KHM (Central Khmer), KIR (Kirghiz), KOR (Korean), KUR (Kurdish), LAO (Lao), LAT (Latin), LAV (Latvian), LIT (Lithuanian), MAL (Malayalam), MAR (Marathi), MKD (Macedonian), MLT (Maltese), MSA (Malay), MYA (Burmese), NEP (Nepali), NLD (Dutch), NOR (Norwegian), ORI (Oriya), PAN (Panjabi), POL (Polish), POR (Portuguese), PUS (Pushto), RON (Romanian), RUS (Russian), SAN (Sanskrit), SIN (Sinhala), SLK (Slovak), SLV (Slovenian), SPA (Spanish), SPA-OLD (Old Spanish), SQI (Albanian), SRP (Serbian), SRP-LAT (Latin Serbian), SWA (Swahili), SWE (Swedish), SYR (Syriac), TAM (Tamil), TEL (Telugu), TGK (Tajik), TGL (Tagalog), THA (Thai), TIR (Tigrinya), TUR (Turkish), UIG (Uighur), UKR (Ukrainian), URD (Urdu), UZB (Uzbek), UZB-CYR (Cyrillic Uzbek), VIE (Vietnamese), YID (Yiddish)","in":"header","name":"language","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ImageOcr_ImageLinesWithLocation"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageToTextResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ImageToTextResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ImageToTextResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ImageToTextResponse"}}}}},"security":[{"Apikey":[]}],"summary":"Convert a photo of a document into text","tags":["ImageOcr"]}},"/ocr/preprocessing/image/unrotate":{"post":{"description":"Detect and unrotate an image of a document (e.g. that was scanned at an angle).  Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.","operationId":"Preprocessing_Unrotate","requestBody":{"$ref":"#/components/requestBodies/ImageOcr_ImageLinesWithLocation"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}}}}},"security":[{"Apikey":[]}],"summary":"Detect and unrotate a document image","tags":["Preprocessing"]}},"/ocr/preprocessing/image/unskew":{"post":{"description":"Detect and unskew a photo of a document (e.g. taken on a cell phone) into a perfectly square image.  Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.","operationId":"Preprocessing_Unskew","requestBody":{"$ref":"#/components/requestBodies/ImageOcr_ImageLinesWithLocation"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}}}}},"security":[{"Apikey":[]}],"summary":"Detect and unskew a photo of a document","tags":["Preprocessing"]}}},"servers":[{"url":"https://api.cloudmersive.com"}],"components":{"requestBodies":{"ImageOcr_ImageLinesWithLocation":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"imageFile":{"description":"Image file to perform OCR on.  Common file formats such as PNG, JPEG are supported.","type":"string","format":"binary"}},"required":["imageFile"]}}}}},"securitySchemes":{"Apikey":{"description":"API Key Authentication","in":"header","name":"Apikey","type":"apiKey"}},"schemas":{"ImageToLinesWithLocationResult":{"description":"Result of an image to lines-with-location OCR operation","properties":{"Lines":{"description":"Words in the image","items":{"$ref":"#/components/schemas/OcrLineElement"},"type":"array"},"Successful":{"type":"boolean"}},"type":"object"},"ImageToTextResponse":{"description":"Response from an OCR to text operation.  Includes the confience rating and converted text result.","properties":{"MeanConfidenceLevel":{"description":"Confidence level rating of the OCR operation; ratings above 80% are strong.","format":"float","type":"number"},"TextResult":{"description":"Converted text string from the image input.","type":"string"}},"type":"object"},"ImageToWordsWithLocationResult":{"description":"Result of an image to words-with-location OCR operation","properties":{"Successful":{"type":"boolean"},"Words":{"description":"Word elements in the image","items":{"$ref":"#/components/schemas/OcrWordElement"},"type":"array"}},"type":"object"},"OcrLineElement":{"description":"A contiguous line of text in an OCR document","properties":{"LineText":{"description":"Text of the line","type":"string"},"Words":{"description":"Word objects in the line","items":{"$ref":"#/components/schemas/OcrWordElement"},"type":"array"}},"type":"object"},"OcrPageResult":{"properties":{"MeanConfidenceLevel":{"description":"Confidence level rating of the OCR operation; ratings above 80% are strong.","format":"float","type":"number"},"PageNumber":{"description":"Page number of the page that was OCR-ed, starting with 1 for the first page in the PDF file","format":"int32","type":"integer"},"TextResult":{"description":"Converted text string from the image input.","type":"string"}},"type":"object"},"OcrPageResultWithWordsWithLocation":{"properties":{"PageNumber":{"description":"Page number of the page that was OCR-ed, starting with 1 for the first page in the PDF file","format":"int32","type":"integer"},"Successful":{"type":"boolean"},"Words":{"description":"Word elements in the image","items":{"$ref":"#/components/schemas/OcrWordElement"},"type":"array"}},"type":"object"},"OcrWordElement":{"description":"A single word in an OCR document","properties":{"BlockNumber":{"description":"Index of the containing block","format":"int32","type":"integer"},"ConfidenceLevel":{"description":"Confidence level of the machine learning result; possible values are 0.0 (lowest accuracy) - 1.0 (highest accuracy)","format":"double","type":"number"},"Height":{"description":"Height of the word in pixels","format":"int32","type":"integer"},"LineNumber":{"description":"Line number of the word","format":"int32","type":"integer"},"PageNumber":{"description":"Index of the containing page","format":"int32","type":"integer"},"ParagraphNumber":{"description":"Index of the containing paragraph","format":"int32","type":"integer"},"Width":{"description":"Width of the word in pixels","format":"int32","type":"integer"},"WordNumber":{"description":"Index of the word in the line","format":"int32","type":"integer"},"WordText":{"description":"Text of the word","type":"string"},"XLeft":{"description":"X location of the left edge of the word in pixels","format":"int32","type":"integer"},"YTop":{"description":"Y location of the top edge of the word in pixels","format":"int32","type":"integer"}},"type":"object"},"PdfToTextResponse":{"description":"Response from an OCR to text operation.  Includes the confience rating and converted text result.","properties":{"OcrPages":{"items":{"$ref":"#/components/schemas/OcrPageResult"},"type":"array"},"Successful":{"type":"boolean"}},"type":"object"},"PdfToWordsWithLocationResult":{"description":"Response from an OCR to words with location operation.  Includes the confience rating and converted text result, along with the locations of the words in the pages.","properties":{"OcrPages":{"items":{"$ref":"#/components/schemas/OcrPageResultWithWordsWithLocation"},"type":"array"},"Successful":{"type":"boolean"}},"type":"object"}}}}