# Tencent Cloud Optical Character Recognition API

> Tencent Cloud Optical Character Recognition API on Apizie: 81 endpoints (Advertise OCR, Arithmetic OCR, Bank Card OCR, Bank Slip OCR, …) 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://zieapi.vercel.app/v1/cloud:tencent-ocr/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:tencent-ocr`
- Category: Cloud
- Status: byok
- Source: https://www.tencentcloud.com/document/api
- Page: https://zieapi.vercel.app/api/cloud/tencent-ocr
- OpenAPI: https://zieapi.vercel.app/api/cloud/tencent-ocr/openapi.json

Tencent Cloud API 3.0 for Optical Character Recognition (ocr). Every call is signed with TC3-HMAC-SHA256 using your SecretId and SecretKey.

## Endpoints

### Advertise OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/advertise-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |

### Arithmetic OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/arithmetic-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| SupportHorizontalImage | boolean | no |  |
| RejectNonArithmeticPic | boolean | no |  |
| EnableDispRelatedVertical | boolean | no |  |
| EnableDispMidResult | boolean | no |  |
| EnablePdfRecognize | boolean | no |  |
| PdfPageIndex | integer | no |  |

### Bank Card OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/bank-card-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| RetBorderCutImage | boolean | no |  |
| RetCardNoImage | boolean | no |  |
| EnableCopyCheck | boolean | no |  |
| EnableReshootCheck | boolean | no |  |
| EnableBorderCheck | boolean | no |  |
| EnableQualityValue | boolean | no |  |

### Bank Slip OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/bank-slip-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |

### Biz License OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/biz-license-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| EnableCopyWarn | boolean | no |  |
| EnablePeriodComplete | boolean | no |  |
| EnableBusinessCertificate | boolean | no |  |

### Business Card OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/business-card-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| Config | string | no |  |

### Car Invoice OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/car-invoice-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |

### Classify Detect OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/classify-detect-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| DiscernType | array | no |  |

### Classify Store Name
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/classify-store-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| SceneType | boolean | no |  |
| StoreInfo | string | no |  |

### Crop Enhance Image OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/crop-enhance-image-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| PdfPageNumber | integer | no |  |
| Crop | integer | no |  |
| Deskew | integer | no |  |
| OnlyPosition | integer | no |  |
| EnhanceType | integer | no |  |
| AdjustOrientation | integer | no |  |

### Describe Extract Doc Agent Job
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/describe-extract-doc-agent-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| JobId | string | no |  |

### Describe Mark Essay Agent Job
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/describe-mark-essay-agent-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| JobId | string | no |  |

### Describe Multimodal Doc Parse Job
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/describe-multimodal-doc-parse-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| TaskId | string | yes |  |

### Describe Question Mark Agent Job
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/describe-question-mark-agent-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| JobId | string | no |  |

### Describe Question Split Job
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/describe-question-split-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| JobId | string | no |  |

### Driver License OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/driver-license-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| CardSide | string | no |  |

### English OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/english-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| EnableCoordPoint | boolean | no |  |
| EnableCandWord | boolean | no |  |
| Preprocess | boolean | no |  |

### Enterprise License OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/enterprise-license-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |

### Erase Handwritten Image OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/erase-handwritten-image-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| PdfPageNumber | integer | no |  |
| Crop | integer | no |  |
| Deskew | integer | no |  |
| Sharpen | integer | no |  |
| Grayscale | integer | no |  |

### Estate Cert OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/estate-cert-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |

### Extract Doc Agent
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/extract-doc-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| ItemNames | array | no |  |
| PdfPageNumber | integer | no |  |
| EnableCoord | boolean | no |  |
| EnableAudit | boolean | no |  |

### Extract Doc Basic
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/extract-doc-basic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageUrl | string | no |  |
| ImageBase64 | string | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |
| ItemNames | array | no |  |
| ReturnFullText | boolean | no |  |
| ConfigId | string | no |  |
| EnableSealRecognize | boolean | no |  |

### Extract Doc Multi
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/extract-doc-multi` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageUrl | string | no |  |
| ImageBase64 | string | no |  |
| PdfPageNumber | integer | no |  |
| ItemNames | array | no |  |
| ItemNamesShowMode | boolean | no |  |
| ReturnFullText | boolean | no |  |
| ConfigId | string | no |  |
| EnableCoord | boolean | no |  |
| OutputParentKey | boolean | no |  |
| ConfigAdvanced | object | no |  |
| OutputLanguage | string | no |  |
| NewItemNames | array | no |  |
| MultiModelVersion | string | no |  |

### General Accurate OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/general-accurate-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| IsWords | boolean | no |  |
| EnableDetectSplit | boolean | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |
| EnableDetectText | boolean | no |  |
| ConfigID | string | no |  |
| WordsType | string | no |  |

### General Basic OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/general-basic-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| Scene | string | no |  |
| LanguageType | string | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |
| IsWords | boolean | no |  |

### General Efficient OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/general-efficient-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |

### General Fast OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/general-fast-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |

### General Handwriting OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/general-handwriting-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| Scene | string | no |  |
| EnableWordPolygon | boolean | no |  |
| EnableDetectText | boolean | no |  |

### Get OCRResult
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/get-ocrresult` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| OCRToken | string | yes |  |

