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","servers":[{"url":"https://api.cloudmersive.com"}],"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://api.cloudmersive.com/Content/cloudmersive.png"},"x-origin":[{"format":"swagger","url":"https://api.cloudmersive.com/ocr/docs/v1/swagger","version":"2.0"},{"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.  Note: for free tier API keys, it is required to add a credit card to your account for security reasons, to use the free tier key with this API.","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_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageToLinesWithLocationResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ImageToLinesWithLocationResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/ImageToLinesWithLocationResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ImageToLinesWithLocationResult"}}},"description":"OK"}},"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.  Note: for free tier API keys, it is required to add a credit card to your account for security reasons, to use the free tier key with this API.","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_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageToWordsWithLocationResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ImageToWordsWithLocationResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/ImageToWordsWithLocationResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ImageToWordsWithLocationResult"}}},"description":"OK"}},"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.  Note: for free tier API keys, it is required to add a credit card to your account for security reasons, to use the free tier key with this API.","operationId":"ImageOcr_Post","parameters":[{"description":"Optional; possible values are 'Basic' which provides basic recognition and is not resillient to page rotation, skew or low quality images uses 1-2 API calls; 'Normal' which provides highly fault tolerant OCR recognition uses 26-30 API calls; and 'Advanced' which provides the highest quality and most fault-tolerant recognition uses 28-30 API calls.  Default recognition mode is 'Advanced'","in":"header","name":"recognitionMode","required":false,"schema":{"type":"string"}},{"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_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageToTextResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ImageToTextResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ImageToTextResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ImageToTextResponse"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Convert a scanned image into text","tags":["ImageOcr"]}},"/ocr/pdf/get-job-status":{"get":{"operationId":"PdfOcr_GetAsyncJobStatus","parameters":[{"in":"query","name":"AsyncJobID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfToTextResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PdfToTextResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/PdfToTextResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PdfToTextResponse"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Returns the result of the Async Job - possible states can be STARTED or COMPLETED","tags":["PdfOcr"]}},"/ocr/pdf/to/lines-with-location":{"post":{"description":"Converts a PDF 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":"PdfOcr_PdfToLinesWithLocation","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/PdfOcr_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfToLinesWithLocationResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PdfToLinesWithLocationResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/PdfToLinesWithLocationResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PdfToLinesWithLocationResult"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Convert a PDF into text lines with location","tags":["PdfOcr"]}},"/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/PdfOcr_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfToWordsWithLocationResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PdfToWordsWithLocationResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/PdfToWordsWithLocationResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PdfToWordsWithLocationResult"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Convert a PDF into words with location","tags":["PdfOcr"]}},"/ocr/pdf/toText":{"post":{"operationId":"PdfOcr_Post","parameters":[{"description":"Optional; possible values are 'Basic' which provides basic recognition and is not resillient to page rotation, skew or low quality images uses 1-2 API calls per page; 'Normal' which provides highly fault tolerant OCR recognition uses 26-30 API calls per page; and 'Advanced' which provides the highest quality and most fault-tolerant recognition uses 28-30 API calls per page.  Default recognition mode is 'Basic'","in":"header","name":"recognitionMode","required":false,"schema":{"type":"string"}},{"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/PdfOcr_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfToTextResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PdfToTextResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/PdfToTextResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PdfToTextResponse"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Converts an uploaded PDF file into text via Optical Character Recognition.","tags":["PdfOcr"]}},"/ocr/photo/recognize/business-card":{"post":{"description":"Analyzes a photograph of a business card as input, and outputs key business information such as the name of the person, name of the business, the address of the business, the phone number, the email address and more.  Note: for free tier API keys, it is required to add a credit card to your account for security reasons, to use the free tier key with this API.","operationId":"ImageOcr_PhotoRecognizeBusinessCard","requestBody":{"$ref":"#/components/requestBodies/ImageOcr_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCardRecognitionResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BusinessCardRecognitionResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/BusinessCardRecognitionResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/BusinessCardRecognitionResult"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Recognize a photo of a business card, extract key business information","tags":["ImageOcr"]}},"/ocr/photo/recognize/form":{"post":{"description":"Analyzes a photograph of a form as input, and outputs key business fields and information.  Customzie data to be extracted by defining fields for the form.  Note: for free tier API keys, it is required to add a credit card to your account for security reasons, to use the free tier key with this API.","operationId":"ImageOcr_PhotoRecognizeForm","parameters":[{"description":"Form field definitions","in":"header","name":"formTemplateDefinition","required":false,"schema":{"$ref":"#/components/schemas/FormDefinitionTemplate","type":"application/json"}},{"description":"Optional, enable advanced recognition mode by specifying 'Advanced', enable handwriting recognition by specifying 'EnableHandwriting'.  Default is disabled.","in":"header","name":"recognitionMode","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 - including automatic unrotation of the image - before OCR is applied; this is recommended).  Set this to 'None' if you do not want to use automatic image unrotation and enhancement.","in":"header","name":"preprocessing","required":false,"schema":{"type":"string"}},{"description":"Optional, diagnostics mode, default is 'false'.  Possible values are 'true' (will set DiagnosticImage to a diagnostic PNG image in the result), and 'false' (no diagnostics are enabled; this is recommended for best performance).","in":"header","name":"diagnostics","required":false,"schema":{"type":"string"}},{"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_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormRecognitionResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/FormRecognitionResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/FormRecognitionResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/FormRecognitionResult"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Recognize a photo of a form, extract key fields and business information","tags":["ImageOcr"]}},"/ocr/photo/recognize/form/advanced":{"post":{"description":"Analyzes a photograph of a form as input, and outputs key business fields and information.  Customzie data to be extracted by defining fields for the form.  Uses template definitions stored in Cloudmersive Configuration; to configure stored templates in a configuration bucket, log into Cloudmersive Management Portal and navigate to Settings > API Configuration > Create Bucket.  Note: for free tier API keys, it is required to add a credit card to your account for security reasons, to use the free tier key with this API.","operationId":"ImageOcr_PhotoRecognizeFormAdvanced","parameters":[{"description":"Bucket ID of the Configuration Bucket storing the form templates","in":"header","name":"bucketID","required":false,"schema":{"type":"string"}},{"description":"Bucket Secret Key of the Configuration Bucket storing the form templates","in":"header","name":"bucketSecretKey","required":false,"schema":{"type":"string"}},{"description":"Optional, enable advanced recognition mode by specifying 'Advanced', enable handwriting recognition by specifying 'EnableHandwriting'.  Default is disabled.","in":"header","name":"recognitionMode","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 - including automatic unrotation of the image - before OCR is applied; this is recommended).  Set this to 'None' if you do not want to use automatic image unrotation and enhancement.","in":"header","name":"preprocessing","required":false,"schema":{"type":"string"}},{"description":"Optional, diagnostics mode, default is 'false'.  Possible values are 'true' (will set DiagnosticImage to a diagnostic PNG image in the result), and 'false' (no diagnostics are enabled; this is recommended for best performance).","in":"header","name":"diagnostics","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ImageOcr_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormRecognitionResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/FormRecognitionResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/FormRecognitionResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/FormRecognitionResult"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Recognize a photo of a form, extract key fields using stored templates","tags":["ImageOcr"]}},"/ocr/photo/recognize/receipt":{"post":{"description":"Analyzes a photograph of a receipt as input, and outputs key business information such as the name of the business, the address of the business, the phone number of the business, the total of the receipt, the date of the receipt, and more.  Note: for free tier API keys, it is required to add a credit card to your account for security reasons, to use the free tier key with this API.","operationId":"ImageOcr_PhotoRecognizeReceipt","parameters":[{"description":"Optional, enable advanced recognition mode by specifying 'Advanced', enable handwriting recognition by specifying 'EnableHandwriting'.  Default is disabled.","in":"header","name":"recognitionMode","required":false,"schema":{"type":"string"}},{"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 'None'.  Possible values are None (no preprocessing of the image), and 'Advanced' (automatic image enhancement of the image before OCR is applied; this is recommended and needed to handle rotated receipts).","in":"header","name":"preprocessing","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ImageOcr_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptRecognitionResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReceiptRecognitionResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/ReceiptRecognitionResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ReceiptRecognitionResult"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Recognize a photo of a receipt, extract key business information","tags":["ImageOcr"]}},"/ocr/photo/to/words-with-location":{"post":{"description":"Converts a photo of a document or receipt 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 photographs of documents.  If you want to OCR scanned documents (e.g. taken with a scanner), be sure to use the image/toText API instead, as it is designed for that use case.  Note: for free tier API keys, it is required to add a credit card to your account for security reasons, to use the free tier key with this API.","operationId":"ImageOcr_PhotoWordsWithLocation","parameters":[{"description":"Optional; possible values are 'Normal' which provides highly fault tolerant OCR recognition uses 26-30 API calls; and 'Advanced' which provides the highest quality and most fault-tolerant recognition uses 28-30 API calls.  Default recognition mode is 'Advanced'","in":"header","name":"recognitionMode","required":false,"schema":{"type":"string"}},{"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"}},{"description":"Optional, diagnostics mode, default is 'false'.  Possible values are 'true' (will set DiagnosticImage to a diagnostic PNG image in the result), and 'false' (no diagnostics are enabled; this is recommended for best performance).","in":"header","name":"diagnostics","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ImageOcr_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhotoToWordsWithLocationResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PhotoToWordsWithLocationResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/PhotoToWordsWithLocationResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PhotoToWordsWithLocationResult"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Convert a photo of a document or receipt into words with location","tags":["ImageOcr"]}},"/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.  Note: for free tier API keys, it is required to add a credit card to your account for security reasons, to use the free tier key with this API.","operationId":"ImageOcr_PhotoToText","parameters":[{"description":"Optional; possible values are 'Basic' which provides basic recognition and is not resillient to page rotation, skew or low quality images uses 1-2 API calls; 'Normal' which provides highly fault tolerant OCR recognition uses 26-30 API calls; and 'Advanced' which provides the highest quality and most fault-tolerant recognition uses 28-30 API calls.  Default recognition mode is 'Advanced'","in":"header","name":"recognitionMode","required":false,"schema":{"type":"string"}},{"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_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageToTextResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ImageToTextResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ImageToTextResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ImageToTextResponse"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Convert a photo of a document into text","tags":["ImageOcr"]}},"/ocr/preprocessing/image/binarize":{"post":{"description":"Perform an adaptive binarization algorithm on the input image to prepare it for further OCR operations.","operationId":"Preprocessing_Binarize","requestBody":{"$ref":"#/components/requestBodies/ImageOcr_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"format":"byte","type":"string"}},"application/xml":{"schema":{"format":"byte","type":"string"}},"text/json":{"schema":{"format":"byte","type":"string"}},"text/xml":{"schema":{"format":"byte","type":"string"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Convert an image of text into a binarized (light and dark) view","tags":["Preprocessing"]}},"/ocr/preprocessing/image/binarize/advanced":{"post":{"description":"Perform an advanced adaptive, Deep Learning-based binarization algorithm on the input image to prepare it for further OCR operations.  Provides enhanced accuracy than adaptive binarization.  Image will be upsampled to 300 DPI if it has a DPI below 300.","operationId":"Preprocessing_BinarizeAdvanced","requestBody":{"$ref":"#/components/requestBodies/ImageOcr_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"format":"byte","type":"string"}},"application/xml":{"schema":{"format":"byte","type":"string"}},"text/json":{"schema":{"format":"byte","type":"string"}},"text/xml":{"schema":{"format":"byte","type":"string"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Convert an image of text into a binary (light and dark) view with ML","tags":["Preprocessing"]}},"/ocr/preprocessing/image/get-page-angle":{"post":{"description":"Analyzes a photo or image of a document and identifies the rotation angle of the page.","operationId":"Preprocessing_GetPageAngle","requestBody":{"$ref":"#/components/requestBodies/ImageOcr_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPageAngleResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GetPageAngleResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/GetPageAngleResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/GetPageAngleResult"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Get the angle of the page / document / receipt","tags":["Preprocessing"]}},"/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_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"format":"byte","type":"string"}},"application/xml":{"schema":{"format":"byte","type":"string"}},"text/json":{"schema":{"format":"byte","type":"string"}},"text/xml":{"schema":{"format":"byte","type":"string"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Detect and unrotate a document image","tags":["Preprocessing"]}},"/ocr/preprocessing/image/unrotate/advanced":{"post":{"description":"Detect and unrotate an image of a document (e.g. that was scanned at an angle) using deep learning.  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_UnrotateAdvanced","requestBody":{"$ref":"#/components/requestBodies/ImageOcr_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"format":"byte","type":"string"}},"application/xml":{"schema":{"format":"byte","type":"string"}},"text/json":{"schema":{"format":"byte","type":"string"}},"text/xml":{"schema":{"format":"byte","type":"string"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Detect and unrotate a document image (advanced)","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_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"format":"byte","type":"string"}},"application/xml":{"schema":{"format":"byte","type":"string"}},"text/json":{"schema":{"format":"byte","type":"string"}},"text/xml":{"schema":{"format":"byte","type":"string"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Detect and unskew a photo of a document","tags":["Preprocessing"]}},"/ocr/receipts/photo/to/csv":{"post":{"deprecated":true,"description":"Leverage Deep Learning to automatically turn a photo of a receipt into a CSV file containing the structured information from the receipt.","operationId":"Receipts_PhotoToCSV","requestBody":{"$ref":"#/components/requestBodies/ImageOcr_Post"},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}}},"description":"OK"}},"security":[{"Apikey":[]}],"summary":"Convert a photo of a receipt into a CSV file containing structured information from the receipt","tags":["Receipts"]}}},"components":{"requestBodies":{"ImageOcr_Post":{"content":{"multipart/form-data":{"schema":{"properties":{"imageFile":{"description":"Image file to perform OCR on.  Common file formats such as PNG, JPEG are supported.","format":"binary","type":"string"}},"required":["imageFile"],"type":"object"}}},"required":true},"PdfOcr_Post":{"content":{"multipart/form-data":{"schema":{"properties":{"imageFile":{"description":"PDF file to perform OCR on.","format":"binary","type":"string"}},"required":["imageFile"],"type":"object"}}},"required":true}},"schemas":{"BusinessCardRecognitionResult":{"description":"Result of recognizing a business card, to extract the key information from the business card","properties":{"AddressString":{"description":"The address printed on the business card (if included on the business card)","type":"string"},"BusinessName":{"description":"The name of the business printed on the business card (if included on the business card)","type":"string"},"EmailAddress":{"description":"The email address printed on the business card (if included on the business card)","type":"string"},"PersonName":{"description":"The name of the person printed on the business card (if included on the business card)","type":"string"},"PersonTitle":{"description":"The title of the person printed on the business card (if included on the business card)","type":"string"},"PhoneNumber":{"description":"The phone number printed on the business card (if included on the business card)","type":"string"},"Successful":{"description":"True if the operation was successful, false otherwise","type":"boolean"},"Timestamp":{"description":"The date and time printed on the business card (if included on the business card)","format":"date-time","type":"string"}},"type":"object"},"FieldResult":{"description":"A pairing target field and actual value read from form","properties":{"FieldValues":{"description":"Result field value(s) extracted","items":{"$ref":"#/components/schemas/OcrPhotoTextElement"},"type":"array"},"TargetField":{"$ref":"#/components/schemas/FormFieldDefinition"}},"type":"object"},"FormDefinitionTemplate":{"description":"Definition of a form template; use a form template definition to recognize the fields in a form with Cloudmersive OCR","properties":{"FieldDefinitions":{"description":"Field definitions in the template; a field is comprised of a key/value pair","items":{"$ref":"#/components/schemas/FormFieldDefinition"},"type":"array"},"TableDefinitions":{"description":"Table definitions in the template; a table is comprised of columns and rows and exists in a 2-dimensional layout; a common example of a table would be an invoice","items":{"$ref":"#/components/schemas/FormTableDefinition"},"type":"array"}},"type":"object"},"FormFieldDefinition":{"description":"Definition of a form field for OCR data extraction from images","properties":{"AllowNumericDigits":{"description":"Optional - set to false to block values that contain numeric digits, set to true to allow numeric digits","type":"boolean"},"AlternateAnchor":{"description":"Optional - alterate match text for the specified anchor","type":"string"},"AnchorMode":{"description":"Optional - the matching mode for the anchor.  Possible values are Complete (requires the entire anchor to match) and Partial (allows only part of the anchor to match) and Horizontal (anchor must be laid out horizontally).  Default is Partial.","type":"string"},"BottomAnchor":{"description":"Optional - the bottom anchor of the field","type":"string"},"DataType":{"description":"The data type of the field; possible values are INTEGER (Integer value), STRING (Arbitrary string value, spaces are permitted), DATE (Date in a structured format), DECIMAL (Decimal number), ALPHANUMERIC (Continuous alphanumeric string with no spaces), STRINGNOWHITESPACE (A string that contains no whitespace characters), SERIALNUMBER (A serial-number style string that contains letters and numbers, and certain symbols; must contain at least one number), ALPHAONLY (Alphabet characters only, no numbers or symbols or whitespace)","type":"string"},"FieldID":{"description":"The identifier of the field; use this to identify which field is being referenced.  Set to SkipField if you do no