# Image OCR to Word API
Convert image text into an editable Word document with OCR.
## API Overview
- **HTTP Protocol:** HTTPS
- **HTTP Method:** POST
- **HTTP Endpoint:** https://api.gugudata.io/v1/imagerecognition/ocr2word
- **Response Type:** application/json; charset=utf-8
- **DEMO Endpoint:** https://api.gugudata.io/v1/imagerecognition/ocr2word/demo
- **Live Demo:** https://gugudata.io/demo/ocr2word
- **Postman:** https://www.postman.com/gugudata/gugudata-io
- **LLM Page:** https://gugudata.io/details/ocr2word/llm
- **Raw Markdown:** https://gugudata.io/details/ocr2word/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
- English OCR across five image formats: Recognize English text in JPEG, PNG, WebP, TIFF, or BMP images for Word document generation.
- Editable Word document output: Turn recognized image text into a DOCX file that teams can revise, comment on, and share.
- Downloadable HTTPS document URL: Receive a reusable HTTPS URL for the generated Word document after conversion completes.
- Human-readable output filenames: Provide an optional safe filename so downloaded documents are easier to identify in review workflows.
- Notes, receipts, forms, and scans: Create editable drafts from photographed notes, receipts, screenshots, forms, and scanned image files.
- Bounded backend document intake: Process images up to 10 MiB through upload pipelines, review queues, archives, and document handoff processes.
## 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 | N/A | JPEG, PNG, WebP, TIFF, or BMP image uploaded as multipart form data. |
| filename | string | false | result.docx | Optional filename for the generated DOCX file. |
## API Response Parameters
| Name | Type | Remark |
| --- | --- | --- |
| wordPath | string | HTTPS URL of the generated DOCX file. |
## 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/ocr2word?appkey=YOUR_APPKEY' --form 'imagefile=@localfile_path.docx' --form 'filename=result.docx'
```