Class SessionStartParams
-
- All Implemented Interfaces:
-
com.browserbase.api.core.Params
public final class SessionStartParams implements Params
Creates a new browser session with the specified configuration. Returns a session ID used for all subsequent operations.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classSessionStartParams.BuilderA builder for SessionStartParams.
public final classSessionStartParams.Bodypublic final classSessionStartParams.Browserpublic final classSessionStartParams.BrowserbaseSessionCreateParamspublic final classSessionStartParams.VerboseLogging verbosity level (0=quiet, 1=normal, 2=debug)
public final classSessionStartParams.XStreamResponseWhether to stream the response via SSE
-
Method Summary
Modifier and Type Method Description final Optional<SessionStartParams.XStreamResponse>xStreamResponse()Whether to stream the response via SSE final StringmodelName()Model name to use for AI operations final Optional<Double>actTimeoutMs()Timeout in ms for act operations (deprecated, v2 only) final Optional<SessionStartParams.Browser>browser()final Optional<SessionStartParams.BrowserbaseSessionCreateParams>browserbaseSessionCreateParams()final Optional<String>browserbaseSessionId()Existing Browserbase session ID to resume final Optional<Double>domSettleTimeoutMs()Timeout in ms to wait for DOM to settle final Optional<Boolean>experimental()final Optional<Boolean>selfHeal()Enable self-healing for failed actions final Optional<String>systemPrompt()Custom system prompt for AI operations final Optional<SessionStartParams.Verbose>verbose()Logging verbosity level (0=quiet, 1=normal, 2=debug) final Optional<Boolean>waitForCaptchaSolves()Wait for captcha solves (deprecated, v2 only) final JsonField<String>_modelName()Returns the raw JSON value of modelName. final JsonField<Double>_actTimeoutMs()Returns the raw JSON value of actTimeoutMs. final JsonField<SessionStartParams.Browser>_browser()Returns the raw JSON value of browser. final JsonField<SessionStartParams.BrowserbaseSessionCreateParams>_browserbaseSessionCreateParams()Returns the raw JSON value of browserbaseSessionCreateParams. final JsonField<String>_browserbaseSessionId()Returns the raw JSON value of browserbaseSessionId. final JsonField<Double>_domSettleTimeoutMs()Returns the raw JSON value of domSettleTimeoutMs. final JsonField<Boolean>_experimental()Returns the raw JSON value of experimental. final JsonField<Boolean>_selfHeal()Returns the raw JSON value of selfHeal. final JsonField<String>_systemPrompt()Returns the raw JSON value of systemPrompt. final JsonField<SessionStartParams.Verbose>_verbose()Returns the raw JSON value of verbose. final JsonField<Boolean>_waitForCaptchaSolves()Returns the raw JSON value of waitForCaptchaSolves. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final SessionStartParams.BuildertoBuilder()final SessionStartParams.Body_body()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static SessionStartParams.Builderbuilder()Returns a mutable builder for constructing an instance of SessionStartParams. -
-
Method Detail
-
xStreamResponse
final Optional<SessionStartParams.XStreamResponse> xStreamResponse()
Whether to stream the response via SSE
-
actTimeoutMs
final Optional<Double> actTimeoutMs()
Timeout in ms for act operations (deprecated, v2 only)
-
browser
final Optional<SessionStartParams.Browser> browser()
-
browserbaseSessionCreateParams
final Optional<SessionStartParams.BrowserbaseSessionCreateParams> browserbaseSessionCreateParams()
-
browserbaseSessionId
final Optional<String> browserbaseSessionId()
Existing Browserbase session ID to resume
-
domSettleTimeoutMs
final Optional<Double> domSettleTimeoutMs()
Timeout in ms to wait for DOM to settle
-
experimental
final Optional<Boolean> experimental()
-
systemPrompt
final Optional<String> systemPrompt()
Custom system prompt for AI operations
-
verbose
final Optional<SessionStartParams.Verbose> verbose()
Logging verbosity level (0=quiet, 1=normal, 2=debug)
-
waitForCaptchaSolves
final Optional<Boolean> waitForCaptchaSolves()
Wait for captcha solves (deprecated, v2 only)
-
_modelName
final JsonField<String> _modelName()
Returns the raw JSON value of modelName.
Unlike modelName, this method doesn't throw if the JSON field has an unexpected type.
-
_actTimeoutMs
final JsonField<Double> _actTimeoutMs()
Returns the raw JSON value of actTimeoutMs.
Unlike actTimeoutMs, this method doesn't throw if the JSON field has an unexpected type.
-
_browser
final JsonField<SessionStartParams.Browser> _browser()
Returns the raw JSON value of browser.
Unlike browser, this method doesn't throw if the JSON field has an unexpected type.
-
_browserbaseSessionCreateParams
final JsonField<SessionStartParams.BrowserbaseSessionCreateParams> _browserbaseSessionCreateParams()
Returns the raw JSON value of browserbaseSessionCreateParams.
Unlike browserbaseSessionCreateParams, this method doesn't throw if the JSON field has an unexpected type.
-
_browserbaseSessionId
final JsonField<String> _browserbaseSessionId()
Returns the raw JSON value of browserbaseSessionId.
Unlike browserbaseSessionId, this method doesn't throw if the JSON field has an unexpected type.
-
_domSettleTimeoutMs
final JsonField<Double> _domSettleTimeoutMs()
Returns the raw JSON value of domSettleTimeoutMs.
Unlike domSettleTimeoutMs, this method doesn't throw if the JSON field has an unexpected type.
-
_experimental
final JsonField<Boolean> _experimental()
Returns the raw JSON value of experimental.
Unlike experimental, this method doesn't throw if the JSON field has an unexpected type.
-
_selfHeal
final JsonField<Boolean> _selfHeal()
Returns the raw JSON value of selfHeal.
Unlike selfHeal, this method doesn't throw if the JSON field has an unexpected type.
-
_systemPrompt
final JsonField<String> _systemPrompt()
Returns the raw JSON value of systemPrompt.
Unlike systemPrompt, this method doesn't throw if the JSON field has an unexpected type.
-
_verbose
final JsonField<SessionStartParams.Verbose> _verbose()
Returns the raw JSON value of verbose.
Unlike verbose, this method doesn't throw if the JSON field has an unexpected type.
-
_waitForCaptchaSolves
final JsonField<Boolean> _waitForCaptchaSolves()
Returns the raw JSON value of waitForCaptchaSolves.
Unlike waitForCaptchaSolves, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final SessionStartParams.Builder toBuilder()
-
_body
final SessionStartParams.Body _body()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static SessionStartParams.Builder builder()
Returns a mutable builder for constructing an instance of SessionStartParams.
The following fields are required:
.modelName()
-
-
-
-