API ReferenceScrape

Get scrape result

Always returns 200. Check the `status` discriminator for the scrape state.

GET
/v1/scrape/{id}

Authorization

AuthorizationRequiredBearer <token>

API key. Obtain from POST /v1/account/api-keys.

In: header

Path Parameters

idRequiredstring
Pattern: "^sc_"
curl -X GET "https://api.bytekit.com/v1/scrape/string" \
  -H "Authorization: Bearer <token>"

Scrape state (queued, success, or failed).

{
  "status": "success",
  "scrapeId": "sc_01j9abc123",
  "url": "https://example.com",
  "finalUrl": "https://example.com/",
  "contentType": "text/html; charset=UTF-8",
  "contentLength": 1256,
  "statusCode": 200,
  "retrievedAt": "2025-01-15T12:00:00Z",
  "formats": {
    "rawHtml": "<html><body><h1>Hello World</h1><p>Example page with a <a href=\"/about\">link</a> and an image.</p></body></html>",
    "html": "<html><body><h1>Hello World</h1><p>Example page with a <a href=\"/about\">link</a> and an image.</p></body></html>",
    "markdown": "# Hello World\n\nExample page with a [link](/about) and an image.\n\n![Alt text](https://example.com/photo.png)",
    "links": [
      {
        "url": "https://example.com/about",
        "text": "link",
        "isInternal": true,
        "rel": null
      }
    ],
    "images": [
      {
        "url": "https://example.com/photo.png",
        "alt": "Alt text",
        "width": 800,
        "height": 600,
        "format": "png",
        "score": 0.95
      }
    ]
  },
  "metadata": {
    "title": "Example Domain",
    "description": "An example page for demonstration",
    "language": "en",
    "canonicalUrl": "https://example.com",
    "ogTitle": "Example Domain",
    "ogDescription": null,
    "ogImage": null,
    "byline": "Jane Doe",
    "publishedAt": "2025-01-15T09:00:00Z"
  },
  "tables": [
    {
      "kind": "data",
      "gfm": "| Col1 | Col2 |\n|------|------|\n| A | B |",
      "rows": 2,
      "cols": 2
    }
  ],
  "warnings": [
    {
      "code": "lossy_table",
      "message": "Table at index 3 was simplified",
      "element": "<table>...</table>"
    }
  ],
  "stats": {
    "chars": 1256,
    "tokens": 312,
    "blocks": 4
  }
}

Scrape a URL

Fetches and processes a URL, returning content in one or more formats wrapped in a ScrapeEnvelope. Simple requests use the HTTP fast-path (~500ms); complex requests (delay_ms > 0, cookies, custom headers, wait conditions) are routed to headless Chromium and return HTTP 202 (3-15s). When `webhook_url` is provided and the scrape is async, webhook deliveries include `X-RapidCrawl-Event: scrape.completed` or `X-RapidCrawl-Event: scrape.failed` so receivers can dispatch on the header without parsing the body shape.

Bulk scrape URLs

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