All Parameters (0.x) - Browser Use

This page is for browser-use 0.x. Current docs: Introduction. Upgrading: Migrating to 1.0. To stay on 0.x, pin it: pip install 'browser-use<1'.

@sandbox is removed in browser-use 1.0. In 1.0, run the agent anywhere with a cloud browser (Browser(), the default; see Browsers), or have Browser Use host the whole agent with the Cloud API.

Reference

Parameter	Type	Description	Default
`BROWSER_USE_API_KEY`	`str`	API key (or env var)	Required
`cloud_profile_id`	`str`	Browser profile UUID	`None`
`cloud_proxy_country_code`	`str`	us, uk, fr, it, jp, au, de, fi, ca, in	`None`
`cloud_timeout`	`int`	Minutes (max: 15 free, 240 paid)	`None`
`on_browser_created`	`Callable`	Live URL callback	`None`
`on_log`	`Callable`	Log event callback	`None`
`on_result`	`Callable`	Success callback	`None`
`on_error`	`Callable`	Error callback	`None`

Example

@sandbox(
    cloud_profile_id='550e8400-e29b-41d4-a716-446655440000',
    cloud_proxy_country_code='us',
    cloud_timeout=60,
    on_browser_created=lambda data: print(f'Live: {data.live_url}'),
)
async def task(browser: Browser):
    agent = Agent(task="your task", browser=browser, llm=ChatBrowserUse())
    await agent.run()

⌘I