API features

Word document input

Upload DOC or DOCX documents for conversion.

Readable HTML

View converted document content in a browser.

Document structure

Retain supported headings, paragraphs and lists.

Embedded images

Include supported document images in the HTML output.

Downloadable results

Retrieve the converted HTML through an HTTPS file link.

Content workflows

Prepare documents for publishing, migration and review.

API Document

HTTP Protocol:HTTPS

HTTP Method:POST

HTTP Endpoint:https://api.gugudata.io/v1/imagerecognition/word-to-html

Response Type:application/json; charset=utf-8

DEMO Endpoint:https://api.gugudata.io/v1/imagerecognition/word-to-html/demo

Live Demo:Try Interactive Demo

Postman Collection:Run in Postman

API Request Parameters

Name	Type	Is Required	Default Value	Remark
appkey	string	true	YOUR_APPKEY	API key used to authenticate the request.
file	file	true		DOC or DOCX file uploaded as multipart form data.

API Response Parameters

Name	Type	Remark
html_url	string	HTTPS URL of the generated HTML file.
html_content	string	Generated HTML content, including supported embedded content.

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.

Remote MCP

AI client access

Use this API through GuGuData Remote MCP

Connect your AI client once, authorize in the browser, and the client can use the GuGuData API tools available to your account. You do not need to paste an appkey into the MCP client.

Endpoint https://mcp.gugudata.io/mcp

Open MCP Guide

Generic MCP configuration

{
  "mcpServers": {
    "gugudata": {
      "url": "https://mcp.gugudata.io/mcp",
      "transportType": "streamable-http"
    }
  }
}

Code Snippets

Run in Postman Open LLM Page

Frequently asked questions

Can I upload both DOC and DOCX files?

Yes. Upload a DOC or DOCX file in the multipart file field. This endpoint takes a Word document rather than an HTML string or a webpage URL.

Does the response include HTML content or only a file link?

It includes html_url for the generated HTML file and html_content containing the converted markup. Use the inline content for processing or download the file for a separate publishing step.

Can I use the output in a web publishing workflow?

Yes. The generated HTML can be a starting point for publishing document content. Review the converted markup and apply your site styling before presenting it to readers.

Will Word pagination and layout be preserved exactly?

Do not assume exact page or layout fidelity. Word documents and HTML have different layout models, so test tables, images, and formatting that matter to your application.

Does the API also edit the original Word file?

No. This operation converts the uploaded document into HTML. It does not provide an editor or synchronize later HTML changes back into the original DOC or DOCX file.

What does the 5 requests per second limit mean?

It is a request-rate limit, not a concurrency allowance. Keep your request rate at or below 5 per second. If the service returns a rate-limit response, reduce the frequency and retry with backoff.

Is total paid usage limited?

There is no total request cap during an active paid subscription and no usage-based overage charge.

How does the free trial work?

Each account can receive a limited trial key. Requests are shared across APIs in the same category. Check Trial Keys for the exact allowance and remaining requests.

How do renewal and cancellation work?

The plan renews annually until canceled. Manage or cancel the renewal from Dashboard → Orders & Billing. Access continues through the paid period after cancellation. See the Terms of Service for the current refund policy. If the billing portal is unavailable, contact support.

Technical support

Need help choosing an API or getting started?

support@gugudata.io

Service terms

Read our service terms and privacy policy before subscribing.