CLI
Bulk
Bulk screenshot operations
For AI agents: https://bytekit.com/llms.txt — every docs page is available as markdown by appending .md
Bulk screenshot operations
bulk › screenshots
Bulk screenshot sub-resources
| Option | Description |
|---|---|
-h, --help | display help for command |
bulk › screenshots › list
List items in a mixed bulk job
| Option | Description |
|---|---|
--cursor <cursor> | Continue from a cursor returned by the preceding page |
--limit <n> | Maximum items per type to return (1-500) |
--status <status> | Filter items by status: pending, processing, completed, failed, cancelled |
-h, --help | display help for command |
$ bytekit bulk screenshots list <id> --cursor <cursor> --limit <n> --status <status>bulk › create
Create a bulk screenshots job
| Option | Description |
|---|---|
--file <path> | Path to a newline-delimited file. Each line is a plain URL, or a JSON object carrying "url" plus per-item config. A line whose only key is "url" behaves exactly as before (sent as a bare URL string); any line with additional keys switches the payload to the per-item shape. |
--webhook-url <url> | HTTPS webhook URL notified when the job completes |
--webhook-secret <secret> | HMAC secret used to sign the completion webhook (omitted → unsigned) |
--defaults <json> | Defaults applied to every entry, as a JSON object (omitted → none). Unknown keys are rejected by /v1/bulk (422) and ignored by scrape bulk / fetch bulk; fetch bulk additionally rejects browser-only keys (cookies, wait_until, wait_for_selector, delay_ms) with a 400. |
--metadata <json> | Arbitrary metadata echoed on the job envelope, as a JSON object, e.g. '{"run":"7"}' (omitted → none) |
-h, --help | display help for command |
$ bytekit bulk create --file <path> --webhook-url <url> --webhook-secret <secret> --defaults <json> --metadata <json>bulk › get
Get a bulk job status
| Option | Description |
|---|---|
-h, --help | display help for command |
$ bytekit bulk get <id>bulk › cancel
Cancel an in-flight bulk job
| Option | Description |
|---|---|
-h, --help | display help for command |
$ bytekit bulk cancel <id>