SDK ReferenceTypeScript SDK

Scrape Bulk

Create and poll bulk scrape jobs.

For AI agents: https://bytekit.com/llms.txt — every docs page is available as markdown by appending .md

Scrape Bulk

Create and poll bulk scrape jobs. Accessed via client.scrape.bulk.

create

client.scrape.bulk.create(opts: ScrapeBulkCreateRequest, requestOptions?: RequestOptions): Promise<ScrapeBulkCreateResponse>

POST /v1/scrape/bulk — create a bulk scrape job.

requestOptions carries the CLIENT-side abort budget (requestTimeoutMs) and an optional caller signal; both override the constructor's timeoutMs default.

get

client.scrape.bulk.get(id: BulkId, requestOptions?: RequestOptions): Promise<ScrapeBulkGetResponse>

GET /v1/scrape/bulk/{id} — get a bulk scrape job

get

client.scrape.bulk.get(id: BulkId, pageParams: ScrapeBulkPageParams, requestOptions?: RequestOptions): Promise<ScrapeBulkGetResponse>

get

client.scrape.bulk.get(id: BulkId, pageParamsOrRequestOptions: ScrapeBulkPageParams | RequestOptions = {}, requestOptions?: RequestOptions): Promise<ScrapeBulkGetResponse>