Version: Next

@crawlee/stagehand

Provides AI-powered web crawling using Stagehand for natural language browser automation. The enhanced page object offers page.act() to perform actions with plain English, page.extract() to get structured data with Zod schemas, and page.observe() to discover available actions.

Since StagehandCrawler uses AI models for page interaction, it is useful for crawling websites with complex or frequently changing layouts where traditional CSS selectors are difficult to maintain. If the target website has a stable structure, consider using PlaywrightCrawler, which is faster and doesn't require AI API keys.

The crawler extends BrowserCrawler and supports all standard Crawlee features including request queues, proxy rotation, autoscaling, and browser fingerprinting.

API Key Configuration

The apiKey option is interpreted based on the env setting:

env: 'LOCAL' (default): apiKey is the LLM provider key (OpenAI, Anthropic, or Google)
env: 'BROWSERBASE': apiKey is the Browserbase API key

const crawler = new StagehandCrawler({
    stagehandOptions: {
        model: 'openai/gpt-4.1-mini',
        apiKey: 'your-api-key', // LLM API key for LOCAL env
    },
    // ...
});

Alternatively, you can use environment variables (used as fallback when apiKey is not provided):

OpenAI: OPENAI_API_KEY
Anthropic: ANTHROPIC_API_KEY
Google: GOOGLE_API_KEY

Example usage

import { StagehandCrawler } from '@crawlee/stagehand';
import { z } from 'zod';

const crawler = new StagehandCrawler({
    stagehandOptions: {
        model: 'openai/gpt-4.1-mini',
    },
    async requestHandler({ page, request, log }) {
        log.info(`Processing ${request.url}`);

        // Use natural language to interact with the page
        await page.act('Click the "Load More" button');

        // Extract structured data with AI
        const data = await page.extract(
            'Get all product names and prices',
            z.object({
                products: z.array(z.object({
                    name: z.string(),
                    price: z.number(),
                })),
            }),
        );

        log.info(`Found ${data.products.length} products`);
    },
});

await crawler.run(['https://example.com']);

AI-powered web crawling with Stagehand integration for Crawlee.

This package provides StagehandCrawler, which extends BrowserCrawler with natural language browser automation capabilities powered by Browserbase's Stagehand library.

Key Features

Natural Language Actions: Use page.act() to perform actions with plain English instructions
Structured Data Extraction: Use page.extract() with Zod schemas for type-safe data extraction
Action Discovery: Use page.observe() to get AI-suggested actions
Autonomous Agents: Use page.agent() for complex multi-step workflows
Anti-Blocking: Automatic browser fingerprinting and Cloudflare bypass
Browserbase Integration: Optional cloud browser support

import { StagehandCrawler } from '@crawlee/stagehand';
import { z } from 'zod';

const crawler = new StagehandCrawler({
  stagehandOptions: {
    env: 'LOCAL',
    model: 'openai/gpt-4.1-mini',
  },
  async requestHandler({ page, request, log }) {
    log.info(`Processing ${request.url}`);

    // Use natural language to interact
    await page.act('Click the Products link');

    // Extract structured data
    const products = await page.extract(
      'Get all products',
      z.object({
        items: z.array(z.object({
          name: z.string(),
          price: z.number(),
        })),
      })
    );

    await Dataset.pushData(products);
  },
});

await crawler.run(['https://example.com']);

Index

Browser management

Other

Dataset

Re-exports Dataset

DatasetConsumer

Re-exports DatasetConsumer

DatasetContent

Re-exports DatasetContent

DatasetDataOptions

Re-exports DatasetDataOptions

DatasetExportOptions

Re-exports DatasetExportOptions

DatasetExportToOptions

Re-exports DatasetExportToOptions

DatasetIteratorOptions

Re-exports DatasetIteratorOptions

DatasetJournalEntry

Re-exports DatasetJournalEntry

DatasetMapper

Re-exports DatasetMapper

DatasetOptions

Re-exports DatasetOptions

DatasetReducer

Re-exports DatasetReducer

DatasetStats

Re-exports DatasetStats

defaultRoute

Re-exports defaultRoute

DefaultRouteUserData

Re-exports DefaultRouteUserData

DefaultStorageIdentifier

Re-exports DefaultStorageIdentifier

EnqueueLinksOptions

Re-exports EnqueueLinksOptions

EnqueueStrategy

Re-exports EnqueueStrategy

EnqueueStrategyOption

Re-exports EnqueueStrategyOption

EnqueueUrlsOptions

Re-exports EnqueueUrlsOptions

ErrnoException

Re-exports ErrnoException

ErrorHandler

Re-exports ErrorHandler

ErrorSnapshotter

Re-exports ErrorSnapshotter

ErrorTracker

Re-exports ErrorTracker

ErrorTrackerOptions

