SDK ReferencePython SDK

Bulk

API functions for the Bulk resource.

Bulk

Functions for interacting with the bulk API resource. Each operation ships in four forms — sync / sync_detailed and their async counterparts.

Create Bulk

Create mixed bulk job

Enqueues screenshots, recordings, or scrapes in a single batch. Provide urls (simple list) or items (per-item config), not both.

Parameters

  • body (CreateBulkBody)

Call styles

sync_detailed(client, body) -> Response[CreateBulkResponse202]
sync(client, body) -> CreateBulkResponse202 | None
await asyncio_detailed(client, body) -> Response[CreateBulkResponse202]
await asyncio(client, body) -> CreateBulkResponse202 | None

Get Bulk

Get bulk job status

Parameters

  • id (str)

Call styles

sync_detailed(id, client) -> Response[Error | GetBulkResponse200]
sync(id, client) -> Error | GetBulkResponse200 | None
await asyncio_detailed(id, client) -> Response[Error | GetBulkResponse200]
await asyncio(id, client) -> Error | GetBulkResponse200 | None

List Bulk Screenshots

List bulk job items

Parameters

  • id (str)

Call styles

sync_detailed(id, client) -> Response[ListBulkScreenshotsResponse200]
sync(id, client) -> ListBulkScreenshotsResponse200 | None
await asyncio_detailed(id, client) -> Response[ListBulkScreenshotsResponse200]
await asyncio(id, client) -> ListBulkScreenshotsResponse200 | None