Skip to main content

Command Palette

Search for a command to run...

Image Stream OCR API Documentation

Published
4 min readView as Markdown
Image Stream OCR API Documentation

Image Stream OCR to Text API

Category: Image Recognition
Endpoint: POST https://api.gugudata.io/v1/imagerecognition/ocr?appkey={{appkey}}
Description: General image stream recognition

Overview

The Image Stream OCR to Text API by GuGuData is designed for high-accuracy recognition of text in various image formats. By leveraging machine learning algorithms, this API supports mixed recognition of English and other characters. Simply upload your images via form-data file stream, and receive the recognized text as an array of lines. Ideal for document processing, text extraction from scanned images, and more.

Key highlights:

  • Multiple image format support – Accepts .png, .jpg, .bmp, and others.
  • Mixed language recognition – Handles English and additional character sets.
  • Machine learning improvements – Continuously updated for higher accuracy.
  • HTTPS/TLS support – Compatible with TLS v1.0–v1.3 and Apple ATS.
  • Nationwide multi-node CDN – Faster response times with load-balanced servers.

Demo URL

https://api.gugudata.io/v1/imagerecognition/ocr/demo

Request Parameters

Send a POST request to the endpoint with form-data containing the required parameters:

ParameterTypeRequiredDescription
imagefilefileYesThe image file, uploaded via form-data

Note: Make sure to include appkey in the query string:
POST https://api.gugudata.io/v1/imagerecognition/ocr?appkey=YOUR_APPKEY

Response Parameters

On success, the API returns a JSON structure with detailed status information and recognized text. Below is a summary of the primary fields:

ParameterTypeRequiredDescription
DataStatus.statusCodeintYesThe API response status code.
DataStatus.statusDescriptionstringYesA brief description of the response status.
DataStatus.responseDateTimestringYesThe timestamp at which the data was returned.
DataStatus.dataTotalCountintYesThe total data count under this request (useful for pagination).
Data.resultTextstring[]YesAn array of recognized text lines. Each element corresponds to one line of recognized text.

Error Codes

The following are common error codes and their possible causes:

Error CodeError ContentNotes
100Normal responseRequest succeeded without issues.
101Parameter errorCheck for missing or invalid parameters (e.g., no file).
102Request rate limitedExceeded 100 requests per second limit.
103Account overduePayment or balance issue; account not in good standing.
104Invalid APPKEYEnsure your APPKEY is correct from the Developer Center.
110API response errorA general error indicating an unexpected API issue.

Features

  1. General recognition API – Works with multiple image formats like PNG, JPG, and BMP.
  2. Mixed language support – Recognizes English characters and supports other scripts.
  3. Form-data file upload – Straightforward image file transfer method.
  4. Machine learning enhancements – Accuracy and performance improved over time.
  5. HTTPS (TLS 1.0–1.3) – Ensures secure data transmission.
  6. Apple ATS compatibility – Seamless integration with iOS and macOS apps.
  7. Nationwide multi-node CDN – Achieves optimal performance across different regions.
  8. Load balancing – Rapid, reliable API responses even under heavy load.

Additional Notes for Developers

  • File size considerations: Large images may take slightly longer to process. Ensure your API client handles any timeouts.
  • Mixed script images: The OCR engine can process multiple languages if contained in the same image.
  • Compression: You may compress images before sending to optimize transfer times, but clarity impacts OCR accuracy.

Getting Started

  1. Sign up at GuGuData.io – Obtain your appkey.
  2. Construct a POST request – Include appkey in the query string and the image file in form-data.
  3. Parse the JSON response – Read recognized text lines from Data.resultText.
  4. Integrate – Incorporate OCR results into document management systems or text analytics workflows.

About GuGuData

GuGuData specializes in delivering data-driven APIs with high accuracy and scalability. From Webpage Readable Content Extraction to SSL Certificate Parsing, we provide powerful tools for businesses, researchers, and developers alike. Our robust infrastructure and continuous data refinement keep you ahead in an ever-evolving digital landscape.

Key Highlights:

  • Nine years in business – Trusted partner for data solutions worldwide.
  • 4.2k+ APIs – Broad suite of data and functionality.
  • 95% happy customers – Committed to reliability, performance, and innovation.

Harness the Image Stream OCR to Text API to streamline your document processing or content extraction tasks. Visit our official site for more solutions from GuGuData.

More from this blog

网页转 JSON API 怎么接:从 Prompt 到可校验的结构化数据

把网页内容变成 JSON,真正困难的部分通常不是“得到一段看起来像 JSON 的文本”,而是让字段含义、数据类型、缺失值、来源和更新规则都能被程序稳定处理。 语义化获取站点 JSON 结构内容 API 可以根据网页 URL 和自然语言 Prompt 提取自定义结构。它适合商品列表、文章索引、表格内容、站点研究和自动化数据准备等场景,但接口返回成功并不代表所有字段都已经过事实验证。生产接入仍需要本地

Aug 27, 20265 min read

地址逆编码接口 API

此文章对开放数据接口 API 之「地址逆编码接口 API」进行了功能介绍、使用场景介绍以及调用方法的说明,供用户在使用数据接口时参考之用,并且在目前更新的微信小程序实战开发项目中的使用场景。 1. 产品功能 此次开放了精准的地址坐标逆编码在线接口,用于对提供的 GPS 坐标转换为文字地址信息。 提供精准、高效的地理坐标逆编码接口; 返回的地址包含详细的位置信息; 一次可返回坐标周边的 10

Aug 3, 20261 min read

中英文排版规范化 API

此文章对开放数据接口 API 之「中英文排版规范化 API」进行了功能介绍、使用场景介绍以及调用方法的说明,供用户在使用数据接口时参考之用。 1. 产品功能 此次开放了中英文排版规范化在线接口,用于自动中英文排版、标点符号格式化,中英混排格式化 / 标点修正。 支持中英文混排格式化; 自动在汉字与英文字符、英文标点、数字间添加空格; 中文标点符号自动规范化,遵从 [标点符号用法 GB/T

Aug 3, 20261 min read

为阿里云站点部署免费 HTTPS

本文记录了部署在阿里云的站点,在申请了免费的 SSL 证书后如何正确的部署到站点上,让站点支持 HTTPS 访问。 阿里云引入了沃通作为 CA 证书供应商,并开放了免费 SSL 申请的页面,之前一直想给 咕咕监控 部署上全站 HTTPS,所以就申请了一个,但是部署的过程中遇到了些问题,所以记录下来备忘。 1. 证书申请 在阿里云后台的 CA 管理页面,填写相关的信息后就可以申请到一张免费的 CA

Aug 3, 20261 min read

GuGuData

178 posts