stagehand

package module

Go to main page

Versions in this module

v0

v0.18.0

Jan 20, 2026

v0.17.2

Jan 13, 2026

v0.17.1

Jan 13, 2026

v0.17.0

Jan 13, 2026

Changes in this version

type SessionEndParams

+ ForceBody any

+ func (r *SessionEndParams) UnmarshalJSON(data []byte) error

+ func (r SessionEndParams) MarshalJSON() (data []byte, err error)

v0.16.1

Jan 5, 2026

v0.16.0

Jan 5, 2026

v0.15.0

Jan 5, 2026

v0.14.0

Dec 19, 2025

Changes in this version

type ModelConfigModelConfigObjectParam

+ Provider string

+ type SessionActResponseDataResultAction struct

+ Arguments []string

+ BackendNodeID float64

+ Description string

+ JSON struct{ ... }

+ Method string

+ Selector string

+ func (r *SessionActResponseDataResultAction) UnmarshalJSON(data []byte) error

+ func (r SessionActResponseDataResultAction) RawJSON() string

type SessionExecuteParamsAgentConfig

+ Provider string

+ type SessionObserveResponseDataResult struct

+ Arguments []string

+ BackendNodeID float64

+ Description string

+ JSON struct{ ... }

+ Method string

+ Selector string

+ func (r *SessionObserveResponseDataResult) UnmarshalJSON(data []byte) error

+ func (r SessionObserveResponseDataResult) RawJSON() string

+ type SessionStartParamsVerbose string

+ const SessionStartParamsVerbose0

+ const SessionStartParamsVerbose1

+ const SessionStartParamsVerbose2

type SessionStartResponseData

+ CdpURL string

v0.13.2

Dec 19, 2025

v0.13.1

Dec 18, 2025

v0.13.0

Dec 18, 2025

Changes in this version

type SessionNavigateParams

+ StreamResponse param.Opt[bool]

type SessionService

+ func (r *SessionService) ActStreaming(ctx context.Context, id string, params SessionActParams, ...) (stream *ssestream.Stream[StreamEvent])

+ func (r *SessionService) ExecuteStreaming(ctx context.Context, id string, params SessionExecuteParams, ...) (stream *ssestream.Stream[StreamEvent])

+ func (r *SessionService) ExtractStreaming(ctx context.Context, id string, params SessionExtractParams, ...) (stream *ssestream.Stream[StreamEvent])

+ func (r *SessionService) ObserveStreaming(ctx context.Context, id string, params SessionObserveParams, ...) (stream *ssestream.Stream[StreamEvent])

type SessionStartResponseData

+ ConnectURL string

+ type StreamEvent struct

+ Data StreamEventDataUnion

+ ID string

+ JSON struct{ ... }

+ Type StreamEventType

+ func (r *StreamEvent) UnmarshalJSON(data []byte) error

+ func (r StreamEvent) RawJSON() string

+ type StreamEventDataStreamEventLogDataOutput struct

+ JSON struct{ ... }

+ Message string

+ Status constant.Running

+ func (r *StreamEventDataStreamEventLogDataOutput) UnmarshalJSON(data []byte) error

+ func (r StreamEventDataStreamEventLogDataOutput) RawJSON() string

+ type StreamEventDataStreamEventSystemDataOutput struct

+ Error string

+ JSON struct{ ... }

+ Result any

+ Status string

+ func (r *StreamEventDataStreamEventSystemDataOutput) UnmarshalJSON(data []byte) error

+ func (r StreamEventDataStreamEventSystemDataOutput) RawJSON() string

+ type StreamEventDataUnion struct

+ Error string

+ JSON struct{ ... }

+ Message string

+ Result any

+ Status string

+ func (r *StreamEventDataUnion) UnmarshalJSON(data []byte) error

+ func (u StreamEventDataUnion) AsStreamEventDataStreamEventLogDataOutput() (v StreamEventDataStreamEventLogDataOutput)

+ func (u StreamEventDataUnion) AsStreamEventDataStreamEventSystemDataOutput() (v StreamEventDataStreamEventSystemDataOutput)

+ func (u StreamEventDataUnion) RawJSON() string

+ type StreamEventType string

+ const StreamEventTypeLog

+ const StreamEventTypeSystem

v0.12.0

Dec 17, 2025

Changes in this version

+ type SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemBrowserbase struct

+ DomainPattern param.Opt[string]

+ Geolocation SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemBrowserbaseGeolocation

+ Type constant.Browserbase

+ func (r *SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemBrowserbase) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemBrowserbase) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemBrowserbaseGeolocation struct

