CLI
Screenshots
Screenshot operations
Screenshot operations
screenshots › create
Capture a screenshot
| Option | Description |
|---|---|
--url <url> | URL to screenshot |
--full-page | Capture the full page (default: viewport only) |
--device <device> | Device profile: desktop, mobile |
--viewport <WxH> | Viewport size WIDTHxHEIGHT (e.g. 1280x720) |
--format <format> | Image format: jpeg, png |
--quality <n> | JPEG quality (1-100) |
--wait-until <event> | Wait condition: load, domcontentloaded, networkidle |
--clip <x,y,w,h> | Clip region X,Y,WIDTH,HEIGHT (e.g. 0,0,800,600) |
--block-ads | Block ads before capture (server default) |
--no-block-ads | Do not block ads |
--block-cookie-banners | Block cookie-consent banners before capture (server default) |
--no-block-cookie-banners | Do not block cookie-consent banners |
--scroll | Scroll the page before capture to trigger lazy content (server default) |
--no-scroll | Do not scroll the page before capture |
--wait-for-selector <sel> | Wait until this CSS selector is present before capture |
--delay-ms <n> | Post-load delay in milliseconds before capture |
--dark-mode | Emulate prefers-color-scheme: dark |
--device-scale-factor <n> | Device pixel ratio: 1, 2 |
--include-html | Include the rendered HTML alongside the screenshot |
--country <cc> | Two-letter country code to route the request through (e.g. us, de) |
--language <lang> | Accept-Language override (e.g. en-US) |
--headers <json> | Extra request headers as a JSON object, e.g. '{"X-A":"b"}' (omitted → none) |
--cookies <json> | Cookies as a JSON array of {name,value,domain}, e.g. '[{"name":"a","value":"b","domain":"example.com"}]' (omitted → none) |
--metadata <json> | Arbitrary metadata echoed on the screenshot envelope, as a JSON object, e.g. '{"run":"7"}' (omitted → none) |
--async | Queue the screenshot and return a job envelope immediately (no wait) |
-o, --output <file> | Download the captured image to this file path (use - for stdout). Not valid with --json. |
-h, --help | display help for command |
$ bytekit screenshots create --url <url> --full-page --device <device> --viewport <WxH> --format <format> --quality <n> --wait-until <event> --clip <x,y,w,h> --block-ads --no-block-ads --block-cookie-banners --no-block-cookie-banners --scroll --no-scroll --wait-for-selector <sel> --delay-ms <n> --dark-mode --device-scale-factor <n> --include-html --country <cc> --language <lang> --headers <json> --cookies <json> --metadata <json> --asyncscreenshots › get
Get a screenshot by ID
| Option | Description |
|---|---|
-o, --output <file> | Download the captured image to this file path (use - for stdout). Not valid with --json. |
-h, --help | display help for command |
$ bytekit screenshots get <id>