Clip options

Reference for the clip options of the shotkit screenshot API, with an example request for each.

Capture a rectangle of the page, in CSS pixels from the top-left of the document. Set clip_width and clip_height; clip_x and clip_y default to 0. A selector takes precedence.

`clip_x`

Clip area X.

Type: number · Min: 0

curl -X POST "https://shotkit.net/api/take" \
  -H "X-Access-Key: YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","clip_x":100,"clip_y":200,"clip_width":600,"clip_height":400}' \
  --fail-with-body -o shot.jpg

`clip_y`

Clip area Y.

Type: number · Min: 0

curl -X POST "https://shotkit.net/api/take" \
  -H "X-Access-Key: YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","clip_x":100,"clip_y":200,"clip_width":600,"clip_height":400}' \
  --fail-with-body -o shot.jpg

`clip_width`

Clip area width.

Type: number · Min: 1

curl -X POST "https://shotkit.net/api/take" \
  -H "X-Access-Key: YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","clip_width":600,"clip_height":400}' \
  --fail-with-body -o shot.jpg

`clip_height`

Clip area height.

Type: number · Min: 1

curl -X POST "https://shotkit.net/api/take" \
  -H "X-Access-Key: YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","clip_width":600,"clip_height":400}' \
  --fail-with-body -o shot.jpg