Re-exports ErrorTrackerOptions

EventLoopLoadSignal

Re-exports EventLoopLoadSignal

EventLoopLoadSignalOptions

Re-exports EventLoopLoadSignalOptions

EventManager

Re-exports EventManager

EventManagerOptions

Re-exports EventManagerOptions

EventStatusMessageData

Re-exports EventStatusMessageData

EventType

Re-exports EventType

EventTypeName

Re-exports EventTypeName

ExplicitStorageIdentifier

Re-exports ExplicitStorageIdentifier

ExtractLinksOptions

Re-exports ExtractLinksOptions

field

Re-exports field

FieldsInput

Re-exports FieldsInput

FieldsOutput

Re-exports FieldsOutput

FinalStatistics

Re-exports FinalStatistics

GetUserDataFromRequest

Re-exports GetUserDataFromRequest

GlobInput

Re-exports GlobInput

GlobObject

Re-exports GlobObject

IConcurrencySystem

Re-exports IConcurrencySystem

IProxyConfiguration

Re-exports IProxyConfiguration

IRequestLoader

Re-exports IRequestLoader

IRequestManager

Re-exports IRequestManager

IStatistics

Re-exports IStatistics

IStorage

Re-exports IStorage

JournaledRequest

Re-exports JournaledRequest

JournalEntry

Re-exports JournalEntry

KeyConsumer

Re-exports KeyConsumer

KeyValueStore

Re-exports KeyValueStore

KeyValueStoreIteratorOptions

Re-exports KeyValueStoreIteratorOptions

KeyValueStoreJournalEntry

Re-exports KeyValueStoreJournalEntry

KeyValueStoreOptions

Re-exports KeyValueStoreOptions

KeyValueStoreRawRecord

Re-exports KeyValueStoreRawRecord

KeyValueStoreStats

Re-exports KeyValueStoreStats

LabeledSource

Re-exports LabeledSource

LauncherBrowserPoolOptions

Re-exports LauncherBrowserPoolOptions

LauncherRemoteBrowserPoolOptions

Re-exports LauncherRemoteBrowserPoolOptions

LoadedRequest

Re-exports LoadedRequest

LoadSignal

Re-exports LoadSignal

LoadSignalInfo

Re-exports LoadSignalInfo

LoadSignalsOptions

Re-exports LoadSignalsOptions

LoadSignalStartContext

Re-exports LoadSignalStartContext

LoadSnapshot

Re-exports LoadSnapshot

LocalEventManager

Re-exports LocalEventManager

LocalEventManagerOptions

Re-exports LocalEventManagerOptions

log

Re-exports log

Log

Re-exports Log

Logger

Re-exports Logger

LoggerJson

Re-exports LoggerJson

LoggerOptions

Re-exports LoggerOptions

LoggerText

Re-exports LoggerText

LogLevel

Re-exports LogLevel

MAX_POOL_SIZE

Re-exports MAX_POOL_SIZE

MemoryLoadSignal

Re-exports MemoryLoadSignal

MemoryLoadSignalOptions

Re-exports MemoryLoadSignalOptions

MemoryStorageBackend

Re-exports MemoryStorageBackend

MemoryStorageOptions

Re-exports MemoryStorageOptions

MissingSessionError

Re-exports MissingSessionError

NavigationSkippedError

Re-exports NavigationSkippedError

NonRetryableError

Re-exports NonRetryableError

OwnedBrowserPool

Re-exports OwnedBrowserPool

PacingScope

Re-exports PacingScope

PacingSignal

Re-exports PacingSignal

parseRetryAfterHeader

Re-exports parseRetryAfterHeader

parseValue

Re-exports parseValue

PERSIST_STATE_KEY

Re-exports PERSIST_STATE_KEY

PersistenceOptions

Re-exports PersistenceOptions

PersistentRateLimitError

Re-exports PersistentRateLimitError

ProxyConfiguration

Re-exports ProxyConfiguration

ProxyConfigurationFunction

Re-exports ProxyConfigurationFunction

ProxyConfigurationOptions

Re-exports ProxyConfigurationOptions

purgeDefaultStorages

Re-exports purgeDefaultStorages

PushErrorMessageOptions

Re-exports PushErrorMessageOptions

RecordOptions

Re-exports RecordOptions

RecoverableState

Re-exports RecoverableState

RecoverableStateOptions

Re-exports RecoverableStateOptions

RecoverableStatePersistenceOptions

Re-exports RecoverableStatePersistenceOptions

RegExpInput

Re-exports RegExpInput

RegExpObject

Re-exports RegExpObject

Request

Re-exports Request

RequestHandler

Re-exports RequestHandler

RequestHandlerError

Re-exports RequestHandlerError

RequestList

Re-exports RequestList

RequestListOptions

