PDFKong - Generate Perfect PDFs Built for Developers

API Parameters

Toggle and configure options dynamically

General Configuration

mode The core processing mode for your conversion. Defines the type of source material you are converting. Can be inferred automatically in some cases, but highly recommended to set explicitly.

mode

url The website URL to capture and convert to PDF. Note: Mutually exclusive with html.

url

file The file to be converted (e.g., .docx, .xlsx, .pptx). Required for Office mode.

file

html Raw HTML content to render into a PDF document. Note: Mutually exclusive with url.

html

markdown Raw Markdown content to render into a PDF document. Note: Mutually exclusive with html and url.

markdown

filename Specify a custom filename for the generated PDF. Max: 180 chars. Value "random" generates a random name.

filename

js JS code or URL to inject as a script tag in the head section.

css CSS markup or URL to inject as a style/link tag in the head section.

css

parse_liquid Enable standard Liquid template parser for parsing dynamic loops and variables within the HTML code.

parse_liquid

liquid_data JSON structured key-value variables to replace dynamic tags when parse_liquid is true.

liquid_data

secret_key Token used to verify a request that is locked to a domain or specific html.

secret_key

enable_html_validation Automatically check if the HTML is valid and well-formed (checks tag nesting and closing tags).

enable_html_validation

General Options

sandbox Runs PDF generation in sandbox dry-run mode.

sandbox

Page Setup

page_size Standard paper format. ISO A-series: A0–A9. ISO B-series: B0–B9. Named: C5E, Comm10E, DLE, Executive, Folio, Ledger, Legal, Letter, Tabloid. Use "Custom" with page_width + page_height for any arbitrary size.

page_size

page_width Page width in mm, cm, in, px or pt.

page_width

prefer_css_page_size Force the use of page size defined by CSS (@page { size: ... }) instead of the page_size parameter.

prefer_css_page_size

generate_document_outline Embed the document outline (bookmarks) into the PDF based on the HTML heading tags (h1, h2, etc.).

generate_document_outline

page_height Page height in mm, cm, in, px or pt.

page_height

orientation Sets the orientation of the created pdf document: vertical (portrait) or horizontal (landscape).

orientation

use_print_media Set to true in order to activate CSS @media print declarations.

use_print_media

viewport Viewport size to render your html in (e.g. 1440x900).

viewport

zoom Adjust the HTML zoom factor.

zoom

print_pages Pages to print. Can be single number (3), range (1-5), list (4,5,6) or mixed (1-3,6).

print_pages

Margins

margin_top Margin at the top of the page in mm, cm, in, px or pt.

margin_top

margin_bottom Margin at the bottom of the page in mm, cm, in, px or pt.

margin_bottom

margin_left Margin at the left of the page in mm, cm, in, px or pt.

margin_left

margin_right Margin at the right of the page in mm, cm, in, px or pt.

margin_right

Filters

no_images Set to true in order to disable images.

no_images

no_links Set to true in order to disable links.

no_links

no_backgrounds Set to true in order to disable background graphics and colors.

no_backgrounds

no_javascript Set to true in order to disable javascript execution.

no_javascript

no_blank_pages Set to true in order to remove blank pages.

no_blank_pages

no_css Set to true in order to disable css.

no_css

no_ads Set to true in order to remove ads.

no_ads

no_forms Set to true in order to disable forms.

no_forms

Wait & Render

wait_for_selector Will wait until the CSS selector is present in html. Use # for id and . for className.

wait_for_selector

wait_for_function String of the function name that should be executed and waited for until it returns a result.

wait_for_function

wait_for_timeout In milliseconds. Will wait for this duration before creating the pdf.

wait_for_timeout

scroll_whole_page Scroll the whole page and load all images before rendering the pdf.

scroll_whole_page

HTTP Config

user_agent Set to your preferred User-Agent header string.

user_agent

accept_language Set to your preferred Accept-Language header string.

accept_language

accept_encoding Set to your preferred text encoding string.

accept_encoding

auth_user Username value for accessing password protected content.

auth_user

auth_password Password value for accessing password protected content.

auth_password

http_cookies JSON object with key and value of cookies that will be sent to the URL source.

http_cookies

http_headers JSON object with key and value of http headers that will be sent to the URL source.

http_headers

Security & Metadata

title Sets the title meta tag of the created pdf file.

title

author Sets the author meta tag of the created pdf file.

