Animation options

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

Options for the recorded formats: gif, mp4 and webm. Setting any of them with format=webp records an animated WebP instead of a still image. The page is recorded in real time for animation_duration seconds.

`animation_duration`

Seconds to record. With format=webp, records an animated WebP.

Type: number · Default: 3 · Range: 0.5–20

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","format":"mp4","animation_duration":5}' \
  --fail-with-body -o shot.mp4

`animation_fps`

Frames per second (default: 10 for gif/webp, 30 for video).

Type: number · Range: 1–30

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","format":"gif","animation_fps":15}' \
  --fail-with-body -o shot.gif

`animation_scroll`

Scroll smoothly from the current position to the bottom while recording.

Type: boolean · Default: false

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","format":"mp4","animation_scroll":true,"animation_duration":8}' \
  --fail-with-body -o shot.mp4