> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scrnshot.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Screenshot options

> Every parameter accepted by POST /v1/screenshots, its default, and which plans can use it

All options are passed as JSON in the body of `POST /v1/screenshots`. Only
`url` is required.

## `url`

|              |                     |
| ------------ | ------------------- |
| Type         | `string` (required) |
| Default      | —                   |
| Availability | All plans           |

The page to capture. Must be a valid, publicly reachable URL.

## `format`

|              |                                                  |
| ------------ | ------------------------------------------------ |
| Type         | `"png" \| "jpeg" \| "webp"`                      |
| Default      | `png`                                            |
| Availability | `png`, `jpeg` — Free and Pro. `webp` — Pro only. |

Requesting `webp` on the Free plan returns `400`.

## `width` / `height`

|              |                                               |
| ------------ | --------------------------------------------- |
| Type         | `integer` (pixels)                            |
| Default      | `1920` × `1080`, capped to the plan's maximum |
| Availability | Free: up to 1920×1080. Pro: up to 3840×2160.  |

Values above your plan's ceiling return `400` rather than being silently
clamped — set them explicitly only when you need something other than the
default.

## `full_page`

|              |                                                    |
| ------------ | -------------------------------------------------- |
| Type         | `boolean`                                          |
| Default      | `false`                                            |
| Availability | Free and Pro. Not available on the anonymous demo. |

Captures the entire scrollable page instead of just the viewport defined by
`width`/`height`.

## `quality`

|              |                      |
| ------------ | -------------------- |
| Type         | `integer`, `1`–`100` |
| Default      | `80`                 |
| Availability | All plans            |

Compression quality, used for `jpeg` and `webp` output. Ignored for `png`.

## `fresh`

|              |                                                          |
| ------------ | -------------------------------------------------------- |
| Type         | `boolean`                                                |
| Default      | `false`                                                  |
| Availability | Pro only. Free plans requesting `fresh: true` get `400`. |

Bypasses the result cache and forces a new render. See
[Caching & fresh](/guides/caching-and-fresh) for when you'd want this.

## What's not exposed yet

Device scale factor (rendering at a higher pixel density, e.g. for retina
screenshots) is part of the Pro plan's feature set but isn't yet an
accepted request parameter — every capture currently renders at a fixed
scale server-side. If you need this, mention it when you sign up; it's on
the near-term roadmap.