### Get OCRToken
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/get-ocrtoken` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Type | string | yes |  |
| IDCardConfig | object | no |  |

### HKIDCard OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/hkidcard-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ReturnHeadImage | boolean | no |  |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |

### Handwriting Essay OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/handwriting-essay-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageUrl | string | no |  |
| ImageBase64 | string | no |  |
| PdfPageNumber | integer | no |  |
| ConfigId | string | no |  |
| Scene | string | no |  |

### IDCard OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/idcard-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| CardSide | string | no |  |
| Config | string | no |  |
| EnableRecognitionRectify | boolean | no |  |
| EnableReflectDetail | boolean | no |  |
| CardWarnType | string | no |  |

### License Plate OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/license-plate-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |

### MLIDCard OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/mlidcard-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| BackImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| BackImageUrl | string | no |  |
| RetImage | boolean | no |  |

### MLIDPassport OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/mlidpassport-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| RetImage | boolean | no |  |
| ImageUrl | string | no |  |

### Mainland Permit OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/mainland-permit-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| RetProfile | boolean | no |  |
| CardSide | string | no |  |

### Mixed Invoice Detect
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/mixed-invoice-detect` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ReturnImage | boolean | yes |  |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |

### Mixed Invoice OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/mixed-invoice-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| Types | array | no |  |
| ReturnOther | string | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |
| ReturnMultiplePage | boolean | no |  |

### Multimodal Doc Parse
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/multimodal-doc-parse` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| FileUrl | string | yes |  |
| FileType | integer | yes |  |
| ResultType | integer | no |  |
| EnableSubImg | boolean | no |  |
| PageRange | string | no |  |
| TaskType | integer | no |  |

### Passport OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/passport-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| Type | string | no |  |
| CropPortrait | boolean | no |  |

### Permit OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/permit-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| CropPortrait | boolean | no |  |

### Qrcode OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/qrcode-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |

### Question OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/question-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageUrl | string | no |  |
| ImageBase64 | string | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |
| EnableImageCrop | boolean | no |  |

### Question Split Layout OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/question-split-layout-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageUrl | string | no |  |
| ImageBase64 | string | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |
| EnableImageCrop | boolean | no |  |
| UseNewModel | boolean | no |  |

### Question Split OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/question-split-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageUrl | string | no |  |
| ImageBase64 | string | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |
| EnableImageCrop | boolean | no |  |
| EnableOnlyDetectBorder | boolean | no |  |
| UseNewModel | boolean | no |  |

### Recognize Agent
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/recognize-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageUrl | string | no |  |
| ImageBase64 | string | no |  |
| PdfPageNumber | integer | no |  |
| SelectModel | integer | no |  |
| QueryType | integer | no |  |
| SchemaItems | array | no |  |
| Query | array | no |  |
| EnableCoord | boolean | no |  |

### Recognize Encrypted IDCard OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/recognize-encrypted-idcard-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| EncryptedBody | string | yes |  |
| Encryption | object | yes |  |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| CardSide | string | no |  |
| Config | string | no |  |
| EnableRecognitionRectify | boolean | no |  |
| EnableReflectDetail | boolean | no |  |
| CardWarnType | string | no |  |

### Recognize General Card Warn
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/recognize-general-card-warn` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageUrl | string | no |  |
| ImageBase64 | string | no |  |
| CardType | string | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |

### Recognize General Invoice
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/recognize-general-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| Types | array | no |  |
| EnableOther | boolean | no |  |
| EnablePdf | boolean | no |  |
| PdfPageNumber | integer | no |  |
| EnableMultiplePage | boolean | no |  |
| EnableCutImage | boolean | no |  |
| EnableItemPolygon | boolean | no |  |
| EnableQRCode | boolean | no |  |
| EnableSeal | boolean | no |  |

### Recognize Medical Invoice OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/recognize-medical-invoice-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| ReturnVertex | boolean | no |  |
| ReturnCoord | boolean | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |

### Recognize Store Name
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/recognize-store-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |

### Recognize Table Accurate OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/recognize-table-accurate-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| PdfPageNumber | integer | no |  |
| UseNewModel | boolean | no |  |

### Recognize Table OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/recognize-table-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |
| TableLanguage | string | no |  |

### Recognize Thai IDCard OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/recognize-thai-idcard-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| BackImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| BackImageUrl | string | no |  |
| CropPortrait | boolean | no |  |

### Recognize Valid IDCard OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/recognize-valid-idcard-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| CardType | integer | no |  |
| EnablePortrait | boolean | no |  |
| EnableCropImage | boolean | no |  |
| EnableBorderCheck | boolean | no |  |
| EnableOcclusionCheck | boolean | no |  |
| EnableCopyCheck | boolean | no |  |
| EnableReshootCheck | boolean | no |  |
| EnableReflectCheck | boolean | no |  |
| EnablePSCheck | boolean | no |  |
| EnableWordCheck | boolean | no |  |
| EnableQualityCheck | boolean | no |  |
| EnableElectronCheck | boolean | no |  |