Re-exports RequestListOptions

RequestListSourcesFunction

Re-exports RequestListSourcesFunction

RequestListState

Re-exports RequestListState

RequestLoaderStatus

Re-exports RequestLoaderStatus

RequestManagerOpener

Re-exports RequestManagerOpener

RequestManagerTandem

Re-exports RequestManagerTandem

RequestOptions

Re-exports RequestOptions

RequestQueue

Re-exports RequestQueue

RequestQueueJournalEntry

Re-exports RequestQueueJournalEntry

RequestQueueOperationInfo

Re-exports RequestQueueOperationInfo

RequestQueueOperationOptions

Re-exports RequestQueueOperationOptions

RequestQueueOptions

Re-exports RequestQueueOptions

RequestQueueStats

Re-exports RequestQueueStats

RequestsLike

Re-exports RequestsLike

RequestSourceStatus

Re-exports RequestSourceStatus

RequestState

Re-exports RequestState

RequestThrottledError

Re-exports RequestThrottledError

RequestTransform

Re-exports RequestTransform

RequestValidationError

Re-exports RequestValidationError

RequireContextPipeline

Re-exports RequireContextPipeline

ResolvedConfigValues

Re-exports ResolvedConfigValues

resolveStorageIdentifier

Re-exports resolveStorageIdentifier

ResponseLike

Re-exports ResponseLike

RestrictedCrawlingContext

Re-exports RestrictedCrawlingContext

RetryRequestError

Re-exports RetryRequestError

RouteOptions

Re-exports RouteOptions

Router

Re-exports Router

RouterHandler

Re-exports RouterHandler

RouterHandlerContext

Re-exports RouterHandlerContext

RouterLabel

Re-exports RouterLabel

RouterRoutes

Re-exports RouterRoutes

RouteSchemas

Re-exports RouteSchemas

RoutesFromSchemas

Re-exports RoutesFromSchemas

SchemaIssue

Re-exports SchemaIssue

serializeValue

Re-exports serializeValue

ServiceConflictError

Re-exports ServiceConflictError

serviceLocator

Re-exports serviceLocator

ServiceLocator

Re-exports ServiceLocator

Session

Re-exports Session

SessionError

Re-exports SessionError

SessionOptions

Re-exports SessionOptions

SessionPool

Re-exports SessionPool

SessionPoolOptions

Re-exports SessionPoolOptions

SessionReuseStrategy

Re-exports SessionReuseStrategy

SitemapRequestLoader

Re-exports SitemapRequestLoader

SitemapRequestLoaderOptions

Re-exports SitemapRequestLoaderOptions

SkippedRequestCallback

Re-exports SkippedRequestCallback

SkippedRequestReason

Re-exports SkippedRequestReason

SnapshotResult

Re-exports SnapshotResult

SnapshotStore

Re-exports SnapshotStore

Source

Re-exports Source

StateConversion

Re-exports StateConversion

StateValidationError

Re-exports StateValidationError

StatisticPersistedState

Re-exports StatisticPersistedState

Statistics

Re-exports Statistics

StatisticsOptions

Re-exports StatisticsOptions

StatisticState

Re-exports StatisticState

StatisticStateExtensionOptions

Re-exports StatisticStateExtensionOptions

StatusMessageCallback

Re-exports StatusMessageCallback

StatusMessageCallbackParams

Re-exports StatusMessageCallbackParams

StorageBackend

Re-exports StorageBackend

StorageBackendLoadSignal

Re-exports StorageBackendLoadSignal

StorageBackendLoadSignalOptions

Re-exports StorageBackendLoadSignalOptions

StorageIdentifier

Re-exports StorageIdentifier

StorageInstanceManager

Re-exports StorageInstanceManager

StorageOpenOptions

Re-exports StorageOpenOptions

StorageStatsTracker

Re-exports StorageStatsTracker

StorageTransaction

Re-exports StorageTransaction

StorageTransactionOptions

Re-exports StorageTransactionOptions

StorageTransactionState

Re-exports StorageTransactionState

StorageTransactionView

Re-exports StorageTransactionView

StorageWriteMode

Re-exports StorageWriteMode

StorageWritePolicy

Re-exports StorageWritePolicy

SyncStateConversion

Re-exports SyncStateConversion

SystemInfo

Re-exports SystemInfo

TaskLoopOptions

Re-exports TaskLoopOptions

TaskLoopPredicates

Re-exports TaskLoopPredicates

ThrottlingRequestManager

Re-exports ThrottlingRequestManager

ThrottlingRequestManagerOptions

Re-exports ThrottlingRequestManagerOptions

TypedContextAddRequests

Re-exports TypedContextAddRequests

TypedContextEnqueueLinks

Re-exports TypedContextEnqueueLinks

UrlPatternInput

