apyhub-logo
50 atoms
Base tier

About

The word to pdf conversion service lets you upload and convert a word document (doc, docx or odf formats) to a pdf document. Using this service, you can quickly and accurately transform any Word document to PDF online with minimal loss to the formatting.
There might be several scenarios when you collect word documents from your users as reports, assignments, and so on. However, you must convert them into pdf files to ensure that the documents are safe from unintentional modifications. PDFs also ensure that anyone can view the documents without the need for additional software.
Endpoint Selector
Input
Output

API Playground

Documentation

upload file: download file
POST
https://api.apyhub.com/convert/word-file/pdf-file

Request example

1
curl --location --request POST 'https://api.apyhub.com/convert/word-file/pdf-file?output=test-sample.pdf&landscape=false' \
2
--header 'apy-token: {{token}}' \
3
--form 'file=@"test.doc"'
Method: POST
Content Type: multipart/form-data
Query Parameter(s)
AttributeTypeMandatoryDescription
landscapeBooleanNoIndicates whether the input document is in landscape mode (default is false)
outputStringNoThe PDF file name for the converted document. If no output attribute is provided, the default file name will be output.pdf
Request Body
AttributeTypeMandatoryDescription
fileFileYesThe source word document in doc, docx or odf formats.
Sample Response
A successful request returns the PDF 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 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 workspace settings (on the left side of the navbar) and go to applications.
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.