PDF from URL

Available Methods

• /pdf/convert/from/url

/pdf/convert/from/url

Create PDF from a URL.

• Method: POST

• Endpoint: /v1/pdf/convert/from/url

Attributes

Note

Attributes are case-sensitive and should be inside JSON for POST request, for example:

{
    "url": "https://example.com/file1.pdf"
}

Attribute	Description	Required
url	URL to the source file. 1	yes
margins	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).	no
paperSize	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.	no
orientation	Set to Portrait or Landscape. Portrait by default.	no
printBackground	true by default. Set to false to disable printing of background.	no
mediaType	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.	no
DoNotWaitFullLoad	false by default. Set to true to skip waiting for full load (like full video load etc. that may affect the total conversion time).	no
header	User definable HTML for the header to be applied on every page header.	no
footer	User definable HTML for the footer to be applied on every page bottom.	no
async	Set async to true for long processes to run in the background, API will then return a jobId which you can use with the Background Job Check endpoint to check the status of the process and retrieve the output while you can proceed with other tasks.	no
name	File name for the generated output, the input must be in string format.	no
expiration	Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co Temporary Files Storage. The maximum duration for link expiration varies based on your current subscription plan. To store permanent input files (e.g. re-usable images, pdf templates, documents) consider using PDF.co Built-In Files Storage.	no
profiles	Use this parameter to set additional configurations for fine-tuning and extra options. Explore the Profiles section for more.	no

Header & Footer

The header and footer parameters can 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 Header & Footer

An example with an 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>"
}

Query parameters

No query parameters accepted.

Payload

{
    "url": "https://wikipedia.org/wiki/Wikipedia:Contact_us",
    "name": "result.pdf",
    "margins": "5mm",
    "paperSize": "Letter",
    "orientation": "Portrait",
    "printBackground": true,
    "header": "",
    "footer": "",
    "mediaType": "print",
    "async": false,
    "profiles": "{ \"CustomScript\": \";; // put some custom js script here \"}"
}

Response 2

{
    "url": "https://pdf-temp-files.s3.amazonaws.com/97dc323f32794eae8fa6602f5bd981c1/result.pdf",
    "pageCount": 1,
    "error": false,
    "status": 200,
    "name": "result.pdf",
    "remainingCredits": 60646
}

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 \"}"
}'

---

Code samples

• JavaScript samples

• Python samples

• C# samples

• Java samples

• PHP samples

• PowerShell samples

• Salesforce samples

• AWS Lambda samples

• VB.NET samples

• cURL samples

Footnotes

1

Supports links from Google Drive, Dropbox, and PDF.co Built-In Files Storage. To upload files via the API check out the File Upload section. Note: If you experience intermittent Too Many Requests or Access Denied errors, please try to add cache: to enable built-in URL caching. (e.g cache:https://example.com/file1.pdf) For data security, you have the option to encrypt output files and decrypt input files. Learn more about user-controlled data encryption.

2

Response codes as follows:

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 the async parameter to true) and then check status using the /job/check endpoint. If a file contains many pages then specify a page range using the pages parameter. The number of pages of the document can be obtained using the /pdf/info endpoint.

Was this page helpful? Yes No

Are you a human?

Close

---