appkey (string, required): Application key used for request authentication. Supply the value as a query parameter, form field, or multipart field according to the request content type.
content (string, required): Primary text content processed by the endpoint.
type (string, required): Endpoint-specific type selector. Refer to the endpoint description for supported values.
filename (string, optional): Optional output file name ending in .docx. Send this parameter as multipart form data.
Response Fields:
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:
200 Normal return: Word document successfully generated
400 Parameter error: Invalid or missing content/type parameters
429 Request frequency limited: Cannot exceed 100 requests per second
403 Account in arrears: Payment required to continue using the service
402 APPKEY error: Please check whether the APPKEY passed is obtained from the developer center
500 API response error: Internal server error during HTML to Word conversion
Key Features:
Convert raw HTML content into a Word document.
Support direct conversion from webpage URLs.
Provide a downloadable .docx file for editing and sharing.
Useful for reports, publishing workflows, archives, and business documentation.
Allow custom output names for better file organization.