PDF Munk API Reference | HTML to Image API Docs

Generate PDF from HTML or URL

post

Creates a PDF from either HTML content or a URL. Supports custom page sizes, fonts, viewport dimensions, and dynamic parameters.

Note: Either url or html_content must be provided, but not both.

Authorizations

CLIENT-API-KEYstringRequired

API key for authentication. Get your key from https://pdfmunk.com/dashboard

Body

urlstring · uriOptional

URL of the webpage to convert to PDF

Example: https://example.com

html_contentstringRequired

HTML content to convert to PDF

Example: <html><body><h1>Hello World</h1></body></html>

css_contentstringOptional

Optional CSS to apply to the HTML

Example: body { font-family: Arial; }

output_formatstring · enumOptional

Output format:

url: Returns a URL to the uploaded PDF (default)
pdf, binary, file: Returns the PDF file directly

Default: urlPossible values:

paper_sizestring · enumOptional

Paper size for the PDF

Default: A4Possible values:

landscapebooleanOptional

Set to true for landscape orientation

Default: false

printBackgroundbooleanOptional

Whether to print background graphics

Default: true

displayHeaderFooterbooleanOptional

Whether to display header and footer

Default: false

preferCSSPageSizebooleanOptional

Whether to prefer CSS-defined page size

Default: true

page_sizeinteger · min: 1 · max: 20Optional

Maximum number of pages to generate (tier-dependent)

Example: 10

paperWidthnumberOptional

Custom paper width in pixels

Example: 800

paperHeightnumberOptional

Custom paper height in pixels

Example: 1200

viewPortWidthintegerOptional

Viewport width for rendering

Default: 1080Example: 1920

viewPortHeightintegerOptional

Viewport height for rendering

Default: 720Example: 1080

fontstringOptional

Google Font name(s) to include (use | separator for multiple)

Example: Roboto|Open Sans

wait_tillintegerOptional

Time to wait in seconds before generating PDF

Default: 0Example: 2

Responses

200

PDF generated successfully

successbooleanOptionalExample: true

pdf_urlstring · uriOptional

URL to download the PDF (when output_format is 'url')

Example: https://storage.pdfmunk.com/pdfs/abc123.pdf

file_size_bytesintegerOptionalExample: 51234

file_deletion_datestring · dateOptional

Date when the file will be deleted (30 days)

Example: 2026-01-12

source_typestring · enumOptionalExample: htmlPossible values:

400

Bad request - validation error

application/json

401

Unauthorized - invalid or missing API key

application/json

500

Internal server error

application/json

post

/v1/generatePdf

POST /api/v1/generatePdf HTTP/1.1
Host: pdfmunk.com
CLIENT-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "html_content": "<html><body><h1>Invoice</h1><p>Total: $100</p></body></html>",
  "css_content": "body { font-family: Arial; } h1 { color: blue; }",
  "output_format": "url",
  "paper_size": "A4"
}

{
  "success": true,
  "pdf_url": "https://storage.pdfmunk.com/pdfs/abc123.pdf",
  "file_size_bytes": 51234,
  "file_deletion_date": "2026-01-12",
  "source_type": "html"
}

Generate image from HTML or URL

post

Creates a PNG image from either HTML content or a URL. Supports custom dimensions, quality settings, fonts, and dynamic parameters.

Note: Either url or html_content must be provided, but not both.

Authorizations

CLIENT-API-KEYstringRequired

API key for authentication. Get your key from https://pdfmunk.com/dashboard

Body

urlstring · uriOptional

URL of the webpage to capture as image

Example: https://example.com

html_contentstringOptional

HTML content to render as image

Example: <div style='padding: 20px;'><h1>Hello</h1></div>

css_contentstringOptional

Optional CSS to apply to the HTML

Example: div { background: white; }

output_formatstring · enumOptional

Output format:

url: Returns a URL to the uploaded image (default)
base64: Returns base64-encoded image string
both: Returns both URL and base64
image, png, binary, file: Returns the image file directly

Default: urlPossible values:

widthintegerOptional

Width of the output image in pixels

Default: 1280Example: 800

heightintegerOptional

Height of the output image in pixels

Default: 720Example: 600

viewPortWidthintegerOptional

Viewport width for rendering (if different from output width)

Example: 1920

