API Reference

Record Scrolling Video

post
https://api.screenshotapi.com/record

Take a video of the page scrolling

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The URL of the page to capture. Prefix with https:// is optional.

string

Raw HTML to render instead of loading a URL.

string
enum
Defaults to json

Response format: 'json' returns metadata + base64, 'redirect' returns the image directly.

Allowed:
boolean
Defaults to true

Block popup dialogs on the page.

boolean
Defaults to true

Automatically dismiss cookie consent banners.

string
enum
Defaults to load

Navigation event to wait for: 'load', 'domcontentloaded', 'networkidle0', or 'networkidle2'.

Allowed:
string

CSS selector to wait for before capturing.

string

Emulate a specific device viewport. For example 'ipad_gen_6' (see Device List page).

int32
Defaults to 1280

Viewport width in pixels.

int32
Defaults to 720

Viewport height in pixels.

number
1 to 5

Device pixel ratio (1-5).

string

Markdown content to render instead of loading a URL.

int32
0 to 20000

Wait this many milliseconds after page load before capturing.

string
enum
Defaults to hide

Control text cursor visibility: 'hide' or 'initial'.

Allowed:
int32

X coordinate of the clip region (pixels from left).

int32

Y coordinate of the clip region (pixels from top).

int32

Width of the clip region in pixels.

int32

Height of the clip region in pixels.

boolean
Defaults to false

Capture the entire scrollable page instead of just the viewport.

boolean
Defaults to false

Scroll the page before capturing to trigger lazy-loaded content.

boolean
Defaults to false

Make the background transparent (PNG only).

string
enum
Defaults to device

Rendering scale: 'css' for 1x, 'device' for device pixel ratio.

Allowed:
string

Custom CSS to inject into the page before capture.

number

Maximum time in milliseconds to wait for the page to load.

string
enum
Defaults to jpeg

Image format for the screenshot.

Allowed:
int32
0 to 100
Defaults to 100

JPEG quality (0-100). Only applies when type is 'jpeg'.

string
enum
Defaults to mp4

Video output format.

Allowed:
number
1 to 20
Defaults to 5

Recording duration in seconds (1-20).

int32

Video output width in pixels.

int32

Video output height in pixels.

string
enum
Defaults to 4:3

Video aspect ratio.

Allowed:
string
enum
Defaults to default

Recording scenario: 'default' for static, 'scroll' for auto-scroll.

Allowed:
number
≥ 100
Defaults to 1500

Duration of each scroll animation in milliseconds.

number
≥ 0
Defaults to 500

Delay before starting scroll in milliseconds.

number
≥ 1
Defaults to 1000

Number of pixels to scroll per step.

boolean
Defaults to true

Start scrolling immediately without waiting.

number
≥ 0
Defaults to 0

Delay before the first scroll in milliseconds.

boolean
Defaults to true

Scroll all the way to the bottom of the page.

int32

Scroll back to top after this many milliseconds.

boolean
Defaults to true

Scroll back to the top after reaching the bottom.

string
enum
Defaults to once

How to scroll back: 'once' for a single scroll, 'repeat' for step-by-step.

Allowed:
int32

Stop scrolling after this many milliseconds.

boolean
Defaults to false

Attempt to navigate to a link during recording.

int32

Navigate to a link after this many milliseconds.

string

URL to navigate to during recording.

scrollNavigateLinkHints
array of strings
Defaults to []

Link text hints to look for when auto-navigating.

scrollNavigateLinkHints
string
enum
Defaults to ease_in_out_quint

Easing function for scroll animation.

Responses
200

Successful response

400

Bad request - invalid parameters

401

Unauthorized - invalid or missing API key

Updated 4 months ago

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 4 months ago