# OCR API
Extract English text from common image file formats.
## API Overview
- **HTTP Protocol:** HTTPS
- **HTTP Method:** POST
- **HTTP Endpoint:** https://api.gugudata.io/v1/imagerecognition/ocr
- **Response Type:** application/json; charset=utf-8
- **DEMO Endpoint:** https://api.gugudata.io/v1/imagerecognition/ocr/demo
- **Live Demo:** https://gugudata.io/demo/ocr
- **Postman:** https://www.postman.com/gugudata/gugudata-io
- **LLM Page:** https://gugudata.io/details/ocr/llm
- **Raw Markdown:** https://gugudata.io/details/ocr/llm.md
## Remote MCP
- **MCP Endpoint:** https://mcp.gugudata.io/mcp
- **MCP Guide:** https://gugudata.io/mcp/
- **Authorization:** OAuth authorization opens in the browser; do not paste appkeys into MCP clients.
- **Tool Scope:** MCP clients receive GuGuData API tools available to the authorized account.
## Data & API Features
- Image text extraction: Upload an image and extract recognized text lines plus combined text for document intake and automation workflows.
- Unlimited OCR usage: Run OCR whenever your workflow needs it under one annual subscription, without per-call charges or a sales-led setup.
- Searchable archive support: Store recognized text alongside images so receipts, scans, screenshots, and forms become searchable.
- Document intake automation: Route extracted text into approval workflows, ticketing systems, databases, and downstream AI processing.
- Batch-friendly API design: Call the endpoint repeatedly from backend jobs when processing incoming image files or historical document queues.
- Standalone OCR interface: Subscribe to the OCR API independently when the workflow only needs image-to-text output.
## API Request Parameters
| Name | Type | Is Required | Default Value | Remark |
| --- | --- | --- | --- | --- |
| appkey | string | true | YOUR_APPKEY | API key used to authenticate the request. |
| imagefile | file | true | | JPEG, PNG, WebP, TIFF, or BMP multipart image upload up to 10 MiB. |
## API Response Parameters
| Name | Type | Remark |
| --- | --- | --- |
| dataStatus.statusCode | integer | Application-level status code. |
| dataStatus.statusDescription | string | Human-readable application status message. |
| dataStatus.responseDateTime | string | Time at which the response was generated. |
| dataStatus.dataTotalCount | integer | Number of matching or returned records for this request. |
| data.resultText | array<string> | Recognized non-empty text lines in reading order. |
| data.text | string | Recognized lines joined as plain text, or an empty string when no text is recognized. |
## API Response Status Codes
| Status Code | Explanation of Status Code | Remarks |
| --- | --- | --- |
| 200 | Request processed successfully. | Some endpoints expose a separate application-level status field in the response body, such as `dataStatus.statusCode`. |
| 400 | Invalid request parameters or request format. | Check required fields, data types, and request body format. |
| 401 | Missing or unknown application key. | Provide a valid `appkey` with the request. |
| 403 | The application key is recognized but access is not allowed. | The key may be expired, inactive, or not permitted for the requested API. |
| 429 | Request rate or trial usage limit exceeded. | Reduce request frequency and retry with backoff. If a trial allowance is exhausted, check Trial Keys for remaining requests and subscribe to continue. |
| 500 | Internal service error. | Retry later or contact support if the error persists. |
| 503 | Upstream service unavailable. | Retry later; the requested upstream dependency is temporarily unavailable. |
## cURL Example
```bash
curl --location 'https://api.gugudata.io/v1/imagerecognition/ocr?appkey=YOUR_APPKEY' --form 'imagefile=@localfile_path.png'
```