Class SessionExecuteParams
-
- All Implemented Interfaces:
-
com.browserbase.api.core.Params
public final class SessionExecuteParams implements Params
Runs an autonomous AI agent that can perform complex multi-step browser tasks.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classSessionExecuteParams.BuilderA builder for SessionExecuteParams.
public final classSessionExecuteParams.Bodypublic final classSessionExecuteParams.AgentConfigpublic final classSessionExecuteParams.ExecuteOptionspublic final classSessionExecuteParams.XStreamResponseWhether to stream the response via SSE
-
Method Summary
Modifier and Type Method Description final Optional<String>id()Unique session identifier final Optional<SessionExecuteParams.XStreamResponse>xStreamResponse()Whether to stream the response via SSE final SessionExecuteParams.AgentConfigagentConfig()final SessionExecuteParams.ExecuteOptionsexecuteOptions()final Optional<String>frameId()Target frame ID for the agent final Optional<Boolean>shouldCache()If true, the server captures a cache entry and returns it to the client final JsonField<SessionExecuteParams.AgentConfig>_agentConfig()Returns the raw JSON value of agentConfig. final JsonField<SessionExecuteParams.ExecuteOptions>_executeOptions()Returns the raw JSON value of executeOptions. final JsonField<String>_frameId()Returns the raw JSON value of frameId. final JsonField<Boolean>_shouldCache()Returns the raw JSON value of shouldCache. 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 SessionExecuteParams.BuildertoBuilder()final SessionExecuteParams.Body_body()final String_pathParam(Integer index)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 SessionExecuteParams.Builderbuilder()Returns a mutable builder for constructing an instance of SessionExecuteParams. -
-
Method Detail
-
xStreamResponse
final Optional<SessionExecuteParams.XStreamResponse> xStreamResponse()
Whether to stream the response via SSE
-
agentConfig
final SessionExecuteParams.AgentConfig agentConfig()
-
executeOptions
final SessionExecuteParams.ExecuteOptions executeOptions()
-
shouldCache
final Optional<Boolean> shouldCache()
If true, the server captures a cache entry and returns it to the client
-
_agentConfig
final JsonField<SessionExecuteParams.AgentConfig> _agentConfig()
Returns the raw JSON value of agentConfig.
Unlike agentConfig, this method doesn't throw if the JSON field has an unexpected type.
-
_executeOptions
final JsonField<SessionExecuteParams.ExecuteOptions> _executeOptions()
Returns the raw JSON value of executeOptions.
Unlike executeOptions, this method doesn't throw if the JSON field has an unexpected type.
-
_frameId
final JsonField<String> _frameId()
Returns the raw JSON value of frameId.
Unlike frameId, this method doesn't throw if the JSON field has an unexpected type.
-
_shouldCache
final JsonField<Boolean> _shouldCache()
Returns the raw JSON value of shouldCache.
Unlike shouldCache, 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 SessionExecuteParams.Builder toBuilder()
-
_body
final SessionExecuteParams.Body _body()
-
_pathParam
final String _pathParam(Integer index)
-
_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 SessionExecuteParams.Builder builder()
Returns a mutable builder for constructing an instance of SessionExecuteParams.
The following fields are required:
.agentConfig() .executeOptions()
-
-
-
-