PDF from Doc, DocX, RTF, TXT, XPS (Document to PDF)
Description: Convert DOC, DOCX, RTF, TXT, XPS files into PDF. GET
or POST
request.
Status Errors
Code | Description |
---|---|
200 | The request has succeeded |
400 | bad input parameters |
401 | unauthorized |
403 | not enough credits |
405 | Timeout error. To process large documents or files please use asynchronous mode ( set async parameter to true) and then check the status using /job/check endpoint. If a file contains many pages then specify a page range using pages parameter. The number of pages of the document can be obtained using the endpoint /pdf/info |
Example
Sample Request:
! Don’t forget to set x-api-key
url param or http header param (preferred) to API key, get yours here
POST
{
"name" : "result.pdf",
"url" : "https://bytescout-com.s3.amazonaws.com/files/doc-to-pdf/sample.docx"
}
Available Methods
[POST] /pdf/convert/from/doc
url
required. URL to the source file. Supports links from Google Drive, Dropbox and from built-in PDF.co files storage.
For uploading files via API please check Files Upload section.
If you are randomly gettingToo Many Requests
orAccess Denied
error for your input url, please try to addcache:
to enable built-in url caching.
You can also encrypt data for output files and decrypt data input files with user-controlled data encryption (uses strongAES
encryption with your own keys). Click here to learn more.httpusername
optional - http auth user name if required to access sourceurl
.httppassword
optional - http auth password if required to access sourceurl
.pages
optional. Comma-separated list of page indices (or ranges) to process. IMPORTANT: the very first page starts at0
(zero). To set a range use the dash-
, for example:0,2-5,7-
. To set a range from index to the last page use range like this:2-
(from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example:0,2-5,7-
means first page, then 3rd page to 6th page, and then the range from 8th (index =7
) page till the end of the document. Must be a String.name
optional. File name for generated output. Must be a String.expiration
optional. Output link expiration in minutes. Default is60
(i.e. 60 minutes or 1 hour). After this delay generated output file(s) (if any) will be auto-removed from PDF.co temporary files storage. Max allowed expiration period depends on your current subscription plan. To store permanent input files (e.g. re-usable images, pdf, documents), please use PDF.co built-in Files Storage instead.async
optional. Runs processing asynchronously. ReturnsJobId
that you may use with/job/check
to check state of the background job (possible states:working
,failed
,aborted
andsuccess
). Must be one of:true
,false
.profiles
optional. Must be a String. Use this parameter to set additional configuration for fine tuning and extra options. Explore PDF.co knowledgebase for profile examples.- Method: POST
- URL: /v1/pdf/convert/from/doc
Query parameters
No query parameters accepted.
Body payload
{
"url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/doc-to-pdf/sample.docx",
"pages": "0-",
"name": "result.pdf",
"async": false
}
Example responses
POST /pdf/convert/from/doc
{
"url": "https://pdf-temp-files.s3-us-west-2.amazonaws.com/efc283805b4a47da87910826d4ddf063/result.pdf?X-Amz-Expires=3600&x-amz-security-token=FwoGZXIvYXdzEKz%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDFzXkfTapcUbLLKahiKBAbIL4F2wV3gvozuGDxmOpWUu9ETuVzkYKjMuNLAFzVZeSgRm9Yuaj7ubad9uOLQkL65GNgBQoy1Xm%2FxtLWD9tegUYd3hFvYfIWMfkWjuROwMGTZeD3CMacDPdFkP%2BUSG4aXOZb8MoG2PXnsd9UUeOvrevZkCVTg77OBXIteBCPOojSjeis%2F5BTIoVCi%2FrwV5kEGkbfBwtgsfQL3MxSbg7j%2Fud%2F3oGbUWW7zsemcfiHTiFg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA4NRRSZPHAK44PZ6O/20200812/us-west-2/s3/aws4_request&X-Amz-Date=20200812T103301Z&X-Amz-SignedHeaders=host;x-amz-security-token&X-Amz-Signature=6a176281828de74c917a4ff5bacd46eeca50221178bf34d01cac331f172e51c3",
"pageCount": 1,
"error": false,
"status": 200,
"name": "result.pdf",
"remainingCredits": 61165
}
Code Snippet
CURL
curl --location --request POST 'https://api.pdf.co/v1/pdf/convert/from/doc' \
--header 'x-api-key: ' \
--header 'Content-Type: application/json' \
--data-raw '{
"url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/doc-to-pdf/sample.docx",
"pages": "0-",
"name": "result.pdf",
"async": false
}'
Samples
- AWS Lambda - Convert DOC To PDF From URL (Node.js)
- C# - Convert DOC To PDF From URL
- C# - Convert DOC To PDF From URL Asynchronously
- C# - Convert DOC To PDF From Uploaded File
- C# - Convert Encrypted DOC To PDF From URL
- Delphi - Convert DOC To PDF From Uploaded File
- Java - Convert DOC To PDF From URL
- Java - Convert DOC To PDF From Uploaded File
- Java - Convert Encrypted DOC To PDF From URL
- JavaScript - Convert DOC To PDF From Base64 (Node.js)
- JavaScript - Convert DOC To PDF From URL (Node.js)
- JavaScript - Convert DOC To PDF From URL (Node.js) - Async API
- JavaScript - Convert DOC To PDF From Uploaded File (Node.js)
- JavaScript - Convert DOC To PDF From Uploaded File (Node.js) - Async API
- JavaScript - Convert DOC To Protected PDF From URL (Node.js)
- JavaScript - Convert DOC To Protected PDF From URL (Node.js) - Async API
- JavaScript - Convert Encrypted DOC To PDF From URL (Node.js) - Async API
- PHP - Convert DOC To PDF Asynchronously
- PHP - Convert DOC To PDF From Uploaded File
- PHP - Convert DOC to Protected PDF from Uploaded File
- PHP - Convert Encrypted DOC To PDF Asynchronously
- PowerShell - Convert DOC To PDF From URL
- PowerShell - Convert DOC To PDF From URL Asynchronously
- PowerShell - Convert DOC To PDF From Uploaded File
- PowerShell - Convert Encrypted DOC To PDF From URL Asynchronously
- Python - Convert DOC To PDF From URL
- Python - Convert DOC To PDF From URL Asynchronously
- Python - Convert DOC To PDF From Uploaded File
- Python - Convert Encrypted DOC To PDF From URL Asynchronously
- Salesforce - Convert Document To PDF
- VB.NET - Convert DOC To PDF From URL
- VB.NET - Convert DOC To PDF From URL Asynchronously
- VB.NET - Convert DOC To PDF From Uploaded File
- VB.NET - Convert Encrypted DOC To PDF From URL Asynchronously
- cURL - Convert Encrypted DOC To PDF From URL
- cURL - Document to PDF
Copyright © 2016 - 2023 PDF.co