Skip to main content
POST
Capture a full-page Url2Pdf of a website

Authorizations

x-api-key
string
header
required

API Key required for all endpoints

Body

application/json
url
string
required

Target URL

Example:

"https://example.com"

device
enum<string>
default:desktop

Device type to emulate. Defaults to desktop.

Available options:
desktop,
mobile
Example:

"desktop"

proxyCountry
string

Proxy country code to route the request

Example:

"us"

format
enum<string>
default:a4

Paper format

Available options:
letter,
legal,
a0,
a1,
a2,
a3,
a4,
a5,
a6
Example:

"a4"

orientation
enum<string>
default:portrait

Orientation

Available options:
portrait,
landscape
Example:

"portrait"

margin
object

Margins in mm

scale
number
default:1

Rendering scale between 0–2

Example:

1.5

Hide cookie popups

Example:

false

skipCaptcha
boolean
default:false

Try to skip captcha

Example:

false

addTimestamp
boolean
default:false

Add timestamp watermark

Example:

false

Response

Successfully captured Url2Pdf

timestamp
number
required

Timestamp of the request in milliseconds

Example:

1783943217189

apiStatus
enum<string>
required

API status message

Available options:
success,
failure
Example:

"success"

apiCode
number
required

API status code

Example:

200

meta
object
required

Metadata about the request

data
string
required

Generated PDF URL

Example:

"https://api-assets.example.com/tests/pdf/o5jiqf08bmp93jsll7vb24vs.pdf"