Updated on 2026-10-30 GMT+08:00

CLI Command Reference

Smart Document Recognizer

API Name

Command

Description

Operation

Smart Document Recognizer

hcloud OCR RecognizeSmartDocumentRecognizer

This API detects and extracts key-value pairs, text, and table content from various document layouts, such as certificates, receipts, and forms, and converts the text into a structured format.

Go debug

General Text

API Name

Command

Description

Operation

General Text

hcloud OCR RecognizeGeneralText

Detects and extracts text from images and returns the recognized text and coordinates. It can be used in various scenarios, such as scanned files, electronic documents, books, receipts, and forms. For details about the constraints on using this API, see Constraints. For details about how to use this API, see Introduction to OCR.

Go debug

Web Image

API Name

Command

Description

Operation

Web Image

hcloud OCR RecognizeWebImage

Web Image recognizes characters in a web image and returns the structured result in JSON format.

Go debug

General Table

API Name

Command

Description

Operation

General Table

hcloud OCR RecognizeGeneralTable

Detects and extracts the text in general table images that you upload (or the URLs redirecting to the image files stored on OBS), and converts the text into structured format. For details about the constraints on using this API, see Constraints. For details about how to use this API, see Introduction to OCR.

Go debug

Passport

API Name

Command

Description

Operation

Passport

hcloud OCR RecognizePassport

Passport recognizes the text on the first page of a passport and returns the structured information in JSON format.

Go debug

Thailand ID Card

API Name

Command

Description

Operation

Thailand ID Card

hcloud OCR RecognizeThailandIdcard

Thailand ID Card recognizes characters on a Thailand-issued national registration card and returns the structured result in JSON format.

Go debug

Myanmar ID Card

API Name

Command

Description

Operation

Myanmar ID Card

hcloud OCR RecognizeMyanmarIdcard

Myanmar ID Card recognizes information on Myanmar-issued national registration cards.

Go debug

Myanmar Driving License

API Name

Command

Description

Operation

Myanmar Driving License

hcloud OCR RecognizeMyanmarDriverLicense

Myanmar Driving License recognizes characters on a Myanmar-issued driver's license and returns the structured result in JSON format.

Go debug

Chile ID Card

API Name

Command

Description

Operation

Chile ID Card

hcloud OCR RecognizeChileIdCard

Chile ID Card recognizes the text in a Chile ID card image and returns the recognition result in JSON format.

Go debug

Thailand License Plate

API Name

Command

Description

Operation

Thailand License Plate

hcloud OCR RecognizeThailandLicensePlate

Thailand License Plate recognizes the license plate information in a thailand license plate image and returns the license plate number and location.

Go debug

ID Document

API Name

Command

Description

Operation

ID Document

hcloud OCR RecognizeIdDocument

This API identifies and extracts text from images of identity documents issued by multiple countries and regions, such as ID cards, driving licenses, and passports, and converts the text into a structured format. Table 1 lists the mapping between the countries/regions and identity documents.

Go debug

Cambodian ID Card

API Name

Command

Description

Operation

Cambodian ID Card

hcloud OCR RecognizeCambodianIdCard

Cambodian ID Card detects and extracts text from images of Cambodia-issued ID cards and converts the text into a structured format.

Go debug

Vietnam ID Card

API Name

Command

Description

Operation

Vietnam ID Card

hcloud OCR RecognizeVietnamIdCard

Detects and extracts text from Vietnam-issued citizen identity cards and converts the text into a structured format.

Go debug

Colombia ID Card

API Name

Command

Description

Operation

Colombia ID Card

hcloud OCR RecognizeColombiaIdCard

This API detects and extracts text from images of Colombia-issued identity cards and converts the text into a structured format.

Go debug

Peru ID Card

API Name

Command

Description

Operation

Peru ID Card

hcloud OCR RecognizePeruIdCard

This API detects and extracts text from Peru-issued identity cards and converts the text into a structured format.

Go debug

Auto ID Document Classification

API Name

Command

Description

Operation

Auto ID Document Classification

hcloud OCR RecognizeAutoIdDocClassification

Classifies nine types of ID documents and detects alarms, with results returned in JSON format. Supported document types include Peru ID card, Cambodian ID card, Hong Kong ID card, Macao ID card, Myanmar ID card, Myanmar driver's license, Thai ID card, passport, and Chinese ID card.

Go debug