Stagehand constructor
Arguments: ConstructorParams
- TypeScript
- Python
Defaults to
'BROWSERBASE'Your Browserbase API key. Defaults to
BROWSERBASE_API_KEY environment variableYour Browserbase project ID. Defaults to
BROWSERBASE_PROJECT_ID environment variableEnables access to experimental features.
Whether to use the stagehand API. Defaults to
true when env: "BROWSERBASE".Configuration options for creating new Browserbase sessions. More information on browserbaseSessionCreateParams can be found here.
ID of an existing Browserbase session to resume
Specifying the default language model to use. Format supported is
{provider}/{modelName}. For a list of supported providers, see Available Providers.Configuration options for the language model client (i.e.
apiKey)Enables caching of LLM responses. When set to
true, the LLM requests will be cached on disk and reused for identical requests. Defaults to falseSpecifies the timeout in milliseconds for waiting for the DOM to settle. Defaults to
30_000 (30 seconds)message is a LogLine object. Handles log messages. Useful for custom logging implementations. For more information, see the Logging pageWhether Pino should be disabled for logging. This is helpful for Next.js or test environments. Pino will automatically be disabled if a custom
logger is defined.Enables several levels of logging during automation:
0: ERROR (limited to no logging)1: INFO (SDK-level logging)2: DEBUG (Detailed logging and tracing)
A custom system prompt to use for the LLM in addition to the default system prompt for act, extract, and observe methods.
Enables self-healing mode. When set to
true, Stagehand will attempt to recover from errors (eg. outdated cached element not resolving) by retrying the last action. Defaults to true. Set to false to disable LLM inference on cache errors.Provides comprehensive options for local browser instances.
Returns: Stagehand object
The constructor returns an instance of theStagehand class configured with the specified options. However, to use Stagehand, you must still initialize it with init().
stagehand.init()
init() asynchronously initializes the Stagehand instance. It should be called before any other methods.
stagehand.close()
close() is a cleanup method to remove the temporary files created by Stagehand. It’s recommended that you call this explicitly when you’re done with your automation.
