# Alibaba Cloud Viapi Ocr API

> Alibaba Cloud Viapi Ocr API on Apizie: 18 endpoints (This topic describes the syntax and examples of the GetAsyncJobResult operation for querying asynchronous…, Describes the syntax and examples of the RecognizeBankCard operation, Describes the syntax and examples for the RecognizeBusinessLicense operation in the OCR category, Describes the syntax and examples of the RecognizeCharacter operation in the OCR category, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:aliyun-ocr/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-ocr`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/ocr
- Page: https://www.apizie.tech/api/cloud/aliyun-ocr
- OpenAPI: https://www.apizie.tech/api/cloud/aliyun-ocr/openapi.json

Alibaba Cloud OpenAPI for Viapi Ocr (ocr, version 2019-12-30). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### This topic describes the syntax and examples of the GetAsyncJobResult operation for querying asynchronous…
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/get-async-job-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |
| JobId | string | yes | The RequestId returned by the asynchronous operation. You can use this ID to query the actual result of the asynchronous operation |

### Describes the syntax and examples of the RecognizeBankCard operation
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/recognize-bank-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other… |

### Describes the syntax and examples for the RecognizeBusinessLicense operation in the OCR category
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/recognize-business-license` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other… |

### Describes the syntax and examples of the RecognizeCharacter operation in the OCR category
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/recognize-character` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. Use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other than China (Shanghai),… |
| MinHeight | integer | yes | The minimum height of the text in the image, in pixels |
| OutputProbability | string | yes | Specifies whether to output the probability of the text box. Valid values: true: outputs the probability of the text box. false: does not… |

### Recognizes the text on a driver's license
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/recognize-driver-license` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored locally or in an OSS… |
| Side | string | no | The page of the driver's license in the uploaded photo. face: Front page. back: Back page |

### Recognizes vehicle licenses and describes the syntax and examples for the RecognizeDrivingLicense operation…
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/recognize-driving-license` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The image URL. Use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in other regions, see… |
| Side | string | no | The page of the vehicle license in the uploaded photo. Valid values: face: Front page. back: Back page |

### Describes the syntax and examples for the RecognizeIdentityCard operation in the optical character…
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/recognize-identity-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored on your local machine or… |
| Side | string | no | The side of the ID card. face: The side with the portrait. back: The side with the national emblem |

### Describes the syntax and examples of the RecognizeLicensePlate operation in the OCR category
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/recognize-license-plate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The license plate recognition feature currently supports the China (Shanghai) and China (Shenzhen) regions. If you selected the China… |

### Describes the syntax and examples of the RecognizePdf operation in the optical character recognition (OCR)…
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/recognize-pdf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |
| FileURL | string | yes | The URL of the file. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other… |

### Recognizes QR codes in images
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/recognize-qr-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |
| Tasks | string | yes | 1 (JSON-encoded) |

### Describes the syntax and examples of the RecognizeQuotaInvoice operation in the OCR category
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/recognize-quota-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored on your local machine or… |

### Recognizes table content in images
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/recognize-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The image URL. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored on your local machine or in an… |
| OutputFormat | string | yes | The output format. Set the value to json. The html and xlsx formats are deprecated. If you set this parameter to html or xlsx, the output… |
| UseFinanceModel | string | yes | Specifies whether to use the financial statement model. Valid values: true: Use the financial statement model. false: Do not use the… |
| AssureDirection | string | yes | Specifies whether the image orientation is upright. Valid values: true: The image is upright. false: The image is inverted |
| HasLine | string | yes | Specifies whether the table has no lines. Valid values: true: The table has no lines, or has only horizontal lines without vertical lines.… |
| SkipDetection | string | yes | Specifies whether to skip detection. Valid values: true: Skip detection. false: Do not skip detection |

### Describes the syntax and examples of the RecognizeTaxiInvoice operation in the optical character recognition…
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/recognize-taxi-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored locally or in an OSS… |

### Describes the syntax and examples of the RecognizeTicketInvoice operation in the optical character…
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/recognize-ticket-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other… |

### Describes the syntax and examples of the RecognizeTrainTicket operation in the optical character recognition…
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/recognize-train-ticket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other… |

### Recognizes key fields in value-added tax (VAT) invoices
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/recognize-vatinvoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |
| FileURL | string | yes | The URL of the image. Use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in other regions, see… |
| FileType | string | yes | The format of the input image. Set this parameter to `jpg` |

### This topic describes the syntax and examples of the RecognizeVINCode operation in the OCR category
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/recognize-vincode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other… |

### version
`POST https://www.apizie.tech/v1/cloud:aliyun-ocr/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com |

## Example
```
curl "https://www.apizie.tech/v1/cloud:aliyun-ocr/get-async-job-result" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Viapi Ocr API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:aliyun-ocr/get-async-job-result with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Viapi Ocr API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Viapi Ocr itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Viapi Ocr API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-ocr.

### What is the status of the Alibaba Cloud Viapi Ocr API?
Needs your own provider key (bring your own key)