feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 22
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browser-use%2Fbrowser-use-86040fd18419e7b4e0947660d9c0ff1abe21550528d2d2a549736cd16f85a92d.yml
-openapi_spec_hash: 7c5de9d0f633db35fd9e250fcc834d1f
+configured_endpoints: 21
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browser-use%2Fbrowser-use-9ff5409663c58ae9e3ecc9ac764956189e3a70600f5ba1b961bb1dedf0208271.yml
+openapi_spec_hash: 9865acb75430d9b799502acbae860df0
 config_hash: 99e0e445bc20c5723030c315bab52940

README.md

@@ -25,33 +25,26 @@ pip install browser-use-sdk
 The full API of this library can be found in [api.md](api.md).
 
 ```python
-import os
 from browser_use_sdk import BrowserUse
 
 client = BrowserUse(
-    api_key=os.environ.get("BROWSER_USE_API_KEY"),  # This is the default and can be omitted
+    api_key="My API Key",
 )
 
 tasks = client.tasks.list()
 print(tasks.items)
 ```
 
-While you can provide an `api_key` keyword argument,
-we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-to add `BROWSER_USE_API_KEY="My API Key"` to your `.env` file
-so that your API Key is not stored in source control.
-
 ## Async usage
 
 Simply import `AsyncBrowserUse` instead of `BrowserUse` and use `await` with each API call:
 
 ```python
-import os
 import asyncio
 from browser_use_sdk import AsyncBrowserUse
 
 client = AsyncBrowserUse(
-    api_key=os.environ.get("BROWSER_USE_API_KEY"),  # This is the default and can be omitted
+    api_key="My API Key",
 )
 
 
@@ -112,7 +105,9 @@ Nested parameters are dictionaries, typed using `TypedDict`, for example:
 ```python
 from browser_use_sdk import BrowserUse
 
