feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

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

README.md

@@ -25,32 +25,39 @@ 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="My API Key",
+    api_key=os.environ.get("BROWSER_USE_API_KEY"),  # This is the default and can be omitted
 )
 
-tasks = client.tasks.list()
-print(tasks.items)
+me = client.users.me.retrieve()
+print(me.additional_credits_balance_usd)
 ```
 
+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="My API Key",
+    api_key=os.environ.get("BROWSER_USE_API_KEY"),  # This is the default and can be omitted
 )
 
 
 async def main() -> None:
-    tasks = await client.tasks.list()
-    print(tasks.items)
+    me = await client.users.me.retrieve()
+    print(me.additional_credits_balance_usd)
 
 
 asyncio.run(main())
@@ -82,8 +89,8 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        tasks = await client.tasks.list()
-        print(tasks.items)
+        me = await client.users.me.retrieve()
+        print(me.additional_credits_balance_usd)
 
 
 asyncio.run(main())
@@ -105,9 +112,7 @@ Nested parameters are dictionaries, typed using `TypedDict`, for example:
 ```python
 from browser_use_sdk import BrowserUse
 
-client = BrowserUse(
-    api_key="My API Key",
-)
+client = BrowserUse()
 
 task_view = client.tasks.create(
     task="x",
@@ -129,12 +134,10 @@ All errors inherit from `browser_use_sdk.APIError`.
 import browser_use_sdk
 from browser_use_sdk import BrowserUse
 
-client = BrowserUse(
-    api_key="My API Key",
-)
+client = BrowserUse()
 
 try:
-    client.tasks.list()
+    client.users.me.retrieve()
 except browser_use_sdk.APIConnectionError as e:
     print("The server could not be reached")
     print(e.__cause__)  # an underlying Exception, likely raised within httpx.
@@ -172,13 +175,12 @@ 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,
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).tasks.list()
+client.with_options(max_retries=5).users.me.retrieve()
 ```
 
 ### Timeouts
@@ -191,19 +193,17 @@ 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),
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).tasks.list()
+client.with_options(timeout=5.0).users.me.retrieve()
 ```
 
 On timeout, an `APITimeoutError` is thrown.
