Convert Word Documents to PDF API - ApyHub

Convert Word to PDF API

File Conversion#convert#pdf#word
ApyHub
ApyHub
verified icon
100 atoms

About

The Word to PDF API lets you convert Word documents, including DOC, DOCX, or ODF formats, into PDF files quickly and reliably. The API ensures minimal loss of formatting and preserves the integrity of your original content. You can use it to convert DOC to PDF, DOCX to PDF, or as an online Word to PDF converter in your software applications.
This API streamlines PDF generation for developers, no coders and builders. Common use cases include:
  • Automatically generating PDF invoices or reports from Word templates.
  • Converting user-submitted documents into PDFs in web or mobile apps.
  • Batch processing large numbers of Word files for enterprise workflows.
  • Integrating seamless Word to PDF conversion in SaaS platforms.
Try the Word to PDF API in the API playground for free, and experience fast, accurate, and hassle-free Word to PDF conversions.
Select API Endpoints
Input
Output

API Playground

API 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 name of the PDF file for the converted document. If the output attribute is not provided, the default file name will be output.pdf.
Request Body
AttributeTypeMandatoryDescription
fileFileYesProvide the Word document in .doc, .docx or .odf formats that will be used as input.
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 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.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles