# ABBYY

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

App · 11 actions. Web page: https://docs.lodol.com/docs/integrations/abbyy

## Actions

### Delete task

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

**Inputs**

- Task ID (`task_id`, text, required): Task ID.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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**

- `data` (object): Response.

**Example output**

```json
{
  "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 ID (`task_id`, text, required): Task ID.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "tasks": []
  }
}
```

### List tasks

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

**Inputs**: None.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 languages (`language`, list): 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 format (`export_format`, text): Export format. One of: `vCard`, `xml`, `csv`.
- File (`file`, text, required): File.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 ID (`task_id`, text, required): Task ID.
- Recognition languages (`language`, list): 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 format (`export_format`, list): Export format. One or more of: `txt`, `rtf`, `docx`, `xlsx`, `pptx`, `pdfSearchable`, `pdfTextAndImages`, `xml`, `alto`.
- Profile (`profile`, text): Profile. One of: `documentConversion`, `documentArchiving`, `textExtraction`, `barcodeRecognition`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 languages (`language`, list): 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 format (`export_format`, list): Export format. One or more of: `txt`, `rtf`, `docx`, `xlsx`, `pptx`, `pdfSearchable`, `pdfTextAndImages`, `xml`, `alto`.
- Profile (`profile`, text): Profile. One of: `documentConversion`, `documentArchiving`, `textExtraction`, `barcodeRecognition`.
- File (`file`, text, required): File.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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**

- File (`file`, text, required): File.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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**

- File (`file`, text, required): File.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 ID (`task_id`, text): Task ID.
- File (`file`, text, required): File.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "error": "example",
    "filesCount": 1,
    "registrationTime": "example",
    "requestStatusDelay": 1,
    "resultUrls": [],
    "status": "example",
    "statusChangeTime": "example",
    "taskId": "example"
  }
}
```
