PDF from URL (URL to PDF)
Description: Create PDF from URL. 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 |
Available Methods
[POST] /pdf/convert/from/url
Generate PDF from URL or link to HTML page. You can set the following parameters:
Attributes |
---|
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 getting a Too Many Requests or Access Denied error for your input URL, Please try to add cache: to enable built-in URL caching. You can also encrypt data for output files and decrypt data input files with user-controlled data encryption to learn more. |
async optional Runs processing asynchronously and returns JobId that you may use with /job/check to check the state of the processing (possible states: working , failed , aborted and success ). Must be one of: true , or false . |
name optional File name for the generated output, The input must be in string format. |
expiration optional Output link expiration in minutes. The default is 60 (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. |
margins optional Set to CSS style margins like 10px , 5mm , 5in for all sides or 5px 5px 5px 5px (the order of margins is top , right , bottom , left ). |
paperSize optional Letter is set by default. Can be Letter , Legal , Tabloid , Ledger , A0 , A1 , A2 , A3 , A4 , A5 , A6 or a custom size. Custom size can be set in px (pixels), mm or in (inches) with width and height separated by space like this: 200 300 , 200px 300px , 200mm 300mm , 20cm 30cm or 6in 8in . |
orientation optional Set to Portrait or Landscape . Portrait by default. |
printBackground optional true by default. Set to false to disable printing of background. |
mediaType optional Uses print by default. Set to screen to convert HTML as it appears in a browser or print to convert as it appears for printing or none to set none as mediaType for CSS styles. |
DoNotWaitFullLoad optional false by default. Set to true to skip waiting for full load (like full video load etc that may affect the total conversion time). |
profiles optional Use this parameter to set additional configurations for fine-tuning and extra options, The input must be in string format. Explore PDF.co knowledgebase for profile examples. |
header optional Set to HTML for the header to be applied on every page at the header. |
footer optional Set to HTML for the footer to be applied on every page at the bottom. |
The header
and footer
params should contain valid HTML markup with the following classes used to inject printing values into them:
date
: formatted print date title
: document title url
: document location pageNumber
: current page number totalPages
: total pages in the document
For example, the following markup will generate Page N of NN
page numbering:
<span style='font-size:10px'>Page <span class='pageNumber'></span> of <span class='totalPages'></span>.</span>
Sample URL To PDF with advanced header and footer. Note that the top and bottom page margins are important because page content may overlap the footer or header.
{
"url": "https://wikipedia.org",
"async": false,
"name": "result.pdf",
"margins": "40px 5px 40px 5px",
"paperSize": "Letter",
"orientation": "Portrait",
"printBackground": true,
"header": "<div style='width:100%'><span style='font-size:10px;margin-left:20px;width:50%;float:left'>LEFT SUBHEADER</span><span style='font-size:8px;width:30%;float:right'>RIGHT SUBHEADER</span></div>",
"footer": "<div style='width:100%;text-align:right'><span style='font-size:10px;margin-right:20px'>Page <span class='pageNumber'></span> of <span class='totalPages'></span>.</span></div>"
}
- Method: POST
- URL: /v1/pdf/convert/from/url
Query parameters
No query parameters accepted.
Body payload
{
"url": "https://wikipedia.org/wiki/Wikipedia:Contact_us",
"margins": "5mm",
"paperSize": "Letter",
"orientation": "Portrait",
"printBackground": true,
"header": "",
"footer": "",
"mediaType": "print",
"async": false,
"profiles": "{ \"CustomScript\": \";; // put some custom js script here \"}"
}
Example responses
/pdf/convert/from/url (with header and footer)
Code Snippet
CURL
curl --location --request POST 'https://api.pdf.co/v1/pdf/convert/from/url' \
--header 'x-api-key: ' \
--header 'Content-Type: application/json' \
--data-raw '{
"url": "https://wikipedia.org/wiki/Wikipedia:Contact_us",
"margins": "5mm",
"paperSize": "Letter",
"orientation": "Portrait",
"printBackground": true,
"header": "",
"footer": "",
"mediaType": "print",
"async": false,
"profiles": "{ \"CustomScript\": \";; // put some custom js script here \"}"
}'
Samples
- AWS Lambda - Convert Web Page To PDF From Link (Node.js)
- C# - Convert Web Page To PDF From Link
- C# - Convert Web Page To PDF From Link Asynchronously
- Java - Convert Web Page To PDF From Link
- JavaScript - Convert Web Page To PDF From Link (Node.js)
- JavaScript - Convert Web Page To PDF From Link (Node.js) - Async API
- PHP - Convert Web Page To PDF From Link
- PHP - Convert Web Page To PDF From Link Asynchronously
- PowerShell - Convert Web Page To PDF From Link
- PowerShell - Convert Web Page To PDF From Link Asynchronously
- Python - Convert Web Page To PDF From Link
- Python - Convert Web Page To PDF From Link Asynchronously
- Salesforce - PDF From URL
- VB.NET - Convert Web Page To PDF From URL
- VB.NET - Convert Web Page To PDF From URL Asynchronously
Copyright © 2016 - 2023 PDF.co