Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-132176113.0 KB
url2pdf

Capture a full-page Url2Pdf of a website

post/url2pdf

Request body

urlstring required

Target URL

device'desktop' | 'mobile'

Device type to emulate. Defaults to desktop.

proxyCountrystring

Proxy country code to route the request

format'letter' | 'legal' | 'a0' | 'a1' | 'a2' | 'a3' | 'a4' | 'a5' | 'a6'

Paper format

orientation'portrait' | 'landscape'

Orientation

scalenumber

Rendering scale between 0–2

hideCookieboolean

Hide cookie popups

skipCaptchaboolean

Try to skip captcha

addTimestampboolean

Add timestamp watermark

Example request

{
  "url": "https://example.com",
  "device": "desktop",
  "proxyCountry": "us",
  "format": "a4",
  "orientation": "portrait",
  "margin": {
    "top": 25.4,
    "bottom": 25.4,
    "right": 25.4,
    "left": 25.4
  },
  "scale": 1.5
}

Response

Successfully captured Url2Pdf

timestampnumber required

Timestamp of the request in milliseconds

apiStatus'success' | 'failure' required

API status message

apiCodenumber required

API status code

datastring required

Generated PDF URL

Example response

{
  "timestamp": 1763372588297,
  "apiStatus": "success",
  "apiCode": 200,
  "meta": {
    "url": "https://example.com",
    "device": "desktop",
    "format": "letter",
    "orientation": "landscape",
    "margin": {
      "top": 25.4,
      "bottom": 25.4,
      "right": 25.4,
      "left": 25.4
    },
    "scale": 1.5,
    "test": {
      "id": "mxqx9v9y0742lap6altwdteqd28t23nq"
    }
  },
  "data": "https://api-assets.example.com/tests/pdf/o5jiqf08bmp93jsll7vb24vs.pdf"
}