-client = BrowserUse()
+client = BrowserUse(
+    api_key="My API Key",
+)
 
 task_view = client.tasks.create(
     task="x",
@@ -134,7 +129,9 @@ All errors inherit from `browser_use_sdk.APIError`.
 import browser_use_sdk
 from browser_use_sdk import BrowserUse
 
-client = BrowserUse()
+client = BrowserUse(
+    api_key="My API Key",
+)
 
 try:
     client.tasks.list()
@@ -175,6 +172,7 @@ from browser_use_sdk import BrowserUse
 
 # Configure the default for all requests:
 client = BrowserUse(
+    api_key="My API Key",
     # default is 2
     max_retries=0,
 )
@@ -193,12 +191,14 @@ from browser_use_sdk import BrowserUse
 
 # Configure the default for all requests:
 client = BrowserUse(
+    api_key="My API Key",
     # 20 seconds (default is 1 minute)
     timeout=20.0,
 )
 
 # More granular control:
 client = BrowserUse(
+    api_key="My API Key",
     timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
 )
 
@@ -243,7 +243,9 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 ```py
 from browser_use_sdk import BrowserUse
 
-client = BrowserUse()
+client = BrowserUse(
+    api_key="My API Key",
+)
 response = client.tasks.with_raw_response.list()
 print(response.headers.get('X-My-Header'))
 
@@ -318,6 +320,7 @@ import httpx
 from browser_use_sdk import BrowserUse, DefaultHttpxClient
 
 client = BrowserUse(
+    api_key="My API Key",
     # Or use the `BROWSER_USE_BASE_URL` env var
     base_url="http://my.test.server.example.com:8083",
     http_client=DefaultHttpxClient(
@@ -340,7 +343,9 @@ By default the library closes underlying HTTP connections whenever the client is
 ```py
 from browser_use_sdk import BrowserUse
 
-with BrowserUse() as client:
+with BrowserUse(
+    api_key="My API Key",
+) as client:
   # make requests here
   ...
 

api.md

@@ -7,21 +7,18 @@ from browser_use_sdk.types import (
     LlmModel,
     TaskStatus,
     TaskView,
-    TaskRetrieveResponse,
     TaskListResponse,
     TaskRetrieveLogsResponse,
-    TaskRetrieveOutputFileResponse,
 )
 ```
 
 Methods:
 
 - <code title="post /tasks">client.tasks.<a href="./src/browser_use_sdk/resources/tasks.py">create</a>(\*\*<a href="src/browser_use_sdk/types/task_create_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/task_view.py">TaskView</a></code>
-- <code title="get /tasks/{task_id}">client.tasks.<a href="./src/browser_use_sdk/resources/tasks.py">retrieve</a>(task_id, \*\*<a href="src/browser_use_sdk/types/task_retrieve_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/task_retrieve_response.py">TaskRetrieveResponse</a></code>
+- <code title="get /tasks/{task_id}">client.tasks.<a href="./src/browser_use_sdk/resources/tasks.py">retrieve</a>(task_id) -> <a href="./src/browser_use_sdk/types/task_view.py">TaskView</a></code>
 - <code title="patch /tasks/{task_id}">client.tasks.<a href="./src/browser_use_sdk/resources/tasks.py">update</a>(task_id, \*\*<a href="src/browser_use_sdk/types/task_update_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/task_view.py">TaskView</a></code>
 - <code title="get /tasks">client.tasks.<a href="./src/browser_use_sdk/resources/tasks.py">list</a>(\*\*<a href="src/browser_use_sdk/types/task_list_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/task_list_response.py">TaskListResponse</a></code>
 - <code title="get /tasks/{task_id}/logs">client.tasks.<a href="./src/browser_use_sdk/resources/tasks.py">retrieve_logs</a>(task_id) -> <a href="./src/browser_use_sdk/types/task_retrieve_logs_response.py">TaskRetrieveLogsResponse</a></code>
-- <code title="get /tasks/{task_id}/output-files/{file_name}">client.tasks.<a href="./src/browser_use_sdk/resources/tasks.py">retrieve_output_file</a>(file_name, \*, task_id) -> <a href="./src/browser_use_sdk/types/task_retrieve_output_file_response.py">TaskRetrieveOutputFileResponse</a></code>
 
 # Sessions
 
@@ -49,7 +46,7 @@ Methods:
 
 - <code title="post /sessions/{session_id}/public-share">client.sessions.public_share.<a href="./src/browser_use_sdk/resources/sessions/public_share.py">create</a>(session_id) -> <a href="./src/browser_use_sdk/types/sessions/share_view.py">ShareView</a></code>
 - <code title="get /sessions/{session_id}/public-share">client.sessions.public_share.<a href="./src/browser_use_sdk/resources/sessions/public_share.py">retrieve</a>(session_id) -> <a href="./src/browser_use_sdk/types/sessions/share_view.py">ShareView</a></code>
-- <code title="delete /sessions/{session_id}/public-share">client.sessions.public_share.<a href="./src/browser_use_sdk/resources/sessions/public_share.py">delete</a>(session_id) -> object</code>
+- <code title="delete /sessions/{session_id}/public-share">client.sessions.public_share.<a href="./src/browser_use_sdk/resources/sessions/public_share.py">delete</a>(session_id) -> None</code>
 
 # BrowserProfiles
 
@@ -65,7 +62,7 @@ Methods:
 - <code title="get /browser-profiles/{profile_id}">client.browser_profiles.<a href="./src/browser_use_sdk/resources/browser_profiles.py">retrieve</a>(profile_id) -> <a href="./src/browser_use_sdk/types/browser_profile_view.py">BrowserProfileView</a></code>
 - <code title="patch /browser-profiles/{profile_id}">client.browser_profiles.<a href="./src/browser_use_sdk/resources/browser_profiles.py">update</a>(profile_id, \*\*<a href="src/browser_use_sdk/types/browser_profile_update_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/browser_profile_view.py">BrowserProfileView</a></code>
 - <code title="get /browser-profiles">client.browser_profiles.<a href="./src/browser_use_sdk/resources/browser_profiles.py">list</a>(\*\*<a href="src/browser_use_sdk/types/browser_profile_list_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/browser_profile_list_response.py">BrowserProfileListResponse</a></code>
-- <code title="delete /browser-profiles/{profile_id}">client.browser_profiles.<a href="./src/browser_use_sdk/resources/browser_profiles.py">delete</a>(profile_id) -> object</code>
+- <code title="delete /browser-profiles/{profile_id}">client.browser_profiles.<a href="./src/browser_use_sdk/resources/browser_profiles.py">delete</a>(profile_id) -> None</code>
 
 # AgentProfiles
 
@@ -81,4 +78,4 @@ Methods:
 - <code title="get /agent-profiles/{profile_id}">client.agent_profiles.<a href="./src/browser_use_sdk/resources/agent_profiles.py">retrieve</a>(profile_id) -> <a href="./src/browser_use_sdk/types/agent_profile_view.py">AgentProfileView</a></code>
 - <code title="patch /agent-profiles/{profile_id}">client.agent_profiles.<a href="./src/browser_use_sdk/resources/agent_profiles.py">update</a>(profile_id, \*\*<a href="src/browser_use_sdk/types/agent_profile_update_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/agent_profile_view.py">AgentProfileView</a></code>
 - <code title="get /agent-profiles">client.agent_profiles.<a href="./src/browser_use_sdk/resources/agent_profiles.py">list</a>(\*\*<a href="src/browser_use_sdk/types/agent_profile_list_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/agent_profile_list_response.py">AgentProfileListResponse</a></code>
-- <code title="delete /agent-profiles/{profile_id}">client.agent_profiles.<a href="./src/browser_use_sdk/resources/agent_profiles.py">delete</a>(profile_id) -> object</code>
+- <code title="delete /agent-profiles/{profile_id}">client.agent_profiles.<a href="./src/browser_use_sdk/resources/agent_profiles.py">delete</a>(profile_id) -> None</code>

src/browser_use_sdk/_client.py

@@ -117,12 +117,6 @@ def __init__(
     def qs(self) -> Querystring:
         return Querystring(array_format="comma")
 
-    @property
-    @override
-    def auth_headers(self) -> dict[str, str]:
-        api_key = self.api_key
-        return {"X-Browser-Use-API-Key": api_key}
-
     @property
     @override
     def default_headers(self) -> dict[str, str | Omit]:
@@ -291,12 +285,6 @@ def __init__(
     def qs(self) -> Querystring:
         return Querystring(array_format="comma")
 
-    @property
-    @override
-    def auth_headers(self) -> dict[str, str]:
-        api_key = self.api_key
-        return {"X-Browser-Use-API-Key": api_key}
-
     @property
     @override
     def default_headers(self) -> dict[str, str | Omit]: