render
Render a web page to a PNG/JPEG screenshot or a PDF using a real headless browser. Returns the image inline (base64) or the PDF as an embedded resource. Results are cached for 24h.
Parameters8
| url | string | required | The absolute URL to render (must include https:// or http://). |
| format | string | optional | Output format. png/jpeg return an image; pdf returns a PDF document. |
| fullPage | boolean | optional | For screenshots: capture the entire scrollable page instead of just the viewport. |
| width | integer | optional | Viewport width in pixels. |
| height | integer | optional | Viewport height in pixels. |
| waitUntil | string | optional | Navigation completion signal before capturing. |
| pdfFormat | string | optional | Paper size, used only when format is pdf. |
| fresh | boolean | optional | Bypass the 24h cache and force a fresh render. |
Raw schema
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "The absolute URL to render (must include https:// or http://)."
},
"format": {
"default": "png",
"description": "Output format. png/jpeg return an image; pdf returns a PDF document.",
"type": "string",
"enum": [
"png",
"jpeg",
"pdf"
]
},
"fullPage": {
"default": false,
"description": "For screenshots: capture the entire scrollable page instead of just the viewport.",
"type": "boolean"
},
"width": {
"default": 1280,
"description": "Viewport width in pixels.",
"type": "integer",
"minimum": 64,
"maximum": 3840
},
"height": {
"default": 800,
"description": "Viewport height in pixels.",
"type": "integer",
"minimum": 64,
"maximum": 2160
},
"waitUntil": {
"default": "networkidle2",
"description": "Navigation completion signal before capturing.",
"type": "string",
"enum": [
"load",
"domcontentloaded",
"networkidle0",
"networkidle2"
]
},
"pdfFormat": {
"default": "A4",
"description": "Paper size, used only when format is pdf.",
"type": "string",
"enum": [
"A4",
"Letter",
"Legal",
"A3",
"Tabloid"
]
},
"fresh": {
"default": false,
"description": "Bypass the 24h cache and force a fresh render.",
"type": "boolean"
}
},
"required": [
"url"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}