SDK ReferenceTypeScript SDK
Bulk
Fan out many URLs in parallel with per-item webhooks.
Bulk
Fan out many URLs in parallel with per-item webhooks. Accessed via client.bulk.
create
client.bulk.create(opts: BulkCreateRequest, requestOptions?: RequestOptions): Promise<BulkCreateResponse>POST /v1/bulk — create a bulk screenshots job.
requestOptions carries the CLIENT-side abort budget (requestTimeoutMs) and an
optional caller signal; both override the constructor's timeoutMs default.
get
client.bulk.get(id: BulkId, requestOptions?: RequestOptions): Promise<BulkGetResponse>GET /v1/bulk/{id} — get a bulk job status
cancel
client.bulk.cancel(id: BulkId, requestOptions?: RequestOptions): Promise<BulkCancelResponse>DELETE /v1/bulk/{id} — cancel an in-flight bulk job
screenshots
list
client.bulk.screenshots.list(id: BulkId, requestOptions?: RequestOptions): Promise<ListBulkScreenshotsResponse>GET /v1/bulk/{id}/screenshots — list screenshots in a bulk job