API ReferenceBulk

List bulk job items

Returns the bulk job's items, discriminated by `type`. **Downloading item artifacts.** `image_url` (`type: screenshot`) and both `content_url` and `markdown_url` (`type: scrape`) are **pre-signed** URLs, minted fresh on every read of this endpoint and valid for **600 seconds (10 minutes)** — the same signing lifetime as `content_url` on `GET /v1/fetch/bulk/{id}`. The underlying objects are private, so an unsigned URL returns `401`: download inside that window, or re-poll this endpoint for a fresh signature. Items that are not `completed`, and completed items with no stored object, carry `null` or the unsigned stored URL instead.

GET
/v1/bulk/{id}/screenshots

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/bulk/{id}/screenshots \
  -H "Authorization: Bearer sk_live_your_api_key_here"

Successful response.

{
  "bulk_id": "bulk_01j9abc123",
  "total": 0,
  "items": [
    {
      "type": "screenshot",
      "id": "string",
      "status": "pending",
      "url": "http://example.com",
      "credits_charged": 0,
      "billing": {
        "raw_bytes": 1024,
        "factors": [
          {
            "name": "endpoint",
            "value": 1.5,
            "reason": "scrape_md"
          }
        ],
        "multiplier": 0.75,
        "billed_bytes": 768
      },
      "error_code": "string",
      "error_message": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "completed_at": "2019-08-24T14:15:22Z",
      "image_url": "string",
      "page_title": "string",
      "format": "string",
      "video_url": "string",
      "content_url": "string",
      "content_type": "string",
      "content_length": 0,
      "markdown": "string",
      "markdown_url": "string"
    }
  ]
}

DELETE /v1/bulk/{id}Cancel a bulk job

Cancels an in-flight bulk job: drains its still-queued (pending) child jobs and refunds the quota held for exactly those drained children. Children already completed, failed, or in progress are untouched and keep their charge. Idempotent — cancelling an already-terminal job (completed, failed, or cancelled) is a no-op that returns 200 with the job's real, unchanged status and refunds nothing.

Monitors

Monitors API — endpoints, requests, and responses.