Add Sync Methods

Author: maticzav

examples/create.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env -S rye run python
+
+from typing import List
+
+from pydantic import BaseModel
+
+from browser_use_sdk import BrowserUse
+
+# gets API Key from environment variable BROWSER_USE_API_KEY
+client = BrowserUse()
+
+# Regular Task
+res = client.tasks.create(
+    task="""
+    Find top 10 Hacker News articles and return the title and url.
+    """
+)
+
+print(res.id)
+
+
+# Structured Output
+class HackerNewsPost(BaseModel):
+    title: str
+    url: str
+
+
+class SearchResult(BaseModel):
+    posts: List[HackerNewsPost]
+
+
+res = client.tasks.create(
+    task="""
+    Find top 10 Hacker News articles and return the title and url.
+    """,
+    structured_output_json=SearchResult,
+)
+
+print(res.id)

examples/retrieve.py

@@ -0,0 +1,64 @@
+#!/usr/bin/env -S rye run python
+
+import time
+from typing import List
+
+from pydantic import BaseModel
+
+from browser_use_sdk import BrowserUse
+
+# gets API Key from environment variable BROWSER_USE_API_KEY
+client = BrowserUse()
+
+# Regular Task
+task = client.tasks.create(
+    task="""
+    Find top 10 Hacker News articles and return the title and url.
+    """
+)
+
+print(f"Task ID: {task.id}")
+
+while True:
+    regular = client.tasks.retrieve(task.id)
+    print(regular.status)
+    if regular.status == "finished":
+        print(regular.done_output)
+        break
+
+    time.sleep(1)
+
+
+# Structured Output
+class HackerNewsPost(BaseModel):
+    title: str
+    url: str
+
+
+class SearchResult(BaseModel):
+    posts: List[HackerNewsPost]
+
+
+structured = client.tasks.create(
+    task="""
+    Find top 10 Hacker News articles and return the title and url.
+    """,
+    structured_output_json=SearchResult,
+)
+
+print(f"Task ID: {structured.id}")
+
+while True:
+    structured = client.tasks.retrieve(task_id=structured.id, structured_output_json=SearchResult)
+    print(structured.status)
+
+    if structured.status == "finished":
+        if structured.parsed_output is None:
+            print("No output")
+        else:
+            for post in structured.parsed_output.posts:
+                print(f" - {post.title} - {post.url}")
+
+        break
+
+    time.sleep(1)

examples/run.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env -S rye run python
+
+from typing import List
+
+from pydantic import BaseModel
+
+from browser_use_sdk import BrowserUse
+
+# gets API Key from environment variable BROWSER_USE_API_KEY
+client = BrowserUse()
+
+# Regular Task
+regular_result = client.tasks.run(
+    task="""
+    Find top 10 Hacker News articles and return the title and url.
+    """
+)
+
+print(f"Task ID: {regular_result.id}")
+
+print(regular_result.done_output)
+
+
+# Structured Output
+class HackerNewsPost(BaseModel):
+    title: str
+    url: str
+
+
+class SearchResult(BaseModel):
+    posts: List[HackerNewsPost]
+
+
+structured_result = client.tasks.run(
+    task="""
+    Find top 10 Hacker News articles and return the title and url.
+    """,
+    structured_output_json=SearchResult,
+)
+
+print(f"Task ID: {structured_result.id}")
+
+if structured_result.parsed_output is not None:
+    for post in structured_result.parsed_output.posts:
+        print(f" - {post.title} - {post.url}")

examples/stream.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env -S rye run python
+
+from typing import List
+
+from pydantic import BaseModel
+
+from browser_use_sdk import BrowserUse
+from browser_use_sdk.types.task_create_params import AgentSettings
+
+# gets API Key from environment variable BROWSER_USE_API_KEY
+client = BrowserUse()
+
+# Regular Task
+regular_task = client.tasks.create(
+    task="""
+    Find top 10 Hacker News articles and return the title and url.
+    """,
+    agent_settings=AgentSettings(llm="gemini-2.5-flash"),
+)
+
+print(f"Task ID: {regular_task.id}")
+
+for res in client.tasks.stream(regular_task.id):
+    print(res.status)
+
+    if len(res.steps) > 0:
+        last_step = res.steps[-1]
+        print(f"{last_step.url} ({last_step.next_goal})")
+        for action in last_step.actions:
+            print(f" - {action}")
+
+
+# Structured Output
+class HackerNewsPost(BaseModel):
+    title: str
+    url: str
+
+
+class SearchResult(BaseModel):
+    posts: List[HackerNewsPost]
+
+
+structured_task = client.tasks.create(
+    task="""
+    Find top 10 Hacker News articles and return the title and url.
+    """,
+    structured_output_json=SearchResult,
+)
+
+print(f"Task ID: {structured_task.id}")
+
+for res in client.tasks.stream(structured_task.id, structured_output_json=SearchResult):
+    print(res.status)
+
+    if res.status == "finished":
+        if res.parsed_output is None:
+            print("No output")
+        else:
+            for post in res.parsed_output.posts:
+                print(f" - {post.title} - {post.url}")
+        break

src/browser_use/lib/.keep

@@ -0,0 +1,15 @@
+from typing import Union, Generic, TypeVar
+
+from pydantic import BaseModel
+
+from browser_use_sdk.types.task_view import TaskView
+
+T = TypeVar("T", bound=BaseModel)
+
+
+class TaskViewWithOutput(TaskView, Generic[T]):
+    """
+    TaskView with structured output.
+    """
+
+    parsed_output: Union[T, None]