Convert HTML to Word LLM Markdown

Back to Details
# Convert HTML to Word

Convert HTML or public webpages into editable DOCX files.

## API Overview

- **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:** https://gugudata.io/demo/html2word
- **Postman:** https://www.postman.com/gugudata/gugudata-io
- **LLM Page:** https://gugudata.io/details/html2word/llm
- **Raw Markdown:** https://gugudata.io/details/html2word/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

- 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 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. |

## cURL Example

```bash
curl --location 'https://api.gugudata.io/v1/imagerecognition/html2word?appkey=YOUR_APPKEY' --request POST --header 'Content-Type: application/x-www-form-urlencoded' --data-urlencode 'content=YOUR_VALUE' --data-urlencode 'type=html' --data-urlencode 'filename=document.docx'
```