ABBYY

App · 11 actions

Recognize document text, business cards and machine-readable zones with ABBYY Cloud OCR SDK.

Actions

ActionWhat it does
Delete taskDeletes a task by its task ID, removing its uploaded images and results from ABBYY.
Get application infoGets your ABBYY Cloud OCR application's name, remaining page credits and expiry date.
Get task statusGets a processing task by its task ID, including its status and, once finished, links to download the results.
List finished tasksLists the tasks that have finished processing and not yet been deleted, with each task's ID, status and result links.
List tasksLists the recent processing tasks in your application, with each task's ID, status and creation time.
Process business cardStarts reading the contact details on an uploaded business card image, in the languages and format you choose.
Process documentStarts reading the text in all the images submitted to a task, by its task ID, in the languages and export format you choose.
Process imageStarts reading the text in one uploaded image or PDF, in the languages and export format you choose.
Process mrzStarts reading the machine-readable zone of an uploaded passport or ID card image.
Process text fieldStarts reading the text in a single small image of one text field.
Submit imageUploads an image to a new or existing task, by task ID, so several pages can be processed together with Process document.

Delete task

Deletes a task by its task ID, removing its uploaded images and results from ABBYY.

Inputs

Task IDtask_idtextRequired
Task ID.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "error": "example",
    "filesCount": 1,
    "registrationTime": "example",
    "requestStatusDelay": 1,
    "resultUrls": [],
    "status": "example",
    "statusChangeTime": "example",
    "taskId": "example"
  }
}

Get application info

Gets your ABBYY Cloud OCR application's name, remaining page credits and expiry date. Must be enabled in the ABBYY console first.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "displayName": "example",
    "expires": "example",
    "fields": 1,
    "id": "example",
    "pages": 1,
    "type": "example"
  }
}

Get task status

Gets a processing task by its task ID, including its status and, once finished, links to download the results.

Inputs

Task IDtask_idtextRequired
Task ID.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "error": "example",
    "filesCount": 1,
    "registrationTime": "example",
    "requestStatusDelay": 1,
    "resultUrls": [],
    "status": "example",
    "statusChangeTime": "example",
    "taskId": "example"
  }
}

List finished tasks

Lists the tasks that have finished processing and not yet been deleted, with each task's ID, status and result links.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "tasks": []
  }
}

List tasks

Lists the recent processing tasks in your application, with each task's ID, status and creation time.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "tasks": []
  }
}

Process business card

Starts reading the contact details on an uploaded business card image, in the languages and format you choose. Returns the task ID.

Inputs

Recognition languageslanguagelist
Choose the languages in the document. Leave empty to use the service’s default.One or more of: ChinesePRC (Chinese Simplified), ChineseTaiwan (Chinese Traditional), Czech, Danish, Dutch (Dutch (Netherlands)), English, Estonian, Finnish, French, German, and 16 more.
Export formatexport_formattext
Export format.One of: vCard, xml, csv.
FilefiletextRequired
File.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "error": "example",
    "filesCount": 1,
    "registrationTime": "example",
    "requestStatusDelay": 1,
    "resultUrls": [],
    "status": "example",
    "statusChangeTime": "example",
    "taskId": "example"
  }
}

Process document

Starts reading the text in all the images submitted to a task, by its task ID, in the languages and export format you choose. Returns the task.

Inputs

Task IDtask_idtextRequired
Task ID.
Recognition languageslanguagelist
Choose the languages in the document. Leave empty to use the service’s default.One or more of: Abkhaz, Adyghe, Afrikaans, Agul, Albanian, Altaic, Arabic (Arabic (Saudi Arabia)), ArmenianEastern (Armenian (Eastern)), ArmenianGrabar (Armenian (Grabar)), ArmenianWestern (Armenian (Western)), and 185 more.
Export formatexport_formatlist
Export format.One or more of: txt, rtf, docx, xlsx, pptx, pdfSearchable, pdfTextAndImages, xml, alto.
Profileprofiletext
Profile.One of: documentConversion, documentArchiving, textExtraction, barcodeRecognition.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "error": "example",
    "filesCount": 1,
    "registrationTime": "example",
    "requestStatusDelay": 1,
    "resultUrls": [],
    "status": "example",
    "statusChangeTime": "example",
    "taskId": "example"
  }
}

Process image

Starts reading the text in one uploaded image or PDF, in the languages and export format you choose. Returns the task ID to check with Get task status.

Inputs

Recognition languageslanguagelist
Choose the languages in the document. Leave empty to use the service’s default.One or more of: Abkhaz, Adyghe, Afrikaans, Agul, Albanian, Altaic, Arabic (Arabic (Saudi Arabia)), ArmenianEastern (Armenian (Eastern)), ArmenianGrabar (Armenian (Grabar)), ArmenianWestern (Armenian (Western)), and 185 more.
Export formatexport_formatlist
Export format.One or more of: txt, rtf, docx, xlsx, pptx, pdfSearchable, pdfTextAndImages, xml, alto.
Profileprofiletext
Profile.One of: documentConversion, documentArchiving, textExtraction, barcodeRecognition.
FilefiletextRequired
File.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "error": "example",
    "filesCount": 1,
    "registrationTime": "example",
    "requestStatusDelay": 1,
    "resultUrls": [],
    "status": "example",
    "statusChangeTime": "example",
    "taskId": "example"
  }
}

Process mrz

Starts reading the machine-readable zone of an uploaded passport or ID card image. Returns the task ID to check with Get task status.

Inputs

FilefiletextRequired
File.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "error": "example",
    "filesCount": 1,
    "registrationTime": "example",
    "requestStatusDelay": 1,
    "resultUrls": [],
    "status": "example",
    "statusChangeTime": "example",
    "taskId": "example"
  }
}

Process text field

Starts reading the text in a single small image of one text field. Returns the task ID to check with Get task status.

Inputs

FilefiletextRequired
File.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "error": "example",
    "filesCount": 1,
    "registrationTime": "example",
    "requestStatusDelay": 1,
    "resultUrls": [],
    "status": "example",
    "statusChangeTime": "example",
    "taskId": "example"
  }
}

Submit image

Uploads an image to a new or existing task, by task ID, so several pages can be processed together with Process document.

Inputs

Task IDtask_idtext
Task ID.
FilefiletextRequired
File.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "error": "example",
    "filesCount": 1,
    "registrationTime": "example",
    "requestStatusDelay": 1,
    "resultUrls": [],
    "status": "example",
    "statusChangeTime": "example",
    "taskId": "example"
  }
}

On this page