### Residence Booklet OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/residence-booklet-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |

### Ride Hailing Driver License OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/ride-hailing-driver-license-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |

### Ride Hailing Transport License OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/ride-hailing-transport-license-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |

### Run Rerank
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/run-rerank` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Model | string | yes |  |
| Query | string | yes |  |
| Docs | array | yes |  |

### Seal OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/seal-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| EnablePdf | boolean | no |  |
| PdfPageNumber | integer | no |  |

### Smart Structural OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/smart-structural-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageUrl | string | no |  |
| ImageBase64 | string | no |  |
| ItemNames | array | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |
| ReturnFullText | boolean | no |  |

### Submit Extract Doc Agent Job
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/submit-extract-doc-agent-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| ItemNames | array | no |  |
| EnableCoord | boolean | no |  |
| FileStartPageNumber | integer | no |  |
| FileEndPageNumber | integer | no |  |
| ModelConfig | string | no |  |

### Submit Mark Essay Agent Job
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/submit-mark-essay-agent-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64List | array | no |  |
| ImageUrlList | array | no |  |
| PdfPageNumber | integer | no |  |
| QuestionConfigMap | string | no |  |

### Submit Multimodal Doc Parse Job
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/submit-multimodal-doc-parse-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| FileType | integer | yes |  |
| FileUrl | string | no |  |
| FileBase64 | string | no |  |
| ResultType | integer | no |  |
| EnableSubImg | boolean | no |  |
| FileStartPageNumber | integer | no |  |
| FileEndPageNumber | integer | no |  |
| TaskType | integer | no |  |

### Submit Question Mark Agent Job
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/submit-question-mark-agent-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| PdfPageNumber | integer | no |  |
| QuestionConfigMap | string | no |  |
| ReferenceAnswer | string | no |  |
| ImageBase64List | array | no |  |
| ImageUrlList | array | no |  |
| AssistMarkType | integer | no |  |
| AnswerAssistMap | string | no |  |
| EnableImageCrop | boolean | no |  |

### Submit Question Split Job
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/submit-question-split-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageUrlList | array | no |  |
| ImageBase64List | array | no |  |
| ModelType | string | no |  |
| EnableImageCrop | boolean | no |  |

### Table OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/table-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |

### Text Detect
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/text-detect` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |

### Train Ticket OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/train-ticket-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |

### Vat Invoice OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/vat-invoice-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |

### Vat Invoice Verify New
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/vat-invoice-verify-new` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InvoiceNo | string | yes |  |
| InvoiceDate | string | yes |  |
| InvoiceCode | string | no |  |
| InvoiceKind | string | no |  |
| CheckCode | string | no |  |
| Amount | string | no |  |
| RegionCode | string | no |  |
| SellerTaxCode | string | no |  |
| EnableCommonElectronic | boolean | no |  |
| EnableTodayInvoice | boolean | no |  |

### Vehicle License OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/vehicle-license-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| CardSide | string | no |  |
| TractorCardSide | string | no |  |

### Vehicle Reg Cert OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/vehicle-reg-cert-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |

### Verify Biz License Enterprise3
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/verify-biz-license-enterprise3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CreditCode | string | yes |  |
| EntName | string | yes |  |
| LrName | string | no |  |
| VerifyType | string | no |  |

### Verify Biz License Enterprise4
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/verify-biz-license-enterprise4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CreditCode | string | yes |  |
| EntName | string | yes |  |
| LrName | string | yes |  |
| IdNum | string | yes |  |

### Verify General Card Warn
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/verify-general-card-warn` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CardType | string | yes |  |
| ImageUrl | string | no |  |
| ImageBase64 | string | no |  |
| ReasoningPrompt | string | no |  |
| ReasoningConfig | object | no |  |
| IgnoreWatermarkCategories | array | no |  |

### Verify Ofd Vat Invoice OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/verify-ofd-vat-invoice-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| OfdFileUrl | string | no |  |
| OfdFileBase64 | string | no |  |
| OfdPageNumber | integer | no |  |

### Verify Scene Photo
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/verify-scene-photo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Scene | string | yes |  |
| Mode | string | no |  |
| VideoUrl | string | no |  |
| ImageUrl | string | no |  |
| ImageBase64 | string | no |  |
| ReasoningPrompt | string | no |  |
| ReasoningConfig | object | no |  |
| IgnoreWatermarkCategories | array | no |  |

### Vin OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/vin-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |

### Waybill OCR
`POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/waybill-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageBase64 | string | no |  |
| ImageUrl | string | no |  |
| EnablePreDetect | boolean | no |  |
| IsPdf | boolean | no |  |
| PdfPageNumber | integer | no |  |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:tencent-ocr/advertise-ocr" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Tencent Cloud Optical Character Recognition API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:tencent-ocr/advertise-ocr with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Tencent Cloud Optical Character Recognition API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Tencent Cloud Optical Character Recognition itself also needs your own key from tencentcloudapi.com.

### Can AI agents use the Tencent Cloud Optical Character Recognition API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:tencent-ocr.

### What is the status of the Tencent Cloud Optical Character Recognition API?
Needs your own provider key (bring your own key)