@@ -243,14 +243,12 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 ```py
 from browser_use_sdk import BrowserUse
 
-client = BrowserUse(
-    api_key="My API Key",
-)
-response = client.tasks.with_raw_response.list()
+client = BrowserUse()
+response = client.users.me.with_raw_response.retrieve()
 print(response.headers.get('X-My-Header'))
 
-task = response.parse()  # get the object that `tasks.list()` would have returned
-print(task.items)
+me = response.parse()  # get the object that `users.me.retrieve()` would have returned
+print(me.additional_credits_balance_usd)
 ```
 
 These methods return an [`APIResponse`](https://github.com/browser-use/browser-use-python/tree/main/src/browser_use_sdk/_response.py) object.
@@ -264,7 +262,7 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.tasks.with_streaming_response.list() as response:
+with client.users.me.with_streaming_response.retrieve() as response:
     print(response.headers.get("X-My-Header"))
 
     for line in response.iter_lines():
@@ -320,7 +318,6 @@ 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(
@@ -343,9 +340,7 @@ By default the library closes underlying HTTP connections whenever the client is
 ```py
 from browser_use_sdk import BrowserUse
 
-with BrowserUse(
-    api_key="My API Key",
-) as client:
+with BrowserUse() as client:
   # make requests here
   ...
 

api.md

@@ -1,14 +1,45 @@
+# Users
+
+## Me
+
+Types:
+
+```python
+from browser_use_sdk.types.users import MeRetrieveResponse
+```
+
+Methods:
+
+- <code title="get /users/me">client.users.me.<a href="./src/browser_use_sdk/resources/users/me/me.py">retrieve</a>() -> <a href="./src/browser_use_sdk/types/users/me_retrieve_response.py">MeRetrieveResponse</a></code>
+
+### Files
+
+Types:
+
+```python
+from browser_use_sdk.types.users.me import FileCreatePresignedURLResponse
+```
+
+Methods:
+
+- <code title="post /users/me/files/presigned-url">client.users.me.files.<a href="./src/browser_use_sdk/resources/users/me/files.py">create_presigned_url</a>(\*\*<a href="src/browser_use_sdk/types/users/me/file_create_presigned_url_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/users/me/file_create_presigned_url_response.py">FileCreatePresignedURLResponse</a></code>
+
 # Tasks
 
 Types:
 
 ```python
 from browser_use_sdk.types import (
+    FileView,
     LlmModel,
+    TaskItemView,
     TaskStatus,
+    TaskStepView,
     TaskView,
     TaskListResponse,
-    TaskRetrieveLogsResponse,
+    TaskGetLogsResponse,
+    TaskGetOutputFileResponse,
+    TaskGetUserUploadedFileResponse,
 )
 ```
 
@@ -18,7 +49,9 @@ Methods:
 - <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}/logs">client.tasks.<a href="./src/browser_use_sdk/resources/tasks.py">get_logs</a>(task_id) -> <a href="./src/browser_use_sdk/types/task_get_logs_response.py">TaskGetLogsResponse</a></code>
+- <code title="get /tasks/{task_id}/output-files/{file_id}">client.tasks.<a href="./src/browser_use_sdk/resources/tasks.py">get_output_file</a>(file_id, \*, task_id) -> <a href="./src/browser_use_sdk/types/task_get_output_file_response.py">TaskGetOutputFileResponse</a></code>
+- <code title="get /tasks/{task_id}/user-uploaded-files/{file_id}">client.tasks.<a href="./src/browser_use_sdk/resources/tasks.py">get_user_uploaded_file</a>(file_id, \*, task_id) -> <a href="./src/browser_use_sdk/types/task_get_user_uploaded_file_response.py">TaskGetUserUploadedFileResponse</a></code>
 
 # Sessions
 
@@ -33,6 +66,7 @@ Methods:
 - <code title="get /sessions/{session_id}">client.sessions.<a href="./src/browser_use_sdk/resources/sessions/sessions.py">retrieve</a>(session_id, \*\*<a href="src/browser_use_sdk/types/session_retrieve_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/session_view.py">SessionView</a></code>
 - <code title="patch /sessions/{session_id}">client.sessions.<a href="./src/browser_use_sdk/resources/sessions/sessions.py">update</a>(session_id, \*\*<a href="src/browser_use_sdk/types/session_update_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/session_view.py">SessionView</a></code>
 - <code title="get /sessions">client.sessions.<a href="./src/browser_use_sdk/resources/sessions/sessions.py">list</a>(\*\*<a href="src/browser_use_sdk/types/session_list_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/session_list_response.py">SessionListResponse</a></code>
+- <code title="delete /sessions/{session_id}">client.sessions.<a href="./src/browser_use_sdk/resources/sessions/sessions.py">delete</a>(session_id) -> None</code>
 
 ## PublicShare
 

src/browser_use_sdk/_client.py

@@ -29,6 +29,7 @@
     SyncAPIClient,
     AsyncAPIClient,
 )
+from .resources.users import users
 from .resources.sessions import sessions
 
 __all__ = [
@@ -44,6 +45,7 @@
 
 
 class BrowserUse(SyncAPIClient):
+    users: users.UsersResource
     tasks: tasks.TasksResource
     sessions: sessions.SessionsResource
     browser_profiles: browser_profiles.BrowserProfilesResource
@@ -105,6 +107,7 @@ def __init__(
             _strict_response_validation=_strict_response_validation,
         )
 
+        self.users = users.UsersResource(self)
         self.tasks = tasks.TasksResource(self)
         self.sessions = sessions.SessionsResource(self)
         self.browser_profiles = browser_profiles.BrowserProfilesResource(self)
@@ -117,6 +120,12 @@ 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]:
@@ -212,6 +221,7 @@ def _make_status_error(
 
 
 class AsyncBrowserUse(AsyncAPIClient):
+    users: users.AsyncUsersResource
     tasks: tasks.AsyncTasksResource
     sessions: sessions.AsyncSessionsResource
     browser_profiles: browser_profiles.AsyncBrowserProfilesResource
@@ -273,6 +283,7 @@ def __init__(
             _strict_response_validation=_strict_response_validation,
         )
 
+        self.users = users.AsyncUsersResource(self)
         self.tasks = tasks.AsyncTasksResource(self)
         self.sessions = sessions.AsyncSessionsResource(self)
         self.browser_profiles = browser_profiles.AsyncBrowserProfilesResource(self)
@@ -285,6 +296,12 @@ 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]:
@@ -381,6 +398,7 @@ def _make_status_error(
 
 class BrowserUseWithRawResponse:
     def __init__(self, client: BrowserUse) -> None:
+        self.users = users.UsersResourceWithRawResponse(client.users)
         self.tasks = tasks.TasksResourceWithRawResponse(client.tasks)
         self.sessions = sessions.SessionsResourceWithRawResponse(client.sessions)
         self.browser_profiles = browser_profiles.BrowserProfilesResourceWithRawResponse(client.browser_profiles)
@@ -389,6 +407,7 @@ def __init__(self, client: BrowserUse) -> None:
 
 class AsyncBrowserUseWithRawResponse:
     def __init__(self, client: AsyncBrowserUse) -> None:
+        self.users = users.AsyncUsersResourceWithRawResponse(client.users)
         self.tasks = tasks.AsyncTasksResourceWithRawResponse(client.tasks)
         self.sessions = sessions.AsyncSessionsResourceWithRawResponse(client.sessions)
         self.browser_profiles = browser_profiles.AsyncBrowserProfilesResourceWithRawResponse(client.browser_profiles)
@@ -397,6 +416,7 @@ def __init__(self, client: AsyncBrowserUse) -> None:
 
 class BrowserUseWithStreamedResponse:
     def __init__(self, client: BrowserUse) -> None:
+        self.users = users.UsersResourceWithStreamingResponse(client.users)
         self.tasks = tasks.TasksResourceWithStreamingResponse(client.tasks)
         self.sessions = sessions.SessionsResourceWithStreamingResponse(client.sessions)
         self.browser_profiles = browser_profiles.BrowserProfilesResourceWithStreamingResponse(client.browser_profiles)
@@ -405,6 +425,7 @@ def __init__(self, client: BrowserUse) -> None:
 
 class AsyncBrowserUseWithStreamedResponse:
     def __init__(self, client: AsyncBrowserUse) -> None:
+        self.users = users.AsyncUsersResourceWithStreamingResponse(client.users)
         self.tasks = tasks.AsyncTasksResourceWithStreamingResponse(client.tasks)
         self.sessions = sessions.AsyncSessionsResourceWithStreamingResponse(client.sessions)
         self.browser_profiles = browser_profiles.AsyncBrowserProfilesResourceWithStreamingResponse(

src/browser_use_sdk/resources/__init__.py

@@ -8,6 +8,14 @@
     TasksResourceWithStreamingResponse,
     AsyncTasksResourceWithStreamingResponse,
 )
+from .users import (
+    UsersResource,
+    AsyncUsersResource,
+    UsersResourceWithRawResponse,
+    AsyncUsersResourceWithRawResponse,
+    UsersResourceWithStreamingResponse,
+    AsyncUsersResourceWithStreamingResponse,
+)
 from .sessions import (
     SessionsResource,
     AsyncSessionsResource,
@@ -34,6 +42,12 @@
 )
 
 __all__ = [
+    "UsersResource",
+    "AsyncUsersResource",
+    "UsersResourceWithRawResponse",
+    "AsyncUsersResourceWithRawResponse",
+    "UsersResourceWithStreamingResponse",
+    "AsyncUsersResourceWithStreamingResponse",
     "TasksResource",
     "AsyncTasksResource",
     "TasksResourceWithRawResponse",