- Cloud OCR SDK Documentation
Quick Start GuidesThese guides will help you to start development with ABBYY Cloud OCR SDK.
API ReferenceThe description of API methods.
Code SamplesDemo samples show how to create a simple application with Cloud OCR SDK.
Sample ImagesHere you can download sample images in different languages.
Technical SpecificationsThe list of supported image formats, recognition languages, text types, etc.
FAQAnswers to commonly-asked questions about ABBYY Cloud OCR SDK.
Best PracticesGeneral recommendations on settings needed for the best recognition results.
Cloud OCR SDK Documentation
The method loads the image, creates a processing task for the image with the specified parameters, and passes the task for processing.
The image file is transmitted in the request body. See the list of supported input formats.
This method allows you to specify up to three file formats for the result, in which case the server response for the completed task will contain several result URLs.
If there is not enough money on your account, the task will be created, but will be suspended with NotEnoughCredits status. You can pass this task for processing using the processDocument method after you have topped up your account.
The task will not be created, if you exceed the limit of uploaded images.
For details on task cost please see billing terms.
|Parameter||Is required||Default value||Description|
|language||No||"English"||Specifies recognition language of the document. This parameter can contain several language names separated with commas, for example "English,French,German". See the list of available recognition languages.|
|profile||No||"documentConversion"||Specifies a profile with predefined processing settings. It can be one of the following:
|textType||No||"normal"||Specifies the type of the text on a page. This parameter may also contain several text types separated with commas, for example "normal,matrix". The following values can be used:
Specifies the source of the image. It can be either a scanned image, or a photograph created with a digital camera. Special preprocessing operations can be performed with the image depending on the selected source. For example, the system can automatically correct distorted text lines, poor focus and lighting on photos.
The value of this parameter can be one of the following:
|correctOrientation||No||"true"||Specifies whether the orientation of the image should be automatically detected and corrected. It can have one of the following values:
|correctSkew||No||"true"||Specifies whether the skew of the image should be automatically detected and corrected. It can have either true or false value.|
|readBarcodes||No||"true" for xml export format and "false" in other cases||Specifies whether barcodes must be detected on the image, recognized and exported to the result file. It can have either true or false value.|
|exportFormat||No||"rtf"||Specifies the export format. This parameter can contain up to three export formats, separated with commas (example: "pdfa,txt,xml"). The available formats are:
If either of XML export formats is selected, barcodes are recognized on the image and saved to output XML no matter which profile is used for recognition.
Please note that setting multiple export formats does not affect the cost of task processing.
|xml:writeRecognitionVariants||No||"false"||Specifies whether the variants of characters recognition should be written to an output file in XML format. This parameter can be used only if the exportFormat parameter contains xml value. The parameter can have one of the following values:
Specifies whether the result must be written as tagged PDF. This parameter can be used only if the exportFormat parameter contains one of the values for export to PDF. It can have one of the following values:
|description||No||""||Contains the description of the processing task. Cannot contain more than 255 characters.|
|pdfPassword||No||""||Contains a password for accessing password-protected images in PDF format.|
Status codes and response format
General status codes and response format of the method are described in HTTP Status Codes and Response Formats.
The following status codes can be returned when this method is called:
|200||Successful method call.|
|450||Incorrect parameters have been passed. One of the following errors occurred:
|550||An internal program error occurred while processing the image.|
|551||An error occurred on the server side: