Open-source Python library for AI browser agents, plus Browser Use Cloud: stealth browsers and a hosted agent API.
Python ai-agentsai-toolsbrowser-agentbrowser-automationbrowser-usecdpcloud-browsercomputer-useheadless-browserllmmcpplaywrightpythonremote-browserstealth-browserweb-automationweb-scraping
changed browser use api key creation url everywhere
Gregor Žuniča3c6fd8025b8
diff --git a/.env.example b/.env.exampleindex cf72fdec3..1cf94279d 100644--- a/.env.example+++ b/.env.example@@ -20,7 +20,7 @@ CDP_LOGGING_LEVEL=WARNINGANONYMIZED_TELEMETRY=true# Browser Use Cloud Configuration-# Get your API key from: https://cloud.browser-use.com/dashboard/api+# Get your API key from: https://cloud.browser-use.com/new-api-keyBROWSER_USE_API_KEY=your_bu_api_key_here# Custom API base URL (for enterprise installations)diff --git a/README.md b/README.mdindex 9a2e9d9ba..941ec10c6 100644--- a/README.md+++ b/README.md@@ -57,7 +57,7 @@ uv add browser-useuv sync```-**3. Get your API key from [Browser Use Cloud](https://cloud.browser-use.com/dashboard/api) and add it to your `.env` file (new signups get $10 free credits):**+**3. Get your API key from [Browser Use Cloud](https://cloud.browser-use.com/new-api-key) and add it to your `.env` file (new signups get $10 free credits):**```# .envBROWSER_USE_API_KEY=your-keydiff --git a/browser_use/browser/cloud.py b/browser_use/browser/cloud.pyindex b5d66998f..af178f77d 100644--- a/browser_use/browser/cloud.py+++ b/browser_use/browser/cloud.py@@ -73,7 +73,7 @@ class CloudBrowserClient:if not api_token:raise CloudBrowserAuthError(- 'No authentication token found. Please set BROWSER_USE_API_KEY environment variable to authenticate with the cloud service. You can also create an API key at https://cloud.browser-use.com'+ 'No authentication token found. Please set BROWSER_USE_API_KEY environment variable to authenticate with the cloud service. You can also create an API key at https://cloud.browser-use.com/new-api-key')headers = {'X-Browser-Use-API-Key': api_token, 'Content-Type': 'application/json'}@@ -88,7 +88,7 @@ class CloudBrowserClient:if response.status_code == 401:raise CloudBrowserAuthError(- 'Authentication failed. Please make sure you have set BROWSER_USE_API_KEY environment variable to authenticate with the cloud service. You can also create an API key at https://cloud.browser-use.com'+ 'Authentication failed. Please make sure you have set BROWSER_USE_API_KEY environment variable to authenticate with the cloud service. You can also create an API key at https://cloud.browser-use.com/new-api-key')elif response.status_code == 403:raise CloudBrowserAuthError('Access forbidden. Please check your browser-use cloud subscription status.')@@ -158,7 +158,7 @@ class CloudBrowserClient:if not api_token:raise CloudBrowserAuthError(- 'No authentication token found. Please set BROWSER_USE_API_KEY environment variable to authenticate with the cloud service. You can also create an API key at https://cloud.browser-use.com'+ 'No authentication token found. Please set BROWSER_USE_API_KEY environment variable to authenticate with the cloud service. You can also create an API key at https://cloud.browser-use.com/new-api-key')headers = {'X-Browser-Use-API-Key': api_token, 'Content-Type': 'application/json'}diff --git a/browser_use/browser/session.py b/browser_use/browser/session.pyindex dc1561b20..32ed4aa64 100644--- a/browser_use/browser/session.py+++ b/browser_use/browser/session.py@@ -522,7 +522,7 @@ class BrowserSession(BaseModel):self.logger.info('🌤️ Successfully connected to cloud browser service')except CloudBrowserAuthError:raise CloudBrowserAuthError(- 'Authentication failed for cloud browser service. Set BROWSER_USE_API_KEY environment variable. You can also create an API key at https://cloud.browser-use.com'+ 'Authentication failed for cloud browser service. Set BROWSER_USE_API_KEY environment variable. You can also create an API key at https://cloud.browser-use.com/new-api-key')except CloudBrowserError as e:raise CloudBrowserError(f'Failed to create cloud browser: {e}')diff --git a/browser_use/llm/browser_use/chat.py b/browser_use/llm/browser_use/chat.pyindex d535a0017..74ae68f3e 100644--- a/browser_use/llm/browser_use/chat.py+++ b/browser_use/llm/browser_use/chat.py@@ -67,7 +67,7 @@ class ChatBrowserUse(BaseChatModel):if not self.api_key:raise ValueError('You need to set the BROWSER_USE_API_KEY environment variable. '- 'Get your key at https://cloud.browser-use.com/dashboard/api'+ 'Get your key at https://cloud.browser-use.com/new-api-key')@propertydiff --git a/docs/customize/browser/remote.mdx b/docs/customize/browser/remote.mdxindex a1989fa36..bf4922134 100644--- a/docs/customize/browser/remote.mdx+++ b/docs/customize/browser/remote.mdx@@ -27,7 +27,7 @@ agent = Agent(```**Prerequisites:**-1. Get an API key from [cloud.browser-use.com](https://cloud.browser-use.com)+1. Get an API key from [cloud.browser-use.com](https://cloud.browser-use.com/new-api-key)2. Set BROWSER_USE_API_KEY environment variable**Benefits:**diff --git a/docs/development/n8n-integration.mdx b/docs/development/n8n-integration.mdxindex 70e165792..d89c7b26c 100644--- a/docs/development/n8n-integration.mdx+++ b/docs/development/n8n-integration.mdx@@ -57,7 +57,7 @@ If you want to develop with the n8n node:To use the Browser Use node in n8n, you need to configure API credentials:-1. Sign up for an account at [Browser Use Cloud](https://cloud.browser-use.com)+1. Sign up for an account at [Browser Use Cloud](https://cloud.browser-use.com/new-api-key)2. Navigate to the Settings or API section3. Generate or copy your API key4. In n8n, create a new credential:diff --git a/docs/quickstart.mdx b/docs/quickstart.mdxindex 03a82f3a2..2103d4e4f 100644--- a/docs/quickstart.mdx+++ b/docs/quickstart.mdx@@ -7,7 +7,7 @@ icon: "rocket"To get started with Browser Use you need to install the package and create an `.env` file with your API key.<Note icon="key" color="#FFC107" iconType="regular">-`ChatBrowserUse` offers the [fastest and most cost-effective models](https://browser-use.com/posts/speed-matters/), completing tasks 3-5x faster. Get started with $10 of [free LLM credits](https://cloud.browser-use.com/dashboard/api).+`ChatBrowserUse` offers the [fastest and most cost-effective models](https://browser-use.com/posts/speed-matters/), completing tasks 3-5x faster. Get started with $10 of [free LLM credits](https://cloud.browser-use.com/new-api-key).</Note>## 1. Installing Browser-Use@@ -46,7 +46,7 @@ pip install playwright && playwright install chromium --with-depsCreate a `.env` file and add your API key.<Callout icon="key" iconType="regular">-We recommend using ChatBrowserUse which is optimized for browser automation tasks (highest accuracy + fastest speed + lowest token cost). Don't have one? We give you **$10** to try it out [here](https://cloud.browser-use.com/dashboard/api).+We recommend using ChatBrowserUse which is optimized for browser automation tasks (highest accuracy + fastest speed + lowest token cost). Don't have one? We give you **$10** to try it out [here](https://cloud.browser-use.com/new-api-key).</Callout>```bash .env@@ -61,7 +61,7 @@ Then add your API key to the file.```bash Browser Use# add your key to .env fileBROWSER_USE_API_KEY=-# Get 10$ of free credits at https://cloud.browser-use.com/dashboard/api+# Get 10$ of free credits at https://cloud.browser-use.com/new-api-key``````bash Google# add your key to .env filediff --git a/docs/supported-models.mdx b/docs/supported-models.mdxindex d2161e714..801673a0b 100644--- a/docs/supported-models.mdx+++ b/docs/supported-models.mdx@@ -28,7 +28,7 @@ Required environment variables:BROWSER_USE_API_KEY=```-Get your API key from the [Browser Use Cloud](https://cloud.browser-use.com/dashboard/api). New signups get \$10 free credit via OAuth or \$1 via email.+Get your API key from the [Browser Use Cloud](https://cloud.browser-use.com/new-api-key). New signups get \$10 free credit via OAuth or \$1 via email.### Google Gemini [example](https://github.com/browser-use/browser-use/blob/main/examples/models/gemini.py)diff --git a/examples/browser/cloud_browser.py b/examples/browser/cloud_browser.pyindex 342bf33e4..247407002 100644--- a/examples/browser/cloud_browser.py+++ b/examples/browser/cloud_browser.py@@ -35,7 +35,7 @@ async def main():print(f'❌ Error: {e}')if 'Authentication' in str(e):print(- '💡 Set BROWSER_USE_API_KEY environment variable. You can also create an API key at https://cloud.browser-use.com'+ '💡 Set BROWSER_USE_API_KEY environment variable. You can also create an API key at https://cloud.browser-use.com/new-api-key')diff --git a/examples/cloud/01_basic_task.py b/examples/cloud/01_basic_task.pyindex 14af3262e..54b8ea561 100644--- a/examples/cloud/01_basic_task.py+++ b/examples/cloud/01_basic_task.py@@ -24,7 +24,7 @@ from requests.exceptions import RequestExceptionAPI_KEY = os.getenv('BROWSER_USE_API_KEY')if not API_KEY:raise ValueError(- 'Please set BROWSER_USE_API_KEY environment variable. You can also create an API key at https://cloud.browser-use.com'+ 'Please set BROWSER_USE_API_KEY environment variable. You can also create an API key at https://cloud.browser-use.com/new-api-key')BASE_URL = os.getenv('BROWSER_USE_BASE_URL', 'https://api.browser-use.com/api/v1')diff --git a/examples/cloud/02_fast_mode_gemini.py b/examples/cloud/02_fast_mode_gemini.pyindex 075bdd7d6..245da5c20 100644--- a/examples/cloud/02_fast_mode_gemini.py+++ b/examples/cloud/02_fast_mode_gemini.py@@ -28,7 +28,7 @@ from requests.exceptions import RequestExceptionAPI_KEY = os.getenv('BROWSER_USE_API_KEY')if not API_KEY:raise ValueError(- 'Please set BROWSER_USE_API_KEY environment variable. You can also create an API key at https://cloud.browser-use.com'+ 'Please set BROWSER_USE_API_KEY environment variable. You can also create an API key at https://cloud.browser-use.com/new-api-key')BASE_URL = os.getenv('BROWSER_USE_BASE_URL', 'https://api.browser-use.com/api/v1')diff --git a/examples/cloud/03_structured_output.py b/examples/cloud/03_structured_output.pyindex 560d5ec49..cbe73ac11 100644--- a/examples/cloud/03_structured_output.py+++ b/examples/cloud/03_structured_output.py@@ -27,7 +27,7 @@ from requests.exceptions import RequestExceptionAPI_KEY = os.getenv('BROWSER_USE_API_KEY')if not API_KEY:raise ValueError(- 'Please set BROWSER_USE_API_KEY environment variable. You can also create an API key at https://cloud.browser-use.com'+ 'Please set BROWSER_USE_API_KEY environment variable. You can also create an API key at https://cloud.browser-use.com/new-api-key')BASE_URL = os.getenv('BROWSER_USE_BASE_URL', 'https://api.browser-use.com/api/v1')diff --git a/examples/cloud/04_proxy_usage.py b/examples/cloud/04_proxy_usage.pyindex f3771ca81..71dca7975 100644--- a/examples/cloud/04_proxy_usage.py+++ b/examples/cloud/04_proxy_usage.py@@ -26,7 +26,7 @@ from requests.exceptions import RequestExceptionAPI_KEY = os.getenv('BROWSER_USE_API_KEY')if not API_KEY:raise ValueError(- 'Please set BROWSER_USE_API_KEY environment variable. You can also create an API key at https://cloud.browser-use.com'+ 'Please set BROWSER_USE_API_KEY environment variable. You can also create an API key at https://cloud.browser-use.com/new-api-key')BASE_URL = os.getenv('BROWSER_USE_BASE_URL', 'https://api.browser-use.com/api/v1')diff --git a/examples/cloud/05_search_api.py b/examples/cloud/05_search_api.pyindex f3b12f54a..64c01dc04 100644--- a/examples/cloud/05_search_api.py+++ b/examples/cloud/05_search_api.py@@ -24,7 +24,7 @@ import aiohttpAPI_KEY = os.getenv('BROWSER_USE_API_KEY')if not API_KEY:raise ValueError(- 'Please set BROWSER_USE_API_KEY environment variable. You can also create an API key at https://cloud.browser-use.com'+ 'Please set BROWSER_USE_API_KEY environment variable. You can also create an API key at https://cloud.browser-use.com/new-api-key')BASE_URL = os.getenv('BROWSER_USE_BASE_URL', 'https://api.browser-use.com/api/v1')diff --git a/examples/cloud/README.md b/examples/cloud/README.mdindex df0cda940..e2aba21d0 100644--- a/examples/cloud/README.md+++ b/examples/cloud/README.md@@ -4,7 +4,7 @@ Welcome to the Browser Use Cloud examples! This folder contains progressively co## 📋 Prerequisites-1. **API Key**: Get your API key from [cloud.browser-use.com/dashboard/api](https://cloud.browser-use.com/dashboard/api)+1. **API Key**: Get your API key from [cloud.browser-use.com](https://cloud.browser-use.com/new-api-key)2. **Python Environment**: Python 3.11+ with dependencies3. **Environment Variables**: Configure your API settingsdiff --git a/examples/cloud/env.example b/examples/cloud/env.exampleindex d205cd38e..3fbbcda19 100644--- a/examples/cloud/env.example+++ b/examples/cloud/env.example@@ -2,7 +2,7 @@# Copy this file to .env and fill in your values# Required: Your Browser Use Cloud API key-# Get it from: https://cloud.browser-use.com/dashboard/api+# Get it from: https://cloud.browser-use.com/new-api-keyBROWSER_USE_API_KEY=your_api_key_here# Optional: Custom API base URL (for enterprise installations)diff --git a/examples/getting_started/01_basic_search.py b/examples/getting_started/01_basic_search.pyindex 031674281..c82451093 100644--- a/examples/getting_started/01_basic_search.py+++ b/examples/getting_started/01_basic_search.py@@ -1,6 +1,6 @@"""Setup:-1. Get your API key from https://cloud.browser-use.com/dashboard/api+1. Get your API key from https://cloud.browser-use.com/new-api-key2. Set environment variable: export BROWSER_USE_API_KEY="your-key""""diff --git a/examples/getting_started/02_form_filling.py b/examples/getting_started/02_form_filling.pyindex 67ae8b5c6..c83909ad8 100644--- a/examples/getting_started/02_form_filling.py+++ b/examples/getting_started/02_form_filling.py@@ -10,7 +10,7 @@ This example demonstrates how to:This builds on the basic search example by showing more complex interactions.Setup:-1. Get your API key from https://cloud.browser-use.com/dashboard/api+1. Get your API key from https://cloud.browser-use.com/new-api-key2. Set environment variable: export BROWSER_USE_API_KEY="your-key""""diff --git a/examples/getting_started/03_data_extraction.py b/examples/getting_started/03_data_extraction.pyindex ecec70c89..28e913776 100644--- a/examples/getting_started/03_data_extraction.py+++ b/examples/getting_started/03_data_extraction.py@@ -10,7 +10,7 @@ This example demonstrates how to:This builds on previous examples by showing how to get valuable data from websites.Setup:-1. Get your API key from https://cloud.browser-use.com/dashboard/api+1. Get your API key from https://cloud.browser-use.com/new-api-key2. Set environment variable: export BROWSER_USE_API_KEY="your-key""""diff --git a/examples/getting_started/04_multi_step_task.py b/examples/getting_started/04_multi_step_task.pyindex 267f532dc..7af10128c 100644--- a/examples/getting_started/04_multi_step_task.py+++ b/examples/getting_started/04_multi_step_task.py@@ -10,7 +10,7 @@ This example demonstrates how to:This is the most advanced getting started example, combining all previous concepts.Setup:-1. Get your API key from https://cloud.browser-use.com/dashboard/api+1. Get your API key from https://cloud.browser-use.com/new-api-key2. Set environment variable: export BROWSER_USE_API_KEY="your-key""""diff --git a/examples/models/browser_use_llm.py b/examples/models/browser_use_llm.pyindex be24cd566..dc1031de1 100644--- a/examples/models/browser_use_llm.py+++ b/examples/models/browser_use_llm.py@@ -2,7 +2,7 @@Example of the fastest + smartest LLM for browser automation.Setup:-1. Get your API key from https://cloud.browser-use.com/dashboard/api+1. Get your API key from https://cloud.browser-use.com/new-api-key2. Set environment variable: export BROWSER_USE_API_KEY="your-key""""diff --git a/examples/simple.py b/examples/simple.pyindex 5bd166b27..4e1b4c6db 100644--- a/examples/simple.py+++ b/examples/simple.py@@ -1,6 +1,6 @@"""Setup:-1. Get your API key from https://cloud.browser-use.com/dashboard/api+1. Get your API key from https://cloud.browser-use.com/new-api-key2. Set environment variable: export BROWSER_USE_API_KEY="your-key""""