# 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}}](https://api.gugudata.io/v1/imagerecognition/ocr?appkey={{appkey}})  
> **Description**: General image stream recognition

## Overview

The **Image Stream OCR to Text API** by [GuGuData](https://gugudata.io/) 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](https://api.gugudata.io/v1/imagerecognition/ocr/demo)

## Request Parameters

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

| **Parameter** | **Type** | **Required** | **Description**                        |
| :-----------: | :------: | :----------: | :------------------------------------- |
|  `imagefile`  |  `file`  |     Yes      | The 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:

|         **Parameter**          |  **Type**  | **Required** |                                       **Description**                                       |
| :----------------------------: | :--------: | :----------: | :-----------------------------------------------------------------------------------------: |
|    `DataStatus.statusCode`     |   `int`    |     Yes      |                                The API response status code.                                |
| `DataStatus.statusDescription` |  `string`  |     Yes      |                         A brief description of the response status.                         |
| `DataStatus.responseDateTime`  |  `string`  |     Yes      |                        The timestamp at which the data was returned.                        |
|  `DataStatus.dataTotalCount`   |   `int`    |     Yes      |              The total data count under this request (useful for pagination).               |
|       `Data.resultText`        | `string[]` |     Yes      | An 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 Code** |  **Error Content**   | **Notes**                                                |
| :------------: | :------------------: | :------------------------------------------------------- |
|     `100`      |   Normal response    | Request succeeded without issues.                        |
|     `101`      |   Parameter error    | Check for missing or invalid parameters (e.g., no file). |
|     `102`      | Request rate limited | Exceeded 100 requests per second limit.                  |
|     `103`      |   Account overdue    | Payment or balance issue; account not in good standing.  |
|     `104`      |    Invalid APPKEY    | Ensure your APPKEY is correct from the Developer Center. |
|     `110`      |  API response error  | A 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](https://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**](https://gugudata.io/) specializes in delivering **data-driven APIs** with **high accuracy** and **scalability**. From [Webpage Readable Content Extraction](https://gugudata.io/) to [SSL Certificate Parsing](https://gugudata.io/), 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](https://gugudata.io/) for more solutions from GuGuData.