+ City param.Opt[string]

+ Country string

+ State param.Opt[string]

+ func (r *SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemBrowserbaseGeolocation) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemBrowserbaseGeolocation) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemExternal struct

+ DomainPattern param.Opt[string]

+ Password param.Opt[string]

+ Server string

+ Type constant.External

+ Username param.Opt[string]

+ func (r *SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemExternal) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemExternal) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemUnion struct

+ OfBrowserbase *SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemBrowserbase

+ OfExternal *SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemExternal

+ func (u *SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemUnion) UnmarshalJSON(data []byte) error

+ func (u SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemUnion) GetDomainPattern() *string

+ func (u SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemUnion) GetGeolocation() ...

+ func (u SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemUnion) GetPassword() *string

+ func (u SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemUnion) GetServer() *string

+ func (u SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemUnion) GetType() *string

+ func (u SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemUnion) GetUsername() *string

+ func (u SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemUnion) MarshalJSON() ([]byte, error)

type SessionStartParamsBrowserbaseSessionCreateParamsProxiesUnion

+ OfProxyConfigList []SessionStartParamsBrowserbaseSessionCreateParamsProxiesProxyConfigListItemUnion

v0.11.0

Dec 17, 2025

Changes in this version

+ type ModelConfigModelConfigObjectParam struct

+ APIKey param.Opt[string]

+ BaseURL param.Opt[string]

+ ModelName string

+ func (r *ModelConfigModelConfigObjectParam) UnmarshalJSON(data []byte) error

+ func (r ModelConfigModelConfigObjectParam) MarshalJSON() (data []byte, err error)

type ModelConfigUnionParam

+ OfModelConfigModelConfigObject *ModelConfigModelConfigObjectParam

+ func ModelConfigParamOfModelConfigModelConfigObject(modelName string) ModelConfigUnionParam

+ type SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemBrowserbase struct

+ DomainPattern param.Opt[string]

+ Geolocation SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemBrowserbaseGeolocation

+ Type constant.Browserbase

+ func (r *SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemBrowserbase) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemBrowserbase) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemBrowserbaseGeolocation struct

+ City param.Opt[string]

+ Country string

+ State param.Opt[string]

+ func (r *SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemBrowserbaseGeolocation) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemBrowserbaseGeolocation) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemExternal struct

+ DomainPattern param.Opt[string]

+ Password param.Opt[string]

+ Server string

+ Type constant.External

+ Username param.Opt[string]

+ func (r *SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemExternal) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemExternal) MarshalJSON() (data []byte, err error)

type SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemUnion

+ OfBrowserbase *SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemBrowserbase

+ OfExternal *SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemExternal

v0.10.0

Dec 17, 2025

v0.9.0

Dec 17, 2025

v0.8.0

Dec 17, 2025

v0.7.0

Dec 17, 2025

v0.6.0

Dec 17, 2025

Changes in this version

+ type ModelConfigObjectParam struct

+ APIKey param.Opt[string]

+ BaseURL param.Opt[string]

+ ModelName string

+ func (r *ModelConfigObjectParam) UnmarshalJSON(data []byte) error

+ func (r ModelConfigObjectParam) MarshalJSON() (data []byte, err error)

+ type ModelConfigUnionParam struct

+ OfModelConfigObject *ModelConfigObjectParam

+ OfString param.Opt[string]

+ func ModelConfigParamOfModelConfigObject(modelName string) ModelConfigUnionParam

+ func (u *ModelConfigUnionParam) UnmarshalJSON(data []byte) error

+ func (u ModelConfigUnionParam) MarshalJSON() ([]byte, error)

+ type SessionActParamsInputActionInput struct

+ Arguments []string

+ Description string

+ Method param.Opt[string]

+ Selector string

+ func (r *SessionActParamsInputActionInput) UnmarshalJSON(data []byte) error

+ func (r SessionActParamsInputActionInput) MarshalJSON() (data []byte, err error)

type SessionActParamsInputUnion

+ OfSessionActsInputActionInput *SessionActParamsInputActionInput

+ type SessionActParamsXLanguage string

+ const SessionActParamsXLanguagePlayground

+ const SessionActParamsXLanguagePython

+ const SessionActParamsXLanguageTypescript

type SessionActResponse

+ Data SessionActResponseData

+ type SessionActResponseData struct

+ ActionID string

+ JSON struct{ ... }

+ Result SessionActResponseDataResult

+ func (r *SessionActResponseData) UnmarshalJSON(data []byte) error

+ func (r SessionActResponseData) RawJSON() string