Re-exports UrlPatternInput

UrlPatternObject

Re-exports UrlPatternObject

useState

Re-exports useState

UseStateOptions

Re-exports UseStateOptions

withDirectStorageAccess

Re-exports withDirectStorageAccess

WithRequired

Re-exports WithRequired

withStorageTransaction

Re-exports withStorageTransaction

externalAgentConfig

AgentConfig: { cua?: boolean; executionModel?: string | AgentModelConfig<string>; integrations?: (Client | string)[]; mode?: AgentToolMode; model?: string | AgentModelConfig<string>; stream?: boolean; systemPrompt?: string; tools?: ToolSet }

Type declaration

externaloptionalcua?: boolean
Deprecated - Use mode: "cua" instead. This option will be removed in a future version. Enables Computer Use Agent (CUA) mode.
externaloptionalexecutionModel?: string | AgentModelConfig<string>
The model to use for tool execution (observe/act calls within agent tools). If not specified, inherits from the main model configuration. Format: "provider/model" (e.g., "openai/gpt-4o-mini", "google/gemini-2.0-flash-exp")
externaloptionalintegrations?: (Client | string)[]
MCP integrations - Array of Client objects
externaloptionalmode?: AgentToolMode
Tool mode for the agent. Determines which set of tools are available.
- 'dom' (default): Uses DOM-based tools (act, fillForm) for structured interactions
- 'hybrid': Uses coordinate-based tools (click, type, dragAndDrop, clickAndHold, fillFormVision) for visual/screenshot-based interactions
- 'cua': Uses Computer Use Agent (CUA) providers for screenshot-based automation
externaloptionalmodel?: string | AgentModelConfig<string>
The model to use for agent functionality
externaloptionalstream?: boolean
Enable streaming mode for the agent. When true, execute() returns AgentStreamResult with textStream for incremental output. When false (default), execute() returns AgentResult after completion.
externaloptionalsystemPrompt?: string
Custom system prompt to provide to the agent. Overrides the default system prompt.
externaloptionaltools?: ToolSet
Tools passed to the agent client

externalModelConfiguration

ModelConfiguration: AvailableModel | (ClientOptions & { modelName: AvailableModel })

StagehandBrowserPool

StagehandBrowserPool: BrowserPool<{ browserPlugins: [StagehandPlugin] }, [StagehandPlugin]>

A BrowserPool of Stagehand browsers, as built by stagehandBrowserPool.

StagehandGotoOptions

StagehandGotoOptions: NonNullable<Parameters<Page[goto]>[1]>

Goto options for StagehandCrawler navigation.

StagehandHook

StagehandHook<UserData>: BrowserHook<StagehandCrawlingContext<UserData>>

Hook function for StagehandCrawler.

Type parameters

UserData: Dictionary = any

API Key Configuration​

Example usage​

Key Features

Index

Browser management

Other

Other

AddRequestsBatchedOptions

AddRequestsBatchedResult

ApifyLogAdapter

ArgumentValidationError

assertBrowserPoolNotConfigured

BaseCrawleeLogger

BasicCrawler

BasicCrawlerOptions

BasicCrawlingContext

BLOCKED_STATUS_CODES

BrowserCrawler

BrowserCrawlerOptions

BrowserCrawlingContext

BrowserHook

BrowserLaunchContext

CalculatedStatistics

coerceBoolean

coerceNumber

ConcurrencyConsumer

ConcurrencySystem

ConcurrencySystemOptions

ConfigField

Configuration

ConfigurationInput

ConfigurationOptions

ContextMiddleware

ContextPipeline

ContextPipelineCleanupError

ContextPipelineInitializationError

ContextPipelineInterruptedError

CpuLoadSignal

CpuLoadSignalOptions

crawleeConfigFields

CrawleeLogger

CrawleeLoggerOptions

CrawlerAddRequestsOptions

CrawlerAddRequestsResult

CrawlerRunOptions

CrawlingContext

createBasicRouter

CreateContextOptions

CreateSession

createStorageTransaction

CriticalError

Dataset

DatasetConsumer

DatasetContent

DatasetDataOptions

DatasetExportOptions

DatasetExportToOptions

DatasetIteratorOptions

DatasetJournalEntry

DatasetMapper

DatasetOptions

DatasetReducer

DatasetStats

defaultRoute

DefaultRouteUserData

DefaultStorageIdentifier

EnqueueLinksOptions

EnqueueStrategy

EnqueueStrategyOption

EnqueueUrlsOptions

ErrnoException

ErrorHandler

ErrorSnapshotter

ErrorTracker

ErrorTrackerOptions

EventLoopLoadSignal

EventLoopLoadSignalOptions

EventManager

EventManagerOptions

EventStatusMessageData

API Key Configuration

Example usage