viewPortHeightintegerOptional

Viewport height for rendering (if different from output height)

Example: 1080

device_scale_factornumber · min: 1 · max: 3Optional

Device scale factor for higher resolution

Default: 1Example: 2

qualityinteger · min: 30 · max: 100Optional

Image quality (30-100)

Default: 80Example: 90

full_pagebooleanOptional

Capture full page (for URLs only)

Default: false

wait_tillintegerOptional

Time to wait in seconds before capturing

Default: 0Example: 2

wait_untilstring · enumOptional

When to consider navigation successful (for URLs)

Default: loadPossible values:

fontstringOptional

Google Font name(s) to include (use | separator for multiple)

Example: Poppins|Montserrat

Responses

200

Image generated successfully

successbooleanOptionalExample: true

image_urlstring · uriOptional

URL to download the image (when output_format is 'url' or 'both')

Example: https://storage.pdfmunk.com/images/xyz789.png

image_base64stringOptional

Base64-encoded image (when output_format is 'base64' or 'both')

Example: iVBORw0KGgoAAAANSUhEUgAAAAUA...

file_size_bytesintegerOptionalExample: 28491

file_deletion_datestring · dateOptionalExample: 2026-01-12

request_idstring · uuidOptionalExample: 550e8400-e29b-41d4-a716-446655440000

execution_time_msintegerOptional

Time taken to generate the image in milliseconds

Example: 1523

400

Bad request

application/json

401

Unauthorized

application/json

429

Rate limit exceeded

application/json

500

Internal server error

application/json

post

/v1/generateImage

POST /api/v1/generateImage HTTP/1.1
Host: pdfmunk.com
CLIENT-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 221

{
  "html_content": "<div style='width: 600px; padding: 40px; background: linear-gradient(135deg, #667eea 0%, #764ba2 100%); color: white;'><h1>Welcome!</h1></div>",
  "width": 600,
  "height": 400,
  "output_format": "url",
  "quality": 90
}

{
  "success": true,
  "image_url": "https://storage.pdfmunk.com/images/xyz789.png",
  "image_base64": "iVBORw0KGgoAAAANSUhEUgAAAAUA...",
  "file_size_bytes": 28491,
  "file_deletion_date": "2026-01-12",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "execution_time_ms": 1523
}

Generate chart image using Chart.js

post

Creates a chart image using Chart.js library. Supports various chart types including line, bar, pie, doughnut, radar, and more.

Authorizations

CLIENT-API-KEYstringRequired

API key for authentication. Get your key from https://pdfmunk.com/dashboard

Body

chart_typestring · enumRequired

Type of chart to generate

Example: barPossible values:

widthintegerOptional

Width of the chart in pixels

Default: 800Example: 1000

heightintegerOptional

Height of the chart in pixels

Default: 600Example: 600

output_formatstring · enumOptional

Output format for the chart image

Default: urlPossible values:

Responses

200

Chart generated successfully

successbooleanOptionalExample: true

chart_urlstring · uriOptional

URL to the chart image (when output_format is 'url' or 'both')

chart_base64stringOptional

Base64-encoded chart (when output_format is 'base64' or 'both')

file_size_bytesintegerOptionalExample: 45678

file_deletion_datestring · dateOptionalExample: 2026-01-12

request_idstring · uuidOptional

execution_time_msintegerOptionalExample: 892

400

Bad request

application/json

401

Unauthorized

application/json

post

/v1/generateChart

POST /api/v1/generateChart HTTP/1.1
Host: pdfmunk.com
CLIENT-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 374

{
  "chart_type": "bar",
  "data": {
    "labels": [
      "Q1",
      "Q2",
      "Q3",
      "Q4"
    ],
    "datasets": [
      {
        "label": "Revenue",
        "data": [
          120000,
          150000,
          180000,
          200000
        ],
        "backgroundColor": "rgba(54, 162, 235, 0.6)",
        "borderColor": "rgba(54, 162, 235, 1)",
        "borderWidth": 1
      }
    ]
  },
  "options": {
    "responsive": true,
    "plugins": {
      "title": {
        "display": true,
        "text": "Quarterly Revenue 2024"
      }
    }
  },
  "width": 800,
  "height": 500,
  "output_format": "url"
}

