Web to PDF API

URI of a web page to convert. If URI has special characters like ? or & they must be encoded.

Delay in seconds before page load and PDF creation. Sometimes useful to let web page fully load.

Specify a particular version of the Chromium engine to render the web page.

Block ads in converting page.

Tries to remove EU regulation required cookie warnings from web pages.

Allow web pages to run JavaScript.

Element selector string of the DOM element. Converter will wait for this element to appear in DOM before conversion begins.

Execute provided JavaScript before conversion begins.

Apply additional CSS before conversion begins.

Element selector string of the DOM elements that needs to be hidden during conversion.

Use CSS media type in conversion process. The default screen and print media types are supported but not limited to these. The custom media type, like convertapi can be used too.

Set custom HTTP headers to include in the request. Format: Header1:Value1|Header2:Value2|Header3:Value3

• Each header is separated by |.
• Each name/value pair is separated by :.

Load page images that loads only when they are visible.

Sets browser viewport width.

Sets browser viewport height.

Convert web page background.

Change fixed elements CSS 'position' property to adapt page for conversion.

Element selector string of the DOM elements that should be visible during conversion. Other elements will be hidden.

CSS selector for the elements that pages should not break.

CSS selector for the elements that should apply page break before it.

CSS selector for the elements that should apply page break after it.

HTTP authentication username. Could be used if conversion web page is protected with HTTP authentication.

HTTP authentication password. Could be used if conversion web page is protected with HTTP authentication.

Set additional cookies for the page request. Example: cookiename1=cookievalue1; cookiename2=cookievalue2; cookiename3=cookievalue3

If true, the converter will generate PDF as the content looks like in the browser. If is set to false, the converter acts like Chrome print to PDF function.

Set web page scale value in percentage.

PDF page orientation.

PDF page size.

Set the page top margin in millimeters (mm).

Set the page right margin in millimeters (mm).

Set the page bottom margin in millimeters (mm).

Set the page left margin in millimeters (mm).

This property will insert an HTML header into each page. HTML tags containing the classes pageNumber, totalPages, title, and date will be filled in with the metadata relevant to each individual page. Inline CSS could be utilized to style the HTML provided.

<style>
    .right {
        float: right;
    }

    .left {
        float: left;
    }
</style>
<span class='left'>
    page number 
    <span class='pageNumber'></span>
</span>
<span class='right'>
    date 
    <span class='date'></span>
</span>

This property will insert an HTML footer into each page. HTML tags containing the classes pageNumber, totalPages, title, and date will be filled in with the metadata relevant to each individual page. Inline CSS could be utilized to style the HTML provided.

<style>
    .right {
        float: right;
    }

    .left {
        float: left;
    }
</style>
<span class='left'>
    page number 
    <span class='pageNumber'></span>
</span>
<span class='right'>
    date 
    <span class='date'></span>
</span>

Custom page width in millimeters (mm). This option override PageSize option.

Custom page height in millimeters (mm). This option override PageSize option.

Set page range. Example 1-10 or 1,2,5.

When the StoreFile parameter is set to True, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.

When StoreFile is set to False, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.