Description

n8n-nodes-tencentcloud-ocr-general

An n8n community node for Tencent Cloud General OCR text recognition.

!n8n.io – Workflow Automation

Features

• 🔍 General OCR Text Recognition – Recognize text from various types of images
• 🏢 Tencent Cloud Powered – Utilizes Tencent Cloud’s high-accuracy OCR API
• 📄 Multiple Document Types – Support for documents, certificates, screenshots, and more
• 🔒 Secure – Direct API integration with your Tencent Cloud credentials
• ⚡ Fast & Reliable – High-performance text recognition

Installation

You can install this community node by searching for n8n-nodes-tencentcloud-ocr-general in the n8n community nodes section, or manually:

npm install n8n-nodes-tencentcloud-ocr-general

Prerequisites

1. Tencent Cloud Account – You need a Tencent Cloud account with OCR service enabled
2. API Credentials – SecretId and SecretKey for Tencent Cloud API access
3. n8n Instance – Running n8n instance (self-hosted or cloud)

Configuration

Required Parameters

• SecretId: Your Tencent Cloud API Secret ID
• SecretKey: Your Tencent Cloud API Secret Key
• ImageBase64 Field: Field name containing the base64-encoded image data (default: ‘data’)

Input Data Format

The node expects input data with a base64-encoded image:

{
  "data": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD..."
}

Or just the base64 string without the data URI prefix:

{
  "data": "/9j/4AAQSkZJRgABAQEAYABgAAD..."
}

Output Data Format

The node returns the complete response from Tencent Cloud OCR API, including:

{
  "TextDetections": [
    {
      "DetectedText": "recognized text content",
      "Confidence": 99,
      "ItemPolygon": {
        "X": 100,
        "Y": 50,
        "Width": 200,
        "Height": 30
      }
    }
  ],
  "Language": "zh",
  "RequestId": "abc123-def456-ghi789"
}

Usage Examples

Basic OCR Recognition

1. Add the “TencentCloud General OCR” node to your workflow
2. Configure your Tencent Cloud credentials
3. Connect an input node with base64 image data
4. The node will output recognized text information

Common Use Cases

• Document Digitization: Convert scanned documents to text
• ID Card Recognition: Extract information from identity documents
• Receipt Processing: Parse receipt text for expense tracking
• Screenshot Text Extraction: Get text from application screenshots
• Multi-language Support: Recognize text in various languages

API Documentation

This node uses Tencent Cloud’s GeneralAccurateOCR API. For detailed API documentation:

• Tencent Cloud OCR API
• API Reference

Supported Image Formats

• JPEG/JPG
• PNG
• BMP
• PDF (first page)

Image Requirements

• Size: Maximum 4MB
• Resolution: Minimum 15×15 pixels, maximum 4096×4096 pixels
• Format: Base64 encoded string

Error Handling

The node includes comprehensive error handling:

• Invalid credentials
• Unsupported image formats
• API rate limiting
• Network connectivity issues

Errors are returned in the output with detailed error messages.

Development

Local Development

Clone the repository
git clone https://github.com/zhimeng118/n8n-nodes-tencentcloud-ocr.git
Install dependencies
npm install
Build the node
npm run build
Run linting
npm run lint

Testing

Test the node locally by linking it to your n8n installation:

In the node directory
npm link
In your n8n directory  
npm link n8n-nodes-tencentcloud-ocr-general

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

License

MIT

Support

For questions and support:

• GitHub Issues: Report a bug or request a feature
• n8n Community: Join the discussion

Keywords

n8n ocr tencent-cloud text-recognition community-node workflow automation