+ type SessionActResponseDataResult struct

+ ActionDescription string

+ Actions []Action

+ JSON struct{ ... }

+ Message string

+ Success bool

+ func (r *SessionActResponseDataResult) UnmarshalJSON(data []byte) error

+ func (r SessionActResponseDataResult) RawJSON() string

+ type SessionEndParamsXLanguage string

+ const SessionEndParamsXLanguagePlayground

+ const SessionEndParamsXLanguagePython

+ const SessionEndParamsXLanguageTypescript

+ type SessionEndParamsXStreamResponse string

+ const SessionEndParamsXStreamResponseFalse

+ const SessionEndParamsXStreamResponseTrue

+ type SessionExecuteParams struct

+ AgentConfig SessionExecuteParamsAgentConfig

+ ExecuteOptions SessionExecuteParamsExecuteOptions

+ FrameID param.Opt[string]

+ XLanguage SessionExecuteParamsXLanguage

+ XSDKVersion param.Opt[string]

+ XSentAt param.Opt[time.Time]

+ XStreamResponse SessionExecuteParamsXStreamResponse

+ func (r *SessionExecuteParams) UnmarshalJSON(data []byte) error

+ func (r SessionExecuteParams) MarshalJSON() (data []byte, err error)

+ type SessionExecuteParamsAgentConfig struct

+ Cua param.Opt[bool]

+ Model ModelConfigUnionParam

+ SystemPrompt param.Opt[string]

+ func (r *SessionExecuteParamsAgentConfig) UnmarshalJSON(data []byte) error

+ func (r SessionExecuteParamsAgentConfig) MarshalJSON() (data []byte, err error)

+ type SessionExecuteParamsExecuteOptions struct

+ HighlightCursor param.Opt[bool]

+ Instruction string

+ MaxSteps param.Opt[float64]

+ func (r *SessionExecuteParamsExecuteOptions) UnmarshalJSON(data []byte) error

+ func (r SessionExecuteParamsExecuteOptions) MarshalJSON() (data []byte, err error)

+ type SessionExecuteParamsXLanguage string

+ const SessionExecuteParamsXLanguagePlayground

+ const SessionExecuteParamsXLanguagePython

+ const SessionExecuteParamsXLanguageTypescript

+ type SessionExecuteParamsXStreamResponse string

+ const SessionExecuteParamsXStreamResponseFalse

+ const SessionExecuteParamsXStreamResponseTrue

+ type SessionExecuteResponse struct

+ Data SessionExecuteResponseData

+ JSON struct{ ... }

+ Success bool

+ func (r *SessionExecuteResponse) UnmarshalJSON(data []byte) error

+ func (r SessionExecuteResponse) RawJSON() string

+ type SessionExecuteResponseData struct

+ JSON struct{ ... }

+ Result SessionExecuteResponseDataResult

+ func (r *SessionExecuteResponseData) UnmarshalJSON(data []byte) error

+ func (r SessionExecuteResponseData) RawJSON() string

+ type SessionExecuteResponseDataResult struct

+ Actions []SessionExecuteResponseDataResultAction

+ Completed bool

+ JSON struct{ ... }

+ Message string

+ Metadata map[string]any

+ Success bool

+ Usage SessionExecuteResponseDataResultUsage

+ func (r *SessionExecuteResponseDataResult) UnmarshalJSON(data []byte) error

+ func (r SessionExecuteResponseDataResult) RawJSON() string

+ type SessionExecuteResponseDataResultAction struct

+ Action string

+ ExtraFields map[string]any

+ Instruction string

+ JSON struct{ ... }

+ PageText string

+ PageURL string

+ Reasoning string

+ TaskCompleted bool

+ TimeMs float64

+ Type string

+ func (r *SessionExecuteResponseDataResultAction) UnmarshalJSON(data []byte) error

+ func (r SessionExecuteResponseDataResultAction) RawJSON() string

+ type SessionExecuteResponseDataResultUsage struct

+ CachedInputTokens float64

+ InferenceTimeMs float64

+ InputTokens float64

+ JSON struct{ ... }

+ OutputTokens float64

+ ReasoningTokens float64

+ func (r *SessionExecuteResponseDataResultUsage) UnmarshalJSON(data []byte) error

+ func (r SessionExecuteResponseDataResultUsage) RawJSON() string

+ type SessionExtractParamsXLanguage string

+ const SessionExtractParamsXLanguagePlayground

+ const SessionExtractParamsXLanguagePython

+ const SessionExtractParamsXLanguageTypescript

type SessionExtractResponse

