Package com.browserbase.api.models.sessions
See: Description
-
Class Summary Class Description Builder A builder for Action. Action Action object returned by observe and used by act Builder A builder for ModelConfig. Builder A builder for Headers. Headers Custom headers sent with every request to the model provider Provider AI provider for the model (or provide a baseURL endpoint instead) ModelConfig Builder A builder for SessionActParams. Builder A builder for Body. Body Input Natural language instruction or Action object Builder A builder for Options. Model Model configuration object or model name string (e.g. Builder A builder for Variables. Variables Variables to substitute in the action instruction. Options XStreamResponse Whether to stream the response via SSE SessionActParams Executes a browser action using natural language instructions or a predefined Action object. Builder A builder for SessionActResponse. Builder A builder for Data. Builder A builder for Result. Builder A builder for Action. Action Action object returned by observe and used by act Result Data SessionActResponse Builder A builder for SessionEndParams. XStreamResponse Whether to stream the response via SSE SessionEndParams Terminates the browser session and releases all associated resources. Builder A builder for SessionEndResponse. SessionEndResponse Builder A builder for SessionExecuteParams. Builder A builder for Body. Body Builder A builder for AgentConfig. ExecutionModel Model configuration object or model name string (e.g., 'openai/gpt-5-nano') for tool execution (observe/act calls within agent tools). Mode Tool mode for the agent (dom, hybrid, cua). Model Model configuration object or model name string (e.g. Provider AI provider for the agent (legacy, use model: openai/gpt-5-nano instead) AgentConfig Builder A builder for ExecuteOptions. ExecuteOptions XStreamResponse Whether to stream the response via SSE SessionExecuteParams Runs an autonomous AI agent that can perform complex multi-step browser tasks. Builder A builder for SessionExecuteResponse. Builder A builder for Data. Builder A builder for Result. Builder A builder for Action. Action Builder A builder for Metadata. Metadata Builder A builder for Usage. Usage Result Builder A builder for CacheEntry. CacheEntry Data SessionExecuteResponse Builder A builder for SessionExtractParams. Builder A builder for Body. Body Builder A builder for Options. Model Model configuration object or model name string (e.g. Options Builder A builder for Schema. Schema JSON Schema defining the structure of data to extract XStreamResponse Whether to stream the response via SSE SessionExtractParams Extracts structured data from the current page using AI-powered analysis. Builder A builder for SessionExtractResponse. Builder A builder for Data. Data SessionExtractResponse Builder A builder for SessionNavigateParams. Builder A builder for Body. Body Builder A builder for Options. WaitUntil When to consider navigation complete Options XStreamResponse Whether to stream the response via SSE SessionNavigateParams Navigates the browser to the specified URL. Builder A builder for SessionNavigateResponse. Builder A builder for Data. Data SessionNavigateResponse Builder A builder for SessionObserveParams. Builder A builder for Body. Body Builder A builder for Options. Model Model configuration object or model name string (e.g. Builder A builder for Variables. Variables Variables whose names are exposed to the model so observe() returns %variableName% placeholders in suggested action arguments instead of literal values. Options XStreamResponse Whether to stream the response via SSE SessionObserveParams Identifies and returns available actions on the current page that match the given instruction. Builder A builder for SessionObserveResponse. Builder A builder for Data. Builder A builder for Result. Result Action object returned by observe and used by act Data SessionObserveResponse Builder A builder for SessionReplayParams. XStreamResponse Whether to stream the response via SSE SessionReplayParams Retrieves replay metrics for a session. Builder A builder for SessionReplayResponse. Builder A builder for Data. Builder A builder for Page. Builder A builder for Action. Builder A builder for Parameters. Parameters Builder A builder for Result. Result Builder A builder for TokenUsage. TokenUsage Action Page Data SessionReplayResponse Builder A builder for SessionStartParams. Builder A builder for Body. Body Builder A builder for Browser. Builder A builder for LaunchOptions. Builder A builder for CdpHeaders. CdpHeaders IgnoreDefaultArgs Builder A builder for Proxy. Proxy Builder A builder for Viewport. Viewport LaunchOptions Type Browser type to use Browser Builder A builder for BrowserbaseSessionCreateParams. Builder A builder for BrowserSettings. Builder A builder for Context. Context Builder A builder for Fingerprint. Browser Device HttpVersion OperatingSystem Builder A builder for Screen. Screen Fingerprint Builder A builder for Viewport. Viewport BrowserSettings Builder A builder for Browserbase. Builder A builder for Geolocation. Geolocation Browserbase Builder A builder for External. External ProxyConfig Proxies Region Builder A builder for UserMetadata. UserMetadata BrowserbaseSessionCreateParams Verbose Logging verbosity level (0=quiet, 1=normal, 2=debug) XStreamResponse Whether to stream the response via SSE SessionStartParams Creates a new browser session with the specified configuration. Builder A builder for SessionStartResponse. Builder A builder for Data. Data SessionStartResponse Builder A builder for StreamEvent. Builder A builder for StreamEventSystemDataOutput. Status Current status of the streaming operation StreamEventSystemDataOutput Builder A builder for StreamEventLogDataOutput. StreamEventLogDataOutput Data Type Type of stream event - system events or log messages StreamEvent Server-Sent Event emitted during streaming responses. -
Enum Summary Enum Description Known An enum containing Provider's known values. Value An enum containing Provider's known values, as well as an _UNKNOWN member. Known An enum containing XStreamResponse's known values. Value An enum containing XStreamResponse's known values, as well as an _UNKNOWN member. Known An enum containing XStreamResponse's known values. Value An enum containing XStreamResponse's known values, as well as an _UNKNOWN member. Known An enum containing Mode's known values. Value An enum containing Mode's known values, as well as an _UNKNOWN member. Known An enum containing Provider's known values. Value An enum containing Provider's known values, as well as an _UNKNOWN member. Known An enum containing XStreamResponse's known values. Value An enum containing XStreamResponse's known values, as well as an _UNKNOWN member. Known An enum containing XStreamResponse's known values. Value An enum containing XStreamResponse's known values, as well as an _UNKNOWN member. Known An enum containing WaitUntil's known values. Value An enum containing WaitUntil's known values, as well as an _UNKNOWN member. Known An enum containing XStreamResponse's known values. Value An enum containing XStreamResponse's known values, as well as an _UNKNOWN member. Known An enum containing XStreamResponse's known values. Value An enum containing XStreamResponse's known values, as well as an _UNKNOWN member. Known An enum containing XStreamResponse's known values. Value An enum containing XStreamResponse's known values, as well as an _UNKNOWN member. Known An enum containing Type's known values. Value An enum containing Type's known values, as well as an _UNKNOWN member. Known An enum containing Browser's known values. Value An enum containing Browser's known values, as well as an _UNKNOWN member. Known An enum containing Device's known values. Value An enum containing Device's known values, as well as an _UNKNOWN member. Known An enum containing HttpVersion's known values. Value An enum containing HttpVersion's known values, as well as an _UNKNOWN member. Known An enum containing OperatingSystem's known values. Value An enum containing OperatingSystem's known values, as well as an _UNKNOWN member. Known An enum containing Region's known values. Value An enum containing Region's known values, as well as an _UNKNOWN member. Known An enum containing Verbose's known values. Value An enum containing Verbose's known values, as well as an _UNKNOWN member. Known An enum containing XStreamResponse's known values. Value An enum containing XStreamResponse's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Type's known values. Value An enum containing Type's known values, as well as an _UNKNOWN member. -
Interface Summary Interface Description Visitor An interface that defines how to map each variant of Input to a value of type T. Visitor An interface that defines how to map each variant of Model to a value of type T. Visitor An interface that defines how to map each variant of ExecutionModel to a value of type T. Visitor An interface that defines how to map each variant of Model to a value of type T. Visitor An interface that defines how to map each variant of Model to a value of type T. Visitor An interface that defines how to map each variant of Model to a value of type T. Visitor An interface that defines how to map each variant of IgnoreDefaultArgs to a value of type T. Visitor An interface that defines how to map each variant of Proxies to a value of type T. Visitor An interface that defines how to map each variant of ProxyConfig to a value of type T. Visitor An interface that defines how to map each variant of Data to a value of type T.