{
  "success": true,
  "chart_url": "https://example.com",
  "chart_base64": "text",
  "file_size_bytes": 45678,
  "file_deletion_date": "2026-01-12",
  "request_id": "123e4567-e89b-12d3-a456-426614174000",
  "execution_time_ms": 892
}

Compress an image

post

Compresses an image from a URL or base64 string with adjustable quality settings. Maximum file size: 3MB.

Authorizations

CLIENT-API-KEYstringRequired

API key for authentication. Get your key from https://pdfmunk.com/dashboard

Body

image_urlstring · uriOptional

URL of the image to compress

Example: https://example.com/image.jpg

base64_imagestringOptional

Base64-encoded image (alternative to image_url)

Example: data:image/jpeg;base64,/9j/4AAQSkZJRg...

output_formatstring · enumOptional

Format of the compressed image output

Default: urlPossible values:

qualityinteger · min: 1 · max: 100Optional

Compression quality (1-100, higher = better quality)

Default: 85Example: 80

Responses

200

Image compressed successfully

application/json

successbooleanOptionalExample: true

compressed_image_urlstring · uriOptional

URL to compressed image (when output_format is 'url')

compressed_base64_imagestringOptional

Base64-encoded compressed image (when output_format is 'base64')

original_size_bytesintegerOptionalExample: 1048576

compressed_size_bytesintegerOptionalExample: 524288

compressed_size_kbnumber · floatOptionalExample: 512

compression_percentagenumber · floatOptional

Percentage of size reduction

Example: 50

file_deletion_datestring · dateOptionalExample: 2026-01-12

400

Bad request

application/json

post

/v1/compress

POST /api/v1/compress HTTP/1.1
Host: pdfmunk.com
CLIENT-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "image_url": "https://example.com/large-image.jpg",
  "output_format": "url",
  "quality": 75
}

{
  "success": true,
  "compressed_image_url": "https://example.com",
  "compressed_base64_image": "text",
  "original_size_bytes": 1048576,
  "compressed_size_bytes": 524288,
  "compressed_size_kb": 512,
  "compression_percentage": 50,
  "file_deletion_date": "2026-01-12"
}

Merge multiple PDFs

post

Merges multiple PDF files from URLs into a single PDF document.

Limits:

Maximum 15 input PDFs
Maximum 200 pages per PDF
Maximum 500 total pages combined

Authorizations

CLIENT-API-KEYstringRequired

API key for authentication. Get your key from https://pdfmunk.com/dashboard

Body

urlsstring · uri[] · min: 2 · max: 15Required

Array of PDF URLs to merge

Example: ["https://example.com/doc1.pdf","https://example.com/doc2.pdf","https://example.com/doc3.pdf"]

Responses

200

PDFs merged successfully

application/json

successbooleanOptionalExample: true

merged_pdf_urlstring · uriOptionalExample: https://storage.pdfmunk.com/merged/abc123.pdf

total_pagesintegerOptional

Total number of pages in merged PDF

Example: 45

input_countintegerOptional

Number of input PDFs merged

Example: 3

file_deletion_datestring · dateOptionalExample: 2026-01-12

400

Bad request

application/json

post

/v1/pdf/merge

POST /api/v1/pdf/merge HTTP/1.1
Host: pdfmunk.com
CLIENT-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "urls": [
    "https://example.com/doc1.pdf",
    "https://example.com/doc2.pdf",
    "https://example.com/doc3.pdf"
  ]
}

{
  "success": true,
  "merged_pdf_url": "https://storage.pdfmunk.com/merged/abc123.pdf",
  "total_pages": 45,
  "input_count": 3,
  "file_deletion_date": "2026-01-12"
}

Split or extract pages from a PDF

post

Splits a PDF or extracts specific pages based on page ranges.

Page Range Format:

Single page: "3"
Range: "1-5"
Multiple ranges: "1-3,5,7-10"
Open-ended: "10-" (from page 10 to end)

Limits:

Maximum 200 pages per PDF

Authorizations

CLIENT-API-KEYstringRequired

API key for authentication. Get your key from https://pdfmunk.com/dashboard

Body

urlstring · uriRequired

URL of the PDF to split

Example: https://example.com/document.pdf

pagesstringRequired

Page range specification

Example: 1-5,8,10-

Responses