+ Data SessionExtractResponseData

+ JSON struct{ ... }

+ Success bool

+ func (r *SessionExtractResponse) UnmarshalJSON(data []byte) error

+ func (r SessionExtractResponse) RawJSON() string

+ type SessionExtractResponseData struct

+ ActionID string

+ JSON struct{ ... }

+ Result any

+ func (r *SessionExtractResponseData) UnmarshalJSON(data []byte) error

+ func (r SessionExtractResponseData) RawJSON() string

type SessionNavigateParamsOptions

+ Referer param.Opt[string]

+ Timeout param.Opt[float64]

+ type SessionNavigateParamsXLanguage string

+ const SessionNavigateParamsXLanguagePlayground

+ const SessionNavigateParamsXLanguagePython

+ const SessionNavigateParamsXLanguageTypescript

type SessionNavigateResponse

+ Data SessionNavigateResponseData

+ Success bool

+ type SessionNavigateResponseData struct

+ ActionID string

+ JSON struct{ ... }

+ Result any

+ func (r *SessionNavigateResponseData) UnmarshalJSON(data []byte) error

+ func (r SessionNavigateResponseData) RawJSON() string

+ type SessionObserveParamsXLanguage string

+ const SessionObserveParamsXLanguagePlayground

+ const SessionObserveParamsXLanguagePython

+ const SessionObserveParamsXLanguageTypescript

type SessionObserveResponse

+ Data SessionObserveResponseData

+ JSON struct{ ... }

+ Success bool

+ func (r *SessionObserveResponse) UnmarshalJSON(data []byte) error

+ func (r SessionObserveResponse) RawJSON() string

+ type SessionObserveResponseData struct

+ ActionID string

+ JSON struct{ ... }

+ Result []Action

+ func (r *SessionObserveResponseData) UnmarshalJSON(data []byte) error

+ func (r SessionObserveResponseData) RawJSON() string

type SessionService

+ func (r *SessionService) Execute(ctx context.Context, id string, params SessionExecuteParams, ...) (res *SessionExecuteResponse, err error)

type SessionStartParams

+ ActTimeoutMs param.Opt[float64]

+ Browser SessionStartParamsBrowser

+ BrowserbaseSessionCreateParams SessionStartParamsBrowserbaseSessionCreateParams

+ BrowserbaseSessionID param.Opt[string]

+ DebugDom param.Opt[bool]

+ DomSettleTimeoutMs param.Opt[float64]

+ Experimental param.Opt[bool]

+ ModelName string

+ WaitForCaptchaSolves param.Opt[bool]

+ type SessionStartParamsBrowser struct

+ CdpURL param.Opt[string]

+ LaunchOptions SessionStartParamsBrowserLaunchOptions

+ Type string

+ func (r *SessionStartParamsBrowser) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowser) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserLaunchOptions struct

+ AcceptDownloads param.Opt[bool]

+ Args []string

+ CdpURL param.Opt[string]

+ ChromiumSandbox param.Opt[bool]

+ ConnectTimeoutMs param.Opt[float64]

+ DeviceScaleFactor param.Opt[float64]

+ Devtools param.Opt[bool]

+ DownloadsPath param.Opt[string]

+ ExecutablePath param.Opt[string]

+ HasTouch param.Opt[bool]

+ Headless param.Opt[bool]

+ IgnoreDefaultArgs SessionStartParamsBrowserLaunchOptionsIgnoreDefaultArgsUnion

+ IgnoreHTTPSErrors param.Opt[bool]

+ Locale param.Opt[string]

+ PreserveUserDataDir param.Opt[bool]

+ Proxy SessionStartParamsBrowserLaunchOptionsProxy

+ UserDataDir param.Opt[string]

+ Viewport SessionStartParamsBrowserLaunchOptionsViewport

+ func (r *SessionStartParamsBrowserLaunchOptions) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserLaunchOptions) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserLaunchOptionsIgnoreDefaultArgsUnion struct

+ OfBool param.Opt[bool]

+ OfStringArray []string

+ func (u *SessionStartParamsBrowserLaunchOptionsIgnoreDefaultArgsUnion) UnmarshalJSON(data []byte) error

+ func (u SessionStartParamsBrowserLaunchOptionsIgnoreDefaultArgsUnion) MarshalJSON() ([]byte, error)

+ type SessionStartParamsBrowserLaunchOptionsProxy struct

+ Bypass param.Opt[string]

+ Password param.Opt[string]

+ Server string

+ Username param.Opt[string]

+ func (r *SessionStartParamsBrowserLaunchOptionsProxy) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserLaunchOptionsProxy) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserLaunchOptionsViewport struct

