apyhub-logo
120 atoms
Base tier

About

This API lets you upload and transform HTML and XHTML files to Word documents.
This API proves useful in various situations, such as when creating reports or summaries in HTML, as it enables users to easily edit the auto-generated content by sharing it as a Word document.
Try out the HTML to Word API in the API playground for free, improve your workflow, and reduce document conversion errors with a simple API call.
Select API Endpoints
Input
Output

API Playground

API Documentation

input file and output file
POST
https://api.apyhub.com/convert/html-file/doc-file

Request example

1
curl --location --request POST 'https://api.apyhub.com/convert/html-file/doc-file?output=test-sample.docx' \
2
--header 'apy-token: {{token}}' \
3
--form 'file=@"test.html"'
Method: POST
Content Type: multipart/form-data
Query Parameter(s)
AttributeTypeMandatoryDescription
outputStringNoThe Word file name for the converted document. If no output attribute is provided, the default file name will be output.docx
Request Body
AttributeTypeMandatoryDescription
fileFileYesThe source HTML file in html or xhtml
Sample Response
A successful request returns the Word file in the output parameter specified. If the request fails, the response contains an error code and a message to help determine what went wrong.

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - the files are empty or the files are corrupt
500If any unexpected error occurs while processing the request

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
"error": {
3
"code": 105,
4
"message": "Invalid URL"
5
}
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.