Image OCR to Word API

Image OCR to Word API
Extract text from an uploaded image and return the OCR result as a downloadable Word document.

Method: POST
Path: /v1/imagerecognition/ocr2word
Demo: https://api.gugudata.io/v1/imagerecognition/ocr2word/demo
OpenAPI: https://gugudata.io/assets/openapi/gugudata.openapi.3.1.json

Request Parameters:

appkey (string, required): Application key used for request authentication.

imagefile (file, required): Image file uploaded as multipart form data.

filename (string, optional): Output Word file name ending in .docx.

Response Fields:

dataStatus (object, required): Response metadata returned by the current v1 contract.

data.wordPath (string, required): Download URL of the generated Word document.

HTTP Status Codes:

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 concurrency or retry after the limit window resets.

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.

Business Status Codes:

No endpoint-specific business status codes are documented.

Key Features:

Production-ready HTTPS API with stable request and response contracts.

Details:
https://gugudata.io/details/ocr2word

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request

Request Code Samples

Responses