+ Height float64

+ Width float64

+ func (r *SessionStartParamsBrowserLaunchOptionsViewport) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserLaunchOptionsViewport) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserbaseSessionCreateParams struct

+ BrowserSettings SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettings

+ ExtensionID param.Opt[string]

+ KeepAlive param.Opt[bool]

+ ProjectID param.Opt[string]

+ Proxies SessionStartParamsBrowserbaseSessionCreateParamsProxiesUnion

+ Region string

+ Timeout param.Opt[float64]

+ UserMetadata map[string]any

+ func (r *SessionStartParamsBrowserbaseSessionCreateParams) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserbaseSessionCreateParams) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettings struct

+ AdvancedStealth param.Opt[bool]

+ BlockAds param.Opt[bool]

+ Context SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettingsContext

+ ExtensionID param.Opt[string]

+ Fingerprint SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettingsFingerprint

+ LogSession param.Opt[bool]

+ RecordSession param.Opt[bool]

+ SolveCaptchas param.Opt[bool]

+ Viewport SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettingsViewport

+ func (r *SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettings) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettings) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettingsContext struct

+ ID string

+ Persist param.Opt[bool]

+ func (r *SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettingsContext) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettingsContext) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettingsFingerprint struct

+ Browsers []string

+ Devices []string

+ HTTPVersion string

+ Locales []string

+ OperatingSystems []string

+ Screen SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettingsFingerprintScreen

+ func (r *SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettingsFingerprint) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettingsFingerprint) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettingsFingerprintScreen struct

+ MaxHeight param.Opt[float64]

+ MaxWidth param.Opt[float64]

+ MinHeight param.Opt[float64]

+ MinWidth param.Opt[float64]

+ func (r *SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettingsFingerprintScreen) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettingsFingerprintScreen) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettingsViewport struct

+ Height param.Opt[float64]

+ Width param.Opt[float64]

+ func (r *SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettingsViewport) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserbaseSessionCreateParamsBrowserSettingsViewport) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemBrowserbaseProxyConfig struct

+ DomainPattern param.Opt[string]

+ Geolocation SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemBrowserbaseProxyConfigGeolocation

+ Type string

+ func (r *SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemBrowserbaseProxyConfig) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemBrowserbaseProxyConfig) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemBrowserbaseProxyConfigGeolocation struct

+ City param.Opt[string]

+ Country string

+ State param.Opt[string]

+ func (r *SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemBrowserbaseProxyConfigGeolocation) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemBrowserbaseProxyConfigGeolocation) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemExternalProxyConfig struct

+ DomainPattern param.Opt[string]

+ Password param.Opt[string]

+ Server string

+ Type string

+ Username param.Opt[string]

+ func (r *SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemExternalProxyConfig) UnmarshalJSON(data []byte) error

+ func (r SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemExternalProxyConfig) MarshalJSON() (data []byte, err error)

+ type SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemUnion struct

+ OfSessionStartsBrowserbaseSessionCreateParamsProxiesArrayItemBrowserbaseProxyConfig *SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemBrowserbaseProxyConfig

+ OfSessionStartsBrowserbaseSessionCreateParamsProxiesArrayItemExternalProxyConfig *SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemExternalProxyConfig

+ func (u *SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemUnion) UnmarshalJSON(data []byte) error

+ func (u SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemUnion) GetDomainPattern() *string

+ func (u SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemUnion) GetGeolocation() ...

+ func (u SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemUnion) GetPassword() *string

+ func (u SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemUnion) GetServer() *string

+ func (u SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemUnion) GetType() *string

+ func (u SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemUnion) GetUsername() *string

+ func (u SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemUnion) MarshalJSON() ([]byte, error)

+ type SessionStartParamsBrowserbaseSessionCreateParamsProxiesUnion struct

+ OfBool param.Opt[bool]

+ OfSessionStartsBrowserbaseSessionCreateParamsProxiesArray []SessionStartParamsBrowserbaseSessionCreateParamsProxiesArrayItemUnion

+ func (u *SessionStartParamsBrowserbaseSessionCreateParamsProxiesUnion) UnmarshalJSON(data []byte) error

+ func (u SessionStartParamsBrowserbaseSessionCreateParamsProxiesUnion) MarshalJSON() ([]byte, error)

+ type SessionStartParamsXLanguage string

+ const SessionStartParamsXLanguagePlayground

+ const SessionStartParamsXLanguagePython

+ const SessionStartParamsXLanguageTypescript

