@hunt-labs/bytekit-sdk 0.11.13 → 0.11.14

package/CHANGELOG.md

@@ -10,6 +10,24 @@ today, see [README.md](./README.md), which remains the authoritative usage guide
 
 ## [Unreleased]
 
+## [0.11.14] - 2026-10-27
+
+### Added
+
+- **`'outline'` is now a `scrape` format (#5473).** `formats: ['outline']` on `scrape.create` (and the
+  bulk entry points) returns `formats.outline`, an indented text accessibility tree of the
+  browser-rendered page with no element IDs. Experimental; it forces the browser path and adds no
+  credits. Regenerated `src/generated/api.d.ts`.
+
+### Changed
+
+- **`solve_challenge` is documented as a held browser render that can return the 202 receipt
+  (#5541).** Since #5532 a synchronous `scrape.create` with `solve_challenge: true` is routed to the
+  browser render and held up to the hold window (28 s by default); a solve that outlasts it resolves
+  to the `queued` receipt. The `ScrapeCreateResponse` and `solve_challenge` JSDoc and the regenerated
+  `src/generated/api.d.ts` say so, and the routing triggers now list `solve_challenge` and `outline`
+  next to `delay_ms`. Description text only; no SDK method signature moves.
+
 ## [0.11.13] - 2026-10-21
 
 ### Changed

package/dist/generated/api.d.ts

@@ -201,7 +201,7 @@ export interface paths {
          *     **The response shape is decided by your request, not by how we route it.** In precedence order:
          *
          *     1. `async: true` in the body, or `?async=true` in the query string (either one is enough; `false` in one never cancels `true` in the other) → **202** with a `ScrapeQueuedEnvelope` receipt, returned immediately. Poll `GET /v1/scrape/{id}` for the result.
-         *     2. Otherwise, a request that needs a full page render — today that is `delay_ms > 0` — is **held open** until the render reaches a terminal state, then returns **200** with the content envelope (`success` or `failed`). If the render is still running when the hold window expires (28 seconds by default), the request returns the **202** receipt instead and the job continues in the background.
+         *     2. Otherwise, a request that needs a full page render — today that is any of `delay_ms > 0`, `solve_challenge: true`, or `outline` in `formats` — is **held open** until the render reaches a terminal state, then returns **200** with the content envelope (`success` or `failed`). If the render is still running when the hold window expires (28 seconds by default), the request returns the **202** receipt instead and the job continues in the background. A `solve_challenge` render can outlast the hold window, so expect the 202 receipt from such a request.
          *     3. Otherwise the request is served by the fast HTTP path and returns **200** with the content envelope, typically in under a second.
          *
          *     **A failed fetch is a result, not a transport error.** An unreachable host, a refused connection, or a target whose bot protection defeats every proxy tier all come back on the same **200** as a `failed` envelope — never a 5xx. Narrow on the envelope's `status` before reading the body. A failure the fast path decides inline is recorded as a failed job, so its envelope normally carries that job's `id` and `GET /v1/scrape/{id}` returns the same envelope; if recording the failed job itself fails, the envelope still arrives on the same 200 with `id` set to `null` and there is nothing to poll. A failure a held render reaches carries that render's real `id`. Either way the request transfers no billable bytes and is charged nothing.
@@ -1859,7 +1859,7 @@ export interface components {
              */
             mobile: boolean;
             /**
-             * @description Attempts to clear a Cloudflare challenge; success is not guaranteed. Billed as a normal browser render.
+             * @description Attempts to clear a Cloudflare challenge; success is not guaranteed. Billed as a normal browser render. On a synchronous `POST /v1/scrape` this routes the request to the held browser render; a solve can outlast the hold window (28 seconds by default), and the request then returns the 202 receipt while the job continues in the background. With `async: true` the 202 receipt is returned immediately.
              * @default false
              */
             solve_challenge: boolean;
@@ -1905,7 +1905,7 @@ export interface components {
          * @description A string entry of `ScrapeRequest.formats`.
          * @enum {string}
          */
-        ScrapeRequestFormatsItem: "raw" | "markdown" | "links" | "images";
+        ScrapeRequestFormatsItem: "raw" | "markdown" | "links" | "images" | "outline";
         /**
          * @description The `json` entry of `ScrapeRequest.formats`: structured extraction over the scraped
          *     page, using the same extractor as `POST /v1/schema`.
@@ -2017,6 +2017,14 @@ export interface components {
                 /** @description The extraction model that ran. */
                 model: string;
             };
+            /**
+             * @description Experimental. An indented text accessibility tree of the browser-rendered page, one
+             *     `- role: name = value` line per node, with no element IDs. Requesting `outline`
+             *     forces the slow (browser) path and adds no credits. Omitted, with an
+             *     `artifact_unavailable` warning, when the page cannot be rendered or captured. Not
+             *     accepted on `/v1/monitors`.
+             */
+            outline?: string;
         };
         ScrapeMetadata: {
             title: string | null;
@@ -2204,7 +2212,7 @@ export interface components {
                 code: "validation_error" | "invalid_url" | "request_too_large" | "payload_too_large" | "unsupported_content_type" | "rate_limited" | "upstream_error" | "blocked" | "target_rate_limited" | "timeout" | "internal_error";
                 message: string;
                 http_status?: number;
-                /** @description Whole seconds the target site asked us to wait before the next request. Present only with `code: target_rate_limited`, only on the inline `POST /v1/scrape` failure the fast path decides, and only when the target sent a usable `Retry-After` (delta-seconds, or an HTTP-date still in the future, converted to seconds; values above 2147483647 are reported as 2147483647). Informational: ByteKit never enforces it on your next request. A held render (`delay_ms > 0`), `GET /v1/scrape/{id}` and webhooks omit it, because the value is relative to the moment the target answered. */
+                /** @description Whole seconds the target site asked us to wait before the next request. Present only with `code: target_rate_limited`, only on the inline `POST /v1/scrape` failure the fast path decides, and only when the target sent a usable `Retry-After` (delta-seconds, or an HTTP-date still in the future, converted to seconds; values above 2147483647 are reported as 2147483647). Informational: ByteKit never enforces it on your next request. A held render (`delay_ms > 0`, `solve_challenge: true`, or `outline` in `formats`), `GET /v1/scrape/{id}` and webhooks omit it, because the value is relative to the moment the target answered. */
                 retry_after_seconds?: number;
                 /** Format: date-time */
                 failed_at: string;
@@ -4208,7 +4216,7 @@ export interface operations {
                     items?: {
                         /** Format: uri */
                         url: string;
-                        formats?: (("raw" | "markdown" | "links" | "images") | components["schemas"]["ScrapeRequestJsonFormat"])[];
+                        formats?: (("raw" | "markdown" | "links" | "images" | "outline") | components["schemas"]["ScrapeRequestJsonFormat"])[];
                         country?: string;
                         delay_ms?: number;
                         timeout_ms?: number;
@@ -4241,7 +4249,7 @@ export interface operations {
                          *       "raw"
                          *     ]
                          */
-                        formats?: (("raw" | "markdown" | "links" | "images") | components["schemas"]["ScrapeRequestJsonFormat"])[];
+                        formats?: (("raw" | "markdown" | "links" | "images" | "outline") | components["schemas"]["ScrapeRequestJsonFormat"])[];
                         /** @default US */
                         country?: string;
                         /** @default 0 */
@@ -5289,7 +5297,7 @@ export interface operations {
                         language?: string | null;
                         dark_mode?: boolean;
                         /** @description Scrape output formats (scrape entries). */
-                        formats?: (("raw" | "markdown" | "links" | "images") | components["schemas"]["ScrapeRequestJsonFormat"])[];
+                        formats?: (("raw" | "markdown" | "links" | "images" | "outline") | components["schemas"]["ScrapeRequestJsonFormat"])[];
                         /** @enum {string} */
                         wait_until?: "load" | "domcontentloaded" | "networkidle";
                         wait_for_selector?: string | null;
@@ -5342,7 +5350,7 @@ export interface operations {
                         language?: string | null;
                         /** @default false */
                         dark_mode?: boolean;
-                        formats?: (("raw" | "markdown" | "links" | "images") | components["schemas"]["ScrapeRequestJsonFormat"])[];
+                        formats?: (("raw" | "markdown" | "links" | "images" | "outline") | components["schemas"]["ScrapeRequestJsonFormat"])[];
                         /**
                          * @default load
                          * @enum {string}

package/dist/resources/scrape.d.ts

@@ -13,8 +13,8 @@ import type { ScrapeId, BulkId } from '../types.js';
  * The shape follows from the request, in this order:
  *
  * 1. `async: true` → 202 receipt, immediately. Poll `scrape.get(id)`.
- * 2. Otherwise a request that needs a full page render — today that is
- *    `delay_ms > 0` — is held open until the render reaches a terminal state
+ * 2. Otherwise a request that needs a full page render — today that is any of
+ *    `delay_ms > 0`, `solve_challenge: true`, or `outline` in `formats` — is held open until the render reaches a terminal state
  *    and returns 200 with that state: the content envelope on success, or the
  *    `failed` error envelope when the render itself failed. If the render is
  *    still running when the server's hold window expires (28 s by default), it
@@ -54,7 +54,7 @@ export type ScrapeJsonFormat = components['schemas']['ScrapeRequestJsonFormat'];
 export interface ScrapeOpts {
     url: string;
     /** String formats, plus at most one `{ type: 'json', schema }` entry for structured extraction (the entry's result is `formats.json`). */
-    formats?: Array<'raw' | 'markdown' | 'links' | 'images' | ScrapeJsonFormat>;
+    formats?: Array<'raw' | 'markdown' | 'links' | 'images' | 'outline' | ScrapeJsonFormat>;
     country?: string;
     delay_ms?: number;
     /** SERVER-side scrape budget in ms — how long the server may spend on the scrape itself. For the CLIENT-side abort budget (when this SDK gives up on the wire), see `RequestOptions.requestTimeoutMs`. */
@@ -88,7 +88,7 @@ export interface ScrapeOpts {
     token_budget?: number;
     /** Tokenizer encoding hint for `token_budget`. `cl100k_base` (default) matches GPT-4/4o; `o200k_base` matches GPT-4o-mini / o-series. */
     token_encoding?: TokenEncoding;
-    /** Attempts to clear a Cloudflare challenge; success is not guaranteed. Billed as a normal browser render. */
+    /** Attempts to clear a Cloudflare challenge; success is not guaranteed. Billed as a normal browser render. On a synchronous scrape this routes the request to the held browser render; a solve can outlast the hold window (28 seconds by default), and the request then returns the 202 receipt while the job continues in the background. With `async: true` the 202 receipt is returned immediately. */
     solve_challenge?: boolean;
     /** When true, emulate a mobile device (mobile UA + viewport). Default false (desktop). Part of the cache key, so mobile and desktop responses cache independently. */
     mobile?: boolean;

package/dist/version.d.ts

@@ -5,4 +5,4 @@
  * outbound request carries — see the emit site in `client.ts`. The header name is spelled
  * only there, so issue #2905's pre-merge gate 1 counts exactly one occurrence in `src/`.
  */
-export declare const SDK_VERSION = "0.11.13";
+export declare const SDK_VERSION = "0.11.14";

package/dist/version.js

@@ -9,4 +9,4 @@
  * outbound request carries — see the emit site in `client.ts`. The header name is spelled
  * only there, so issue #2905's pre-merge gate 1 counts exactly one occurrence in `src/`.
  */
-export const SDK_VERSION = '0.11.13';
+export const SDK_VERSION = '0.11.14';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hunt-labs/bytekit-sdk",
-  "version": "0.11.13",
+  "version": "0.11.14",
   "description": "Official TypeScript SDK for the ByteKit API",
   "license": "MIT",
   "type": "module",