API ReferenceBulk

List in-flight bulk jobs

Returns the caller's bulk jobs, most recent first. Optionally filter to a single status; when omitted, jobs of every status are returned.

GET
/v1/bulk

Authorization

AuthorizationRequiredBearer <token>

API key. Manage keys from the dashboard at app.bytekit.com.

In: header

Query Parameters

statusstring
Value in: "processing" | "completed" | "failed"
curl https://api.bytekit.com \
  -H "Authorization: Bearer sk_live_your_api_key_here"

Successful response.

[
  {
    "id": "bulk_01j9abc123",
    "status": "processing",
    "total": 0,
    "completed": 0,
    "failed": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "total_credits_charged": 0,
    "estimated_credits": 0,
    "webhook_url": "string"
  }
]

Bulk

Bulk API — endpoints, requests, and responses.

POST /v1/bulkCreate mixed bulk job

Enqueues screenshots or scrapes in a single batch. Provide `urls` (simple list) or `items` (per-item config), not both. Webhook deliveries include `X-ByteKit-Event: bulk.completed` so receivers can dispatch on the header without parsing the body shape. **Limits:** request bodies are guarded in a two-tier shape. A streamed body with no `Content-Length` header is capped at 4 MB before your API key is checked; a body that declares `Content-Length` is instead bounded there by a 32 MB fail-safe (not the real limit — see below), since that branch reads nothing until your key is verified. Once your key is verified, a second check re-gates the body against your account's own `max_bulk_size` (at this endpoint's richer per-item override budget), which reaches 28.7 MB for the largest documented account. A standard-plan account's effective ceiling is 4 MB; either tier's overrun returns a `400` with error code `request_too_large`.