+ type SessionStartParamsXStreamResponse string

+ const SessionStartParamsXStreamResponseFalse

+ const SessionStartParamsXStreamResponseTrue

type SessionStartResponse

+ Data SessionStartResponseData

+ Success bool

+ type SessionStartResponseData struct

+ Available bool

+ JSON struct{ ... }

+ SessionID string

+ func (r *SessionStartResponseData) UnmarshalJSON(data []byte) error

+ func (r SessionStartResponseData) RawJSON() string

v0.5.0

Dec 17, 2025

Changes in this version

type SessionActParams

+ Body any

+ XLanguage any

+ XSDKVersion any

+ XSentAt any

+ type SessionEndParams struct

+ XLanguage any

+ XSDKVersion any

+ XSentAt any

+ XStreamResponse any

type SessionExecuteAgentParams

+ Body any

+ XLanguage any

+ XSDKVersion any

+ XSentAt any

type SessionExtractParams

+ Body any

+ XLanguage any

+ XSDKVersion any

+ XSentAt any

+ type SessionExtractResponse = any

type SessionNavigateParams

+ Body any

+ XLanguage any

+ XSDKVersion any

+ XSentAt any

type SessionObserveParams

+ Body any

+ XLanguage any

+ XSDKVersion any

+ XSentAt any

+ type SessionObserveResponse = any

v0.4.0

Dec 17, 2025

Changes in this version

type SessionStartParams

+ Body any

+ XLanguage any

+ XSDKVersion any

+ XSentAt any

+ XStreamResponse any

v0.3.0

Dec 16, 2025

v0.2.0

Dec 16, 2025

v0.1.0

Dec 16, 2025

Changes in this version

+ func Bool(b bool) param.Opt[bool]

+ func BoolPtr(v bool) *bool

+ func DefaultClientOptions() []option.RequestOption

+ func File(rdr io.Reader, filename string, contentType string) file

+ func Float(f float64) param.Opt[float64]

+ func FloatPtr(v float64) *float64

+ func Int(i int64) param.Opt[int64]

+ func IntPtr(v int64) *int64

+ func Opt[T comparable](v T) param.Opt[T]

+ func Ptr[T any](v T) *T

+ func String(s string) param.Opt[string]

+ func StringPtr(v string) *string

+ func Time(t time.Time) param.Opt[time.Time]

+ func TimePtr(v time.Time) *time.Time

+ type Action struct

+ Arguments []string

+ BackendNodeID int64

+ Description string

+ JSON struct{ ... }

+ Method string

+ Selector string

+ func (r *Action) UnmarshalJSON(data []byte) error

+ func (r Action) RawJSON() string

+ func (r Action) ToParam() ActionParam

+ type ActionParam struct

+ Arguments []string

+ BackendNodeID param.Opt[int64]

+ Description string

+ Method string

+ Selector string

+ func (r *ActionParam) UnmarshalJSON(data []byte) error

+ func (r ActionParam) MarshalJSON() (data []byte, err error)

+ type Client struct

+ Options []option.RequestOption

+ Sessions SessionService

+ func NewClient(opts ...option.RequestOption) (r Client)

+ func (r *Client) Delete(ctx context.Context, path string, params any, res any, ...) error

+ func (r *Client) Execute(ctx context.Context, method string, path string, params any, res any, ...) error

+ func (r *Client) Get(ctx context.Context, path string, params any, res any, ...) error

+ func (r *Client) Patch(ctx context.Context, path string, params any, res any, ...) error

+ func (r *Client) Post(ctx context.Context, path string, params any, res any, ...) error

+ func (r *Client) Put(ctx context.Context, path string, params any, res any, ...) error

+ type Error = apierror.Error

+ type ModelConfigParam struct

+ APIKey param.Opt[string]

+ BaseURL param.Opt[string]

+ Model param.Opt[string]

+ Provider ModelConfigProvider

+ func (r *ModelConfigParam) UnmarshalJSON(data []byte) error

+ func (r ModelConfigParam) MarshalJSON() (data []byte, err error)

+ type ModelConfigProvider string

+ const ModelConfigProviderAnthropic

+ const ModelConfigProviderGoogle

+ const ModelConfigProviderOpenAI

+ type SessionActParams struct

+ FrameID param.Opt[string]

+ Input SessionActParamsInputUnion

+ Options SessionActParamsOptions

+ XStreamResponse SessionActParamsXStreamResponse

+ func (r *SessionActParams) UnmarshalJSON(data []byte) error

+ func (r SessionActParams) MarshalJSON() (data []byte, err error)