author

creator Sets the creator meta tag of the created pdf file.

creator

producer Sets the producer meta tag of the created pdf file.

producer

subject Sets the subject meta tag of the created pdf file.

subject

keywords Sets the keyword meta tag. Multiple keywords separated with a comma.

keywords

encrypt Set to true to encrypt the generated pdf file.

encrypt

owner_password Password of the pdf owner.

owner_password

user_password Password for the user that will view the pdf.

user_password

encryption_print_rights Sets the rights of who can print the pdf: none, low, full.

encryption_print_rights

encryption_modify_rights Sets the rights of who can modify the pdf.

encryption_modify_rights

encryption_copy_rights Sets the rights of who can copy the pdf.

encryption_copy_rights

Watermark

watermark Enable watermark overlays.

watermark

watermark_text The watermark overlay text phrase.

watermark_text

watermark_img Https URL or base64 encoded image for image watermark.

watermark_img

watermark_font_size Font size of the text of the watermark.

watermark_font_size

watermark_font_family CSS font-family for the text in the watermark. Can automatically load Google Fonts.

watermark_font_family

watermark_font_color Color of the watermark font (HEX or CSS name).

watermark_font_color

watermark_font_bold Set to true to make the watermark text bold.

watermark_font_bold

watermark_font_italic Set to true to make the text style italic.

watermark_font_italic

watermark_img_width Width of the watermark in mm, cm, in, px or pt.

watermark_img_width

watermark_img_height Height of the watermark in mm, cm, in, px or pt.

watermark_img_height

watermark_rotate Used to rotate the watermark.

watermark_rotate

watermark_opacity Set the opacity percentage of the watermark (0-100).

watermark_opacity

watermark_offset_x Offset used to horizontally align a watermark.

watermark_offset_x

watermark_offset_y Offset used to vertically align a watermark.

watermark_offset_y

watermark_in_background Set to true in order to place watermark images/text in the background.

watermark_in_background

Headers & Footers

header_html HTML template content for page headers.

header_html

header_text Standard raw text to print in the page header.

header_text

header_align Alignment property of the header content.

header_align

header_margin Margin at the top of the page for the header placement.

header_margin

footer_html HTML template content for page footers.

footer_html

footer_text Standard raw text to print in the page footer.

footer_text

footer_align Alignment property of the footer content.

footer_align

footer_margin Margin at the bottom of the page for the footer placement.

footer_margin

Location

location_accuracy Sets the accuracy of the browser location (0-100).

location_accuracy

location_lat Sets the latitude of the browser location (-90 to 90 degrees).

location_lat

location_lng Sets the longitude of the browser location (-180 to 180 degrees).

location_lng

Delivery

delivery_mode Specifies the response output flow mechanism: inline, attachment, json, base64, s3, webhook, jsonp. Note: In JSON and Webhook modes, files are temporarily stored for 24 hours to allow downloading. In all other modes, files are processed strictly in-memory and are never stored on our servers.

delivery_mode

callback Function name for the jsonp delivery mode.

callback

webhook_endpoint Webhook URL callback endpoint.

webhook_endpoint

s3_bucket_name Amazon S3 target bucket name.

s3_bucket_name

s3_bucket_key AccessKeyID of your S3 bucket.

s3_bucket_key

s3_bucket_secret Secret of your S3 bucket.

s3_bucket_secret

s3_region Amazon S3 bucket service region.

s3_region

s3_path Custom folder upload sub-path key.

s3_path

gcp_project_id Your Google Cloud Platform Project ID.

gcp_project_id

gcp_user_email The email address of your GCP service account.

gcp_user_email

gcp_private_key The private key associated with your GCP service account.

gcp_private_key

gcp_bucket_name The name of your target Google Cloud Storage bucket.

gcp_bucket_name

Image Compression

image_compression_quality Quality of the images in the pdf. Between 0 and 100. 0 is the lowest quality and 100 is the highest quality. Images get compressed in the server and then injected in the pdf to reduce the file size.

image_compression_quality

image_compression_width Images wider than the image_compression_width will be resized to the image_compression_width. Images get compressed in the server and then injected in the pdf to reduce the file size. Resized images also get compressed.

image_compression_width

Language

Download

No document compiled

Modify parameters on the left, then click "Generate PDF" to preview rendering.

API Parameters

No document compiled

JSON Mode Response Only

API Request Failed