Menu
Docs/Default Parameters

Default Parameters

Set default values for your screenshot requests. Every API call inherits your defaults unless explicitly overridden.

How it works

  1. Configure defaults in Settings → Defaults
  2. Every screenshot request uses your defaults as a base
  3. Parameters you pass in the request override the defaults

For example, if your default format is webp and you send a request with format=jpeg, the result will be JPEG.

Available defaults

ParameterTypeOptions
formatenumpng, jpeg, webp
widthnumber320–3840
heightnumber240–2160
qualitynumber1–100
full_pagebooleanCapture full page height
dark_modebooleanEmulate dark color scheme
block_adsbooleanBlock ads and cookie banners
delaynumberMilliseconds to wait after load

Example

If you always screenshot at 1920×1080 in WebP format with dark mode:

Without defaults — you repeat parameters on every call:

curl "https://api.snapsharp.dev/v1/screenshot?url=https://example.com&width=1920&height=1080&format=webp&dark_mode=true" \
  -H "Authorization: Bearer sk_live_..."

With defaults — set them once, then just pass the URL:

curl "https://api.snapsharp.dev/v1/screenshot?url=https://example.com" \
  -H "Authorization: Bearer sk_live_..."

The result is the same — 1920×1080 WebP with dark mode.

Override behavior

Request parameters always take priority over defaults:

DefaultRequestResult
format: webp(not specified)webp
format: webpformat=pngpng
width: 1920width=12801280
dark_mode: truedark_mode=falsefalse

Defaults apply only to the Screenshot API (/v1/screenshot). OG Image and HTML-to-Image endpoints are not affected.