+ type SessionActParamsInputUnion struct

+ OfAction *ActionParam

+ OfString param.Opt[string]

+ func (u *SessionActParamsInputUnion) UnmarshalJSON(data []byte) error

+ func (u SessionActParamsInputUnion) MarshalJSON() ([]byte, error)

+ type SessionActParamsOptions struct

+ Model ModelConfigParam

+ Timeout param.Opt[int64]

+ Variables map[string]string

+ func (r *SessionActParamsOptions) UnmarshalJSON(data []byte) error

+ func (r SessionActParamsOptions) MarshalJSON() (data []byte, err error)

+ type SessionActParamsXStreamResponse string

+ const SessionActParamsXStreamResponseFalse

+ const SessionActParamsXStreamResponseTrue

+ type SessionActResponse struct

+ Actions []Action

+ JSON struct{ ... }

+ Message string

+ Success bool

+ func (r *SessionActResponse) UnmarshalJSON(data []byte) error

+ func (r SessionActResponse) RawJSON() string

+ type SessionEndResponse struct

+ JSON struct{ ... }

+ Success bool

+ func (r *SessionEndResponse) UnmarshalJSON(data []byte) error

+ func (r SessionEndResponse) RawJSON() string

+ type SessionExecuteAgentParams struct

+ AgentConfig SessionExecuteAgentParamsAgentConfig

+ ExecuteOptions SessionExecuteAgentParamsExecuteOptions

+ FrameID param.Opt[string]

+ XStreamResponse SessionExecuteAgentParamsXStreamResponse

+ func (r *SessionExecuteAgentParams) UnmarshalJSON(data []byte) error

+ func (r SessionExecuteAgentParams) MarshalJSON() (data []byte, err error)

+ type SessionExecuteAgentParamsAgentConfig struct

+ Cua param.Opt[bool]

+ Model SessionExecuteAgentParamsAgentConfigModelUnion

+ Provider string

+ SystemPrompt param.Opt[string]

+ func (r *SessionExecuteAgentParamsAgentConfig) UnmarshalJSON(data []byte) error

+ func (r SessionExecuteAgentParamsAgentConfig) MarshalJSON() (data []byte, err error)

+ type SessionExecuteAgentParamsAgentConfigModelUnion struct

+ OfModelConfig *ModelConfigParam

+ OfString param.Opt[string]

+ func (u *SessionExecuteAgentParamsAgentConfigModelUnion) UnmarshalJSON(data []byte) error

+ func (u SessionExecuteAgentParamsAgentConfigModelUnion) MarshalJSON() ([]byte, error)

+ type SessionExecuteAgentParamsExecuteOptions struct

+ HighlightCursor param.Opt[bool]

+ Instruction string

+ MaxSteps param.Opt[int64]

+ func (r *SessionExecuteAgentParamsExecuteOptions) UnmarshalJSON(data []byte) error

+ func (r SessionExecuteAgentParamsExecuteOptions) MarshalJSON() (data []byte, err error)

+ type SessionExecuteAgentParamsXStreamResponse string

+ const SessionExecuteAgentParamsXStreamResponseFalse

+ const SessionExecuteAgentParamsXStreamResponseTrue

+ type SessionExecuteAgentResponse struct

+ JSON struct{ ... }

+ Message string

+ Steps []any

+ func (r *SessionExecuteAgentResponse) UnmarshalJSON(data []byte) error

+ func (r SessionExecuteAgentResponse) RawJSON() string

+ type SessionExtractParams struct

+ FrameID param.Opt[string]

+ Instruction param.Opt[string]

+ Options SessionExtractParamsOptions

+ Schema map[string]any

+ XStreamResponse SessionExtractParamsXStreamResponse

+ func (r *SessionExtractParams) UnmarshalJSON(data []byte) error

+ func (r SessionExtractParams) MarshalJSON() (data []byte, err error)

+ type SessionExtractParamsOptions struct

+ Model ModelConfigParam

+ Selector param.Opt[string]

+ Timeout param.Opt[int64]

+ func (r *SessionExtractParamsOptions) UnmarshalJSON(data []byte) error

+ func (r SessionExtractParamsOptions) MarshalJSON() (data []byte, err error)

+ type SessionExtractParamsXStreamResponse string

+ const SessionExtractParamsXStreamResponseFalse

+ const SessionExtractParamsXStreamResponseTrue

+ type SessionExtractResponseExtraction struct

+ Extraction string

+ JSON struct{ ... }

+ func (r *SessionExtractResponseExtraction) UnmarshalJSON(data []byte) error

