API ReferenceScrape Bulk

Get scrape bulk job status

GET
/v1/scrape/bulk/{id}

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Path Parameters

idRequiredstring
Pattern: "^bulk_"
curl https://api.bytekit.com/v1/scrape/bulk/{id} \
  -H "Authorization: Bearer sk_live_your_api_key_here"

Bulk job status with rehydrated item envelopes. Each completed scrape result entry echoes its custom payload (resolved per entry as entry.custom ?? body.custom) at the same position it occupies in the /v1/scrape success envelope. The key is omitted when no custom was supplied for that entry.

{
  "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"
}

POST /v1/scrape/bulkBulk scrape URLs

Enqueues multiple URLs for scraping. Results delivered via webhook. Webhook deliveries include `X-ByteKit-Event: scrape.completed` or `X-ByteKit-Event: scrape.failed` so receivers can dispatch on the header without parsing the body shape.

Fetch

Fetch API — endpoints, requests, and responses.