@hyperbrowser/sdk 1.2.1 → 1.2.2

package/README.md

@@ -50,6 +50,45 @@ status and truncation metadata before using output. Public types, including
 See the [WebMCP guide](https://hyperbrowser.ai/docs/sessions/webmcp) for complete
 examples, cancellation behavior, human submission, and limits.
 
+## Web Bot Auth
+
+A session can sign its requests with Web Bot Auth so websites can verify that they
+come from Hyperbrowser. Web Bot Auth is enabled for teams on request.
+
+```typescript
+const session = await client.sessions.create({ webBotAuth: true });
+console.log(session.launchState?.webBotAuth?.signatureAgent); // "https://www.hyperbrowser.ai"
+
+// Sign only requests to these hosts and their subdomains:
+await client.sessions.create({ webBotAuth: { onlyDomains: ["example.com"] } });
+```
+
+Agent tasks accept `webBotAuth` in `sessionOptions`; scrape, crawl, and extract
+jobs do not. It cannot be combined with `useUltraStealth` or `startFromSnapshot`.
+See the [Web Bot Auth guide](https://hyperbrowser.ai/docs/sessions/web-bot-auth).
+
+## Proxy routes
+
+`proxyRoutes` sends some hosts' traffic straight out instead of through the
+session's proxy, or the other way round. The first route that matches a host
+decides; hosts that no route matches use the proxy. Proxy routes require
+`useProxy` and are enabled for teams on request.
+
+```typescript
+const session = await client.sessions.create({
+  useProxy: true,
+  proxyRoutes: [
+    { match: "api.example.com", proxy: "default" }, // stays on the proxy
+    { match: ["*.example.com", "cdn.example.net"], proxy: "direct" },
+  ],
+});
+```
+
+A pattern is a hostname, `*.example.com` (its subdomains, not `example.com` itself),
+or `*` (every host). Proxy routes only apply to `sessions.create` and cannot be
+combined with `allowInternetAccess: false`, `allowOut`, or `denyOut`. See the
+[proxy routes guide](https://hyperbrowser.ai/docs/sessions/proxy-routes).
+
 ## Usage
 
 ### Playwright

package/dist/types/agents/gemini-computer-use.d.ts

@@ -1,4 +1,4 @@
-import { GeminiComputerUseLlm, GeminiComputerUseTaskStatus } from "../constants";
+import { GeminiComputerUseLlm, GeminiComputerUseReasoningEffort, GeminiComputerUseTaskStatus } from "../constants";
 import { CreateSessionParams } from "../session";
 export interface GeminiComputerUseApiKeys {
     google?: string;
@@ -6,6 +6,7 @@ export interface GeminiComputerUseApiKeys {
 export interface StartGeminiComputerUseTaskParams {
     task: string;
     llm?: GeminiComputerUseLlm;
+    reasoningEffort?: GeminiComputerUseReasoningEffort;
     sessionId?: string;
     maxFailures?: number;
     maxSteps?: number;

package/dist/types/constants.d.ts

@@ -26,7 +26,8 @@ export type CuaLlm = "computer-use-preview" | "gpt-6-astra" | "gpt-6.1-sol" | "g
 export type CuaReasoningEffort = "none" | "low" | "medium" | "high" | "xhigh" | "max";
 export type HyperAgentVersion = "0.8.0" | "1.1.0";
 export type HyperAgentLlm = "gpt-5.6-luna" | "gpt-5.5" | "gpt-5.2" | "gpt-5.1" | "gpt-5" | "gpt-5-mini" | "gpt-4o" | "gpt-4o-mini" | "gpt-4.1" | "gpt-4.1-mini" | "gpt-4.1-nano" | "claude-sonnet-5" | "claude-sonnet-4-5" | "claude-sonnet-4-6" | "claude-haiku-5-5" | "gemini-2.5-flash" | "gemini-3.8-flash" | "gemini-3.7-flash" | "gemini-3-flash-preview";
-export type GeminiComputerUseLlm = "gemini-3.8-flash" | "gemini-3.7-flash" | "gemini-3.6-flash" | "gemini-3.5-flash" | "gemini-3.5-flash-lite" | "gemini-3-flash-preview" | "gemini-2.5-computer-use-preview-10-2025";
+export type GeminiComputerUseLlm = "gemini-4-argon" | "gemini-3.8-flash" | "gemini-3.7-flash" | "gemini-3.6-flash" | "gemini-3.5-flash" | "gemini-3.5-flash-lite" | "gemini-3-flash-preview" | "gemini-2.5-computer-use-preview-10-2025";
+export type GeminiComputerUseReasoningEffort = "minimal" | "low" | "medium" | "high";
 export type GrokComputerUseLlm = "grok-4.7" | "grok-4.6" | "grok-4.5";
 export type GrokReasoningEffort = "low" | "medium" | "high";
 export type MetaComputerUseLlm = "muse-spark-1.1" | "muse-spark-1.2" | "muse-spark-1.3" | "muse-wonder-1.0";

package/dist/types/index.d.ts

@@ -11,13 +11,13 @@ export { StartGeminiComputerUseTaskParams, StartGeminiComputerUseTaskResponse, G
 export { StartGrokComputerUseTaskParams, StartGrokComputerUseTaskResponse, GrokComputerUseTaskStatusResponse, GrokComputerUseTaskResponse, GrokComputerUseTaskData, GrokComputerUseStepResponse, GrokComputerUseApiKeys, GrokComputerUseTaskMetadata, } from "./agents/grok-computer-use";
 export { StartMetaComputerUseTaskParams, StartMetaComputerUseTaskResponse, MetaComputerUseTaskStatusResponse, MetaComputerUseTaskResponse, MetaComputerUseTaskData, MetaComputerUseStepResponse, MetaComputerUseStepError, MetaComputerUseStepIncompleteDetails, MetaComputerUseStepReasoning, MetaComputerUseApiKeys, MetaComputerUseTaskMetadata, } from "./agents/meta-computer-use";
 export { StartJevComputerUseTaskParams, StartJevComputerUseTaskResponse, JevComputerUseTaskStatusResponse, JevComputerUseTaskResponse, JevComputerUseTaskData, JevComputerUseStepResponse, JevComputerUseApiKeys, JevComputerUseTaskMetadata, } from "./agents/jev-computer-use";
-export { BasicResponse, BrowserMemorySize, SessionStatus, Session, SessionDetail, SessionGetParams, SessionListParams, SessionListResponse, ScreenConfig, CaptchaEvaluationPageResult, CaptchaEvaluationParams, CaptchaEvaluationResponse, CaptchaEvaluationTarget, CaptchaEvaluationType, CaptchaSolverType, CreateSessionParams, CreateSessionSnapshotResponse, GetSessionDownloadsUrlResponse, GetSessionVideoRecordingUrlResponse, GetSessionRecordingUrlResponse, ImageCaptchaParam, UploadFileResponse, UploadFileOptions, GetActiveSessionsCountResponse, SessionEventLogListParams, SessionEventLogListResponse, SessionEventLog, SessionProfile, SessionLaunchState, SessionCreditBreakdown, StartSessionFromSnapshotParams, UpdateSessionProfileParams, UpdateSessionProxyLocationParams, UpdateSessionProxyParams, UpdateSessionScreenParams, UpdateSessionSolveCaptchasParams, UpdateSessionSolveCaptchasResponse, } from "./session";
+export { BasicResponse, BrowserMemorySize, SessionStatus, Session, SessionDetail, SessionGetParams, SessionListParams, SessionListResponse, ScreenConfig, CaptchaEvaluationPageResult, CaptchaEvaluationParams, CaptchaEvaluationResponse, CaptchaEvaluationTarget, CaptchaEvaluationType, CaptchaSolverType, CreateSessionParams, CreateSessionSnapshotResponse, GetSessionDownloadsUrlResponse, GetSessionVideoRecordingUrlResponse, GetSessionRecordingUrlResponse, ImageCaptchaParam, UploadFileResponse, UploadFileOptions, GetActiveSessionsCountResponse, SessionEventLogListParams, SessionEventLogListResponse, SessionEventLog, SessionProfile, SessionLaunchState, SessionWebBotAuth, SessionCreditBreakdown, StartSessionFromSnapshotParams, WebBotAuthParams, ProxyRoute, UpdateSessionProfileParams, UpdateSessionProxyLocationParams, UpdateSessionProxyParams, UpdateSessionScreenParams, UpdateSessionSolveCaptchasParams, UpdateSessionSolveCaptchasResponse, } from "./session";
 export { SandboxStatus, SandboxRuntimeTarget, SandboxNetworkPolicy, SandboxNetworkPolicyPatch, SandboxNetworkUpdateResult, Sandbox, SandboxDetail, SandboxVolumeMountType, SandboxVolumeMount, SandboxSecretReference, SandboxSecrets, SandboxResolvedSecret, SandboxListParams, SandboxListResponse, SandboxImageSource, SandboxImageSummary, SandboxImageListParams, SandboxImageListResponse, SandboxSnapshotStatus, SandboxSnapshotSummary, SandboxSnapshotListParams, SandboxSnapshotListResponse, SandboxSnapshotDeleteResult, SandboxImageDeleteResult, SandboxImageInit, SandboxImageBuildStatus, SandboxImageBuildInputFormat, SandboxImageBuildSourcePlatform, SandboxImageBuildUpload, SandboxImageBuild, SandboxBuildContextBundle, SandboxBuildContextMode, SandboxBuildContextManifest, SandboxDockerImageConfig, SandboxDockerImageLayer, SandboxDockerImageManifest, CreateSandboxImageBuildParams, ReuseSandboxDockerImageParams, CompleteSandboxImageBuildParams, SandboxImageBuildCreateResult, SandboxDockerImageReuseResult, SandboxImageBuildResolutionOutcome, SandboxImageBuildResolution, SandboxImageBuildWaitOptions, BuildSandboxImageFromDockerImageOptions, BuildSandboxImageFromDockerfileOptions, GetOrBuildSandboxImageOptions, SandboxImageBuildListParams, SandboxImageBuildListResponse, CreateSandboxParams, SandboxMemorySnapshotParams, SandboxMemorySnapshotResult, SandboxExposeParams, SandboxExposeResult, SandboxUnexposeResult, SandboxProcessStatus, SandboxExecParams, SandboxExecOptions, SandboxProcessSummary, SandboxProcessResult, SandboxProcessListParams, SandboxProcessListResponse, SandboxProcessWaitParams, SandboxProcessSignal, SandboxProcessStdinParams, SandboxProcessOutputEvent, SandboxProcessExitEvent, SandboxProcessStreamEvent, SandboxFileType, SandboxFileInfo, SandboxFileWriteInfo, SandboxFileListOptions, SandboxFileReadFormat, SandboxFileReadOptions, SandboxFileWriteData, SandboxFileWriteEntry, SandboxFileTextWriteOptions, SandboxFileBytesWriteOptions, SandboxFileMakeDirOptions, SandboxFileCopyParams, SandboxFileChmodParams, SandboxFileChownParams, SandboxFileTransferResult, SandboxFileSystemEventType, SandboxFileSystemEvent, SandboxWatchDirOptions, SandboxPresignFileParams, SandboxPresignedUrl, SandboxTerminalCreateParams, SandboxTerminalOutputChunk, SandboxTerminalStatus, SandboxTerminalWaitParams, SandboxTerminalKillParams, SandboxTerminalEvent, } from "./sandbox";
 export { CreateVolumeParams, Volume, VolumeListParams, VolumeListResponse, VolumeDeleteResult, } from "./volume";
 export { SecretValue, SecretsPublicKey, SecretsPublicKeyJwk, Secret, SecretVersion, SecretDetail, CreateSecretParams, UpdateSecretParams, SecretListParams, SecretListResponse, SecretDeleteResult, SecretVersionDeleteResult, } from "./secret";
 export { CreateProfileParams, ForkProfileParams, ProfileResponse, CreateProfileResponse, ProfileListParams, ProfileListResponse, } from "./profile";
 export { CreateExtensionParams, CreateExtensionResponse, ListExtensionsResponse, } from "./extension";
-export { ExtractJobStatus, BrowserUseTaskStatus, BrowserUseLlm, ClaudeComputerUseLlm, ClaudeComputerUseReasoningEffort, CuaLlm, CuaReasoningEffort, GeminiComputerUseLlm, GrokComputerUseLlm, GrokReasoningEffort, MetaComputerUseLlm, MetaReasoningEffort, JevComputerUseLlm, JevTextLlm, ScrapeScreenshotFormat, ScrapeJobStatus, CrawlJobStatus, Country, State, ISO639_1, OperatingSystem, Platform, ScrapeFormat, ScrapeWaitUntil, ScrapePageStatus, CrawlPageStatus, RecordingStatus, DownloadsStatus, HyperAgentLlm, HyperAgentTaskStatus, ClaudeComputerUseTaskStatus, CuaTaskStatus, GeminiComputerUseTaskStatus, GrokComputerUseTaskStatus, MetaComputerUseTaskStatus, JevComputerUseTaskStatus, SessionEventLogType, SessionRegion, BrowserUseVersion, HyperAgentVersion, } from "./constants";
+export { ExtractJobStatus, BrowserUseTaskStatus, BrowserUseLlm, ClaudeComputerUseLlm, ClaudeComputerUseReasoningEffort, CuaLlm, CuaReasoningEffort, GeminiComputerUseLlm, GeminiComputerUseReasoningEffort, GrokComputerUseLlm, GrokReasoningEffort, MetaComputerUseLlm, MetaReasoningEffort, JevComputerUseLlm, JevTextLlm, ScrapeScreenshotFormat, ScrapeJobStatus, CrawlJobStatus, Country, State, ISO639_1, OperatingSystem, Platform, ScrapeFormat, ScrapeWaitUntil, ScrapePageStatus, CrawlPageStatus, RecordingStatus, DownloadsStatus, HyperAgentLlm, HyperAgentTaskStatus, ClaudeComputerUseTaskStatus, CuaTaskStatus, GeminiComputerUseTaskStatus, GrokComputerUseTaskStatus, MetaComputerUseTaskStatus, JevComputerUseTaskStatus, SessionEventLogType, SessionRegion, BrowserUseVersion, HyperAgentVersion, } from "./constants";
 export { TeamCreditInfo } from "./team";
 export { ComputerAction, Coordinate, ClickActionParams, DragActionParams, PressKeysActionParams, MoveMouseActionParams, ScreenshotActionParams, CursorPositionActionParams, ScrollAtCursorActionParams, ScrollActionParams, TypeTextActionParams, ComputerActionParams, ComputerActionResponse, ComputerActionMouseButton, ComputerActionResponseData, HoldKeyActionParams, MouseDownActionParams, MouseUpActionParams, GetClipboardTextActionParams, PutSelectionTextActionParams, ComputerActionResponseDataClipboardText, ListWindowsActionParams, ComputerActionWindow, ComputerActionResponseDataListWindows, ComputerActionResponseDataCursorPosition, } from "./computer-action";
 export { FetchParams, FetchResponse, FetchResponseData, FetchStatus } from "./web/fetch";

package/dist/types/session.d.ts

@@ -9,8 +9,17 @@ export interface SessionProfile {
     id: string;
     persistChanges?: boolean;
 }
+/** How a session signs its requests with Web Bot Auth. */
+export interface SessionWebBotAuth {
+    /** The identity the session signs as, e.g. "https://www.hyperbrowser.ai". */
+    signatureAgent: string;
+    /** Present when signing is limited to these hostnames and their subdomains. */
+    onlyDomains?: string[];
+}
 export interface SessionLaunchState {
     enableWebMcp?: boolean;
+    /** Present only for a session that signs its requests with Web Bot Auth. */
+    webBotAuth?: SessionWebBotAuth;
     useUltraStealth?: boolean;
     useStealth?: boolean;
     useProxy?: boolean;
@@ -128,9 +137,44 @@ export interface CaptchaEvaluationResponse {
 export interface StartSessionFromSnapshotParams {
     snapshotId: string;
 }
+export interface WebBotAuthParams {
+    /**
+     * Sign only requests to these hostnames (e.g. "example.com") and their
+     * subdomains. No scheme, port or path; at most 50.
+     */
+    onlyDomains?: string[];
+}
+export interface ProxyRoute {
+    /**
+     * The hosts this route applies to: a hostname, "*.example.com" (subdomains,
+     * not example.com itself) or "*" (every host), or a list of them.
+     */
+    match: string | string[];
+    /**
+     * "direct" sends the traffic straight out of the browser's machine;
+     * "default" sends it through the session's proxy.
+     */
+    proxy: "direct" | "default";
+}
 export interface CreateSessionParams {
     /** Enable page-provided WebMCP tools. Defaults to false on the server. */
     enableWebMcp?: boolean;
+    /**
+     * Sign the session's requests with Web Bot Auth so websites can verify they
+     * come from Hyperbrowser. Pass `{ onlyDomains }` to sign only for those
+     * hosts. Requires Web Bot Auth to be enabled for your team; works for
+     * sessions and agent tasks, and cannot be combined with `useUltraStealth`
+     * or `startFromSnapshot`.
+     */
+    webBotAuth?: boolean | WebBotAuthParams;
+    /**
+     * Choose, per host, whether the session's traffic goes through its proxy or
+     * straight out. The first route that matches a host decides; hosts that no
+     * route matches use the proxy. Requires `useProxy` and proxy routes to be
+     * enabled for your team, only applies when creating a session, and cannot
+     * be combined with `allowInternetAccess: false`, `allowOut` or `denyOut`.
+     */
+    proxyRoutes?: ProxyRoute[];
     useUltraStealth?: boolean;
     useStealth?: boolean;
     useProxy?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperbrowser/sdk",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "Node SDK for Hyperbrowser API",
   "author": "",
   "repository": {