+ func (r SessionExtractResponseExtraction) RawJSON() string

+ type SessionExtractResponseUnion struct

+ Extraction string

+ JSON struct{ ... }

+ OfSessionExtractResponseCustomItem any

+ func (r *SessionExtractResponseUnion) UnmarshalJSON(data []byte) error

+ func (u SessionExtractResponseUnion) AsCustom() (v map[string]any)

+ func (u SessionExtractResponseUnion) AsSessionExtractResponseExtraction() (v SessionExtractResponseExtraction)

+ func (u SessionExtractResponseUnion) RawJSON() string

+ type SessionNavigateParams struct

+ FrameID param.Opt[string]

+ Options SessionNavigateParamsOptions

+ URL string

+ XStreamResponse SessionNavigateParamsXStreamResponse

+ func (r *SessionNavigateParams) UnmarshalJSON(data []byte) error

+ func (r SessionNavigateParams) MarshalJSON() (data []byte, err error)

+ type SessionNavigateParamsOptions struct

+ WaitUntil string

+ func (r *SessionNavigateParamsOptions) UnmarshalJSON(data []byte) error

+ func (r SessionNavigateParamsOptions) MarshalJSON() (data []byte, err error)

+ type SessionNavigateParamsXStreamResponse string

+ const SessionNavigateParamsXStreamResponseFalse

+ const SessionNavigateParamsXStreamResponseTrue

+ type SessionNavigateResponse struct

+ JSON struct{ ... }

+ Ok bool

+ Status int64

+ URL string

+ func (r *SessionNavigateResponse) UnmarshalJSON(data []byte) error

+ func (r SessionNavigateResponse) RawJSON() string

+ type SessionObserveParams struct

+ FrameID param.Opt[string]

+ Instruction param.Opt[string]

+ Options SessionObserveParamsOptions

+ XStreamResponse SessionObserveParamsXStreamResponse

+ func (r *SessionObserveParams) UnmarshalJSON(data []byte) error

+ func (r SessionObserveParams) MarshalJSON() (data []byte, err error)

+ type SessionObserveParamsOptions struct

+ Model ModelConfigParam

+ Selector param.Opt[string]

+ Timeout param.Opt[int64]

+ func (r *SessionObserveParamsOptions) UnmarshalJSON(data []byte) error

+ func (r SessionObserveParamsOptions) MarshalJSON() (data []byte, err error)

+ type SessionObserveParamsXStreamResponse string

+ const SessionObserveParamsXStreamResponseFalse

+ const SessionObserveParamsXStreamResponseTrue

+ type SessionService struct

+ Options []option.RequestOption

+ func NewSessionService(opts ...option.RequestOption) (r SessionService)

+ func (r *SessionService) Act(ctx context.Context, sessionID string, params SessionActParams, ...) (res *SessionActResponse, err error)

+ func (r *SessionService) End(ctx context.Context, sessionID string, opts ...option.RequestOption) (res *SessionEndResponse, err error)

+ func (r *SessionService) ExecuteAgent(ctx context.Context, sessionID string, params SessionExecuteAgentParams, ...) (res *SessionExecuteAgentResponse, err error)

+ func (r *SessionService) Extract(ctx context.Context, sessionID string, params SessionExtractParams, ...) (res *SessionExtractResponseUnion, err error)

+ func (r *SessionService) Navigate(ctx context.Context, sessionID string, params SessionNavigateParams, ...) (res *SessionNavigateResponse, err error)

+ func (r *SessionService) Observe(ctx context.Context, sessionID string, params SessionObserveParams, ...) (res *[]Action, err error)

+ func (r *SessionService) Start(ctx context.Context, body SessionStartParams, opts ...option.RequestOption) (res *SessionStartResponse, err error)

+ type SessionStartParams struct

+ BrowserbaseAPIKey string

+ BrowserbaseProjectID string

+ DomSettleTimeout param.Opt[int64]

+ Model param.Opt[string]

+ SelfHeal param.Opt[bool]

+ SystemPrompt param.Opt[string]

+ Verbose param.Opt[int64]

+ func (r *SessionStartParams) UnmarshalJSON(data []byte) error

+ func (r SessionStartParams) MarshalJSON() (data []byte, err error)

+ type SessionStartResponse struct

+ Available bool

+ JSON struct{ ... }

+ SessionID string

+ func (r *SessionStartResponse) UnmarshalJSON(data []byte) error

+ func (r SessionStartResponse) RawJSON() string

Other modules containing this package

github.com/browserbase/stagehand-go/v3

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL