Method start

src/stagehand/resources/sessions.py:920–1013

Creates a new browser session with the specified configuration. Returns a session ID used for all subsequent operations. Args: model_name: Model name to use for AI operations act_timeout_ms: Timeout in ms for act operations (deprecated, v2 only)

(
        self,
        *,
        model_name: str,
        act_timeout_ms: float | Omit = omit,
        browser: session_start_params.Browser | Omit = omit,
        browserbase_session_create_params: session_start_params.BrowserbaseSessionCreateParams | Omit = omit,
        browserbase_session_id: str | Omit = omit,
        dom_settle_timeout_ms: float | Omit = omit,
        experimental: bool | Omit = omit,
        self_heal: bool | Omit = omit,
        system_prompt: str | Omit = omit,
        verbose: Literal[0, 1, 2] | Omit = omit,
        wait_for_captcha_solves: bool | Omit = omit,
        x_stream_response: Literal["true", "false"] | Omit = omit,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
        ### <CUSTOM CODE HANDWRITTEN BY STAGEHAND TEAM (not codegen)>
        # The runtime monkey patch returns a bound `Session`; mirror that public
        # return type here so users see the right API surface.
    )

        )

    def start(
        self,
        *,
        model_name: str,
        act_timeout_ms: float | Omit = omit,
        browser: session_start_params.Browser | Omit = omit,
        browserbase_session_create_params: session_start_params.BrowserbaseSessionCreateParams | Omit = omit,
        browserbase_session_id: str | Omit = omit,
        dom_settle_timeout_ms: float | Omit = omit,
        experimental: bool | Omit = omit,
        self_heal: bool | Omit = omit,
        system_prompt: str | Omit = omit,
        verbose: Literal[0, 1, 2] | Omit = omit,
        wait_for_captcha_solves: bool | Omit = omit,
        x_stream_response: Literal["true", "false"] | Omit = omit,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
        ### <CUSTOM CODE HANDWRITTEN BY STAGEHAND TEAM (not codegen)>
        # The runtime monkey patch returns a bound `Session`; mirror that public
        # return type here so users see the right API surface.
    ) -> Session:
        ### </END CUSTOM CODE>
        """Creates a new browser session with the specified configuration.

        Returns a
        session ID used for all subsequent operations.

        Args:
          model_name: Model name to use for AI operations

          act_timeout_ms: Timeout in ms for act operations (deprecated, v2 only)

          browserbase_session_id: Existing Browserbase session ID to resume

          dom_settle_timeout_ms: Timeout in ms to wait for DOM to settle

          self_heal: Enable self-healing for failed actions

          system_prompt: Custom system prompt for AI operations

          verbose: Logging verbosity level (0=quiet, 1=normal, 2=debug)

          wait_for_captcha_solves: Wait for captcha solves (deprecated, v2 only)

          x_stream_response: Whether to stream the response via SSE

          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds
        """