Docs

POST /v1/images

Use POST /v1/images when you need a png, jpeg, or webp screenshot of HTML or a public URL — not a PDF. Same Chromium engine as POST /v1/pdf. Failed screenshots are not billed.

Provide exactly one of html or url. Same Chromium engine as POST /v1/pdf. Failed screenshots are not billed.

Body fields

One source plus optional image options.

Field	Required	Description
html / url	exactly one	Source
filename	no	Must match type (.png, .jpg/.jpeg, .webp)
response	no	binary (default), url, or async
options.type	no	png (default), jpeg, or webp
options.fullPage	no	Default false
options.omitBackground	no	Default false
options.quality	no	1–100 for jpeg/webp
options.viewport	no	width, height, optional deviceScaleFactor
options.clip	no	x, y, width, height
options.waitUntil / timeout	no	Same as PDF

Example

Full-page PNG of a public URL.

POST /v1/images

{
  "url": "https://example.com",
  "options": {
    "type": "png",
    "fullPage": true
  }
}

Docs hub →Node.js SDK →Playground →