200

PDF split successfully

application/json

successbooleanOptionalExample: true

split_pdf_urlstring · uriOptionalExample: https://storage.pdfmunk.com/split/xyz789.pdf

extracted_pagesintegerOptional

Number of pages extracted

Example: 8

original_pagesintegerOptional

Total pages in original PDF

Example: 50

file_deletion_datestring · dateOptionalExample: 2026-01-12

400

Bad request

application/json

post

/v1/pdf/split

POST /api/v1/pdf/split HTTP/1.1
Host: pdfmunk.com
CLIENT-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "url": "https://example.com/report.pdf",
  "pages": "1-5"
}

{
  "success": true,
  "split_pdf_url": "https://storage.pdfmunk.com/split/xyz789.pdf",
  "extracted_pages": 8,
  "original_pages": 50,
  "file_deletion_date": "2026-01-12"
}

Unlock a password-protected PDF

post

Removes password protection from a PDF file. Supports both user and owner passwords.

Maximum file size: 10MB

Authorizations

CLIENT-API-KEYstringRequired

API key for authentication. Get your key from https://pdfmunk.com/dashboard

Body

filestring · binaryRequired

PDF file to unlock

passwordstringRequired

Password to unlock the PDF

Example: secret123

output_namestringOptional

Optional custom name for output file

Example: unlocked_document.pdf

Responses

200

PDF unlocked successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: PDF unlocked successfully

unlocked_pdf_urlstring · uriOptionalExample: https://storage.pdfmunk.com/unlocked/file123.pdf

original_filenamestringOptionalExample: protected_document.pdf

output_filenamestringOptionalExample: protected_document.pdf

400

Bad request or incorrect password

application/json

post

/v1/unlockPdf

POST /api/v1/unlockPdf HTTP/1.1
Host: pdfmunk.com
CLIENT-API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 78

{
  "file": "binary",
  "password": "secret123",
  "output_name": "unlocked_document.pdf"
}

{
  "success": true,
  "message": "PDF unlocked successfully",
  "unlocked_pdf_url": "https://storage.pdfmunk.com/unlocked/file123.pdf",
  "original_filename": "protected_document.pdf",
  "output_filename": "protected_document.pdf"
}

Fetch HTML content from a URL

post

Fetches and returns the HTML content of a webpage with configurable wait conditions and viewport settings.

Authorizations

CLIENT-API-KEYstringRequired

API key for authentication. Get your key from https://pdfmunk.com/dashboard

Body

urlstring · uriRequired

URL to fetch HTML from

Example: https://example.com

wait_tillstring · enumOptional

When to consider navigation successful

Default: loadPossible values:

timeoutintegerOptional

Maximum wait time in milliseconds

Default: 30000Example: 60000

wait_for_selectorstringOptional

CSS selector to wait for before returning HTML

Example: #content

wait_for_timeoutintegerOptional

Additional wait time in milliseconds after page load

Default: 0Example: 2000

viewport_widthintegerOptional

Viewport width

Default: 1920Example: 1920

viewport_heightintegerOptional

Viewport height

Default: 1080Example: 1080

user_agentstringOptional

Custom user agent string

Example: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36

Responses

200

HTML fetched successfully

application/json

successbooleanOptionalExample: true

urlstring · uriOptionalExample: https://example.com

htmlstringOptional

The HTML content of the page

timestampintegerOptional

Unix timestamp when content was fetched

Example: 1702473600

400

Bad request

application/json

post

/v1/url-to-html

POST /api/v1/url-to-html HTTP/1.1
Host: pdfmunk.com
CLIENT-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 29

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

{
  "success": true,
  "url": "https://example.com",
  "html": "text",
  "timestamp": 1702473600
}

hashtagGenerate PDF from HTML or URL

hashtagGenerate image from HTML or URL

hashtagGenerate chart image using Chart.js

hashtagCompress an image

hashtagMerge multiple PDFs

hashtagSplit or extract pages from a PDF

hashtagUnlock a password-protected PDF

hashtagFetch HTML content from a URL

Generate PDF from HTML or URL

Generate image from HTML or URL

Generate chart image using Chart.js

Compress an image

Merge multiple PDFs

Split or extract pages from a PDF

Unlock a password-protected PDF

Fetch HTML content from a URL