API features
HTML and webpage input
Create a Word document from raw HTML or from a complete public HTTP(S) webpage URL.
Editable DOCX output
Give users a familiar document they can revise, comment on, archive, and share.
Readable document structure
Preserve supported headings, paragraphs, lists, tables, and links in the generated document.
Supported public images
Include compatible images from the source content to produce a more complete document.
Custom download filename
Choose a meaningful .docx filename for reports, exports, archives, and customer downloads.
Publishing and business workflows
Add Word export to CMS platforms, reporting tools, archives, and internal document processes.
API Document
HTTP Protocol:HTTPS
HTTP Method:POST
HTTP Endpoint:https://api.gugudata.io/v1/imagerecognition/html2word
Response Type:application/json; charset=utf-8
DEMO Endpoint:https://api.gugudata.io/v1/imagerecognition/html2word/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. |
| content | string | true | HTML string or webpage URL to convert. Supported in JSON and multipart form data. | |
| type | string | false | html | Request type. Supported values are html and url. Supported in JSON and multipart form data. |
| filename | string | false | document.docx | Optional output file name ending in.docx. Supported in JSON and multipart form data. |
API Response Parameters
| Name | Type | Remark |
|---|---|---|
| wordPath | string | Download URL of the generated.docx document. |
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. |
| 422 | The submitted content cannot be converted to a Word document. | Provide readable HTML content or a supported public webpage URL. |
| 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. |
| 502 | The requested webpage could not be retrieved successfully. | Retry later or verify that the public webpage is available. |
| 503 | The document conversion service is temporarily unavailable. | Retry later or contact support if the error persists. |
Remote MCP
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.
https://mcp.gugudata.io/mcp{
"mcpServers": {
"gugudata": {
"url": "https://mcp.gugudata.io/mcp",
"transportType": "streamable-http"
}
}
}Code Snippets
Frequently asked questions
Common questions about request limits, trials, renewal, and cancellation.
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.
Service terms
Read our service terms and privacy policy before subscribing.




