Skip to content

Commit dc23fad

Browse files
fern-api[bot]fern-api[bot]
authored
Release 2.0.6
1 parent bf1aa5a commit dc23fad

18 files changed

+1328
-97
lines changed

‎poetry.lock‎

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎reference.md‎

Lines changed: 259 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -753,6 +753,22 @@ client.sessions.create_session()
753753
<dl>
754754
<dd>
755755

756+
**browser_screen_width:** `typing.Optional[int]` — Custom screen width in pixels for the browser.
757+
758+
</dd>
759+
</dl>
760+
761+
<dl>
762+
<dd>
763+
764+
**browser_screen_height:** `typing.Optional[int]` — Custom screen height in pixels for the browser.
765+
766+
</dd>
767+
</dl>
768+
769+
<dl>
770+
<dd>
771+
756772
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
757773

758774
</dd>
@@ -1995,6 +2011,22 @@ client.browsers.create_browser_session()
19952011
<dl>
19962012
<dd>
19972013

2014+
**browser_screen_width:** `typing.Optional[int]` — Custom screen width in pixels for the browser.
2015+
2016+
</dd>
2017+
</dl>
2018+
2019+
<dl>
2020+
<dd>
2021+
2022+
**browser_screen_height:** `typing.Optional[int]` — Custom screen height in pixels for the browser.
2023+
2024+
</dd>
2025+
</dl>
2026+
2027+
<dl>
2028+
<dd>
2029+
19982030
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
19992031

20002032
</dd>
@@ -2560,6 +2592,80 @@ client.workflows.update_workflow(
25602592
</dl>
25612593

25622594

2595+
</dd>
2596+
</dl>
2597+
</details>
2598+
2599+
<details><summary><code>client.workflows.<a href="src/browser_use_sdk/workflows/client.py">get_workflow_generation_state</a>(...)</code></summary>
2600+
<dl>
2601+
<dd>
2602+
2603+
#### 📝 Description
2604+
2605+
<dl>
2606+
<dd>
2607+
2608+
<dl>
2609+
<dd>
2610+
2611+
Get workflow generation state with live browser URL for polling.
2612+
2613+
This endpoint returns the current state of workflow generation including
2614+
the live browser URL (if available). It's designed to be polled every 2 seconds
2615+
during generation to show real-time browser activity in the frontend.
2616+
</dd>
2617+
</dl>
2618+
</dd>
2619+
</dl>
2620+
2621+
#### 🔌 Usage
2622+
2623+
<dl>
2624+
<dd>
2625+
2626+
<dl>
2627+
<dd>
2628+
2629+
```python
2630+
from browser_use_sdk import BrowserUse
2631+
2632+
client = BrowserUse(
2633+
api_key="YOUR_API_KEY",
2634+
)
2635+
client.workflows.get_workflow_generation_state(
2636+
workflow_id="workflow_id",
2637+
)
2638+
2639+
```
2640+
</dd>
2641+
</dl>
2642+
</dd>
2643+
</dl>
2644+
2645+
#### ⚙️ Parameters
2646+
2647+
<dl>
2648+
<dd>
2649+
2650+
<dl>
2651+
<dd>
2652+
2653+
**workflow_id:** `str`
2654+
2655+
</dd>
2656+
</dl>
2657+
2658+
<dl>
2659+
<dd>
2660+
2661+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2662+
2663+
</dd>
2664+
</dl>
2665+
</dd>
2666+
</dl>
2667+
2668+
25632669
</dd>
25642670
</dl>
25652671
</details>
@@ -2654,7 +2760,7 @@ client.workflows.get_workflow_yaml_presigned_url(
26542760
</dl>
26552761
</details>
26562762

2657-
<details><summary><code>client.workflows.<a href="src/browser_use_sdk/workflows/client.py">execute_workflow</a>(...)</code></summary>
2763+
<details><summary><code>client.workflows.<a href="src/browser_use_sdk/workflows/client.py">run_workflow</a>(...)</code></summary>
26582764
<dl>
26592765
<dd>
26602766

@@ -2666,10 +2772,10 @@ client.workflows.get_workflow_yaml_presigned_url(
26662772
<dl>
26672773
<dd>
26682774

2669-
Execute a workflow either synchronously or asynchronously.
2775+
Execute a workflow asynchronously.
26702776

2671-
- ASYNC mode: Returns execution ID immediately and processes in background via Lambda
2672-
- SYNC mode: Waits for execution to complete and returns results inline (max 5 min timeout)
2777+
Returns execution ID immediately and processes in background via Inngest.
2778+
Use the GET /workflows/executions/{execution_id} endpoint to check status and retrieve results.
26732779
</dd>
26742780
</dl>
26752781
</dd>
@@ -2689,7 +2795,7 @@ from browser_use_sdk import BrowserUse
26892795
client = BrowserUse(
26902796
api_key="YOUR_API_KEY",
26912797
)
2692-
client.workflows.execute_workflow(
2798+
client.workflows.run_workflow(
26932799
workflow_id="workflow_id",
26942800
)
26952801

@@ -2723,14 +2829,6 @@ client.workflows.execute_workflow(
27232829
<dl>
27242830
<dd>
27252831

2726-
**mode:** `typing.Optional[ExecutionMode]` — Execution mode (sync or async)
2727-
2728-
</dd>
2729-
</dl>
2730-
2731-
<dl>
2732-
<dd>
2733-
27342832
**execution_metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Optional metadata for this execution
27352833

27362834
</dd>
@@ -3338,3 +3436,151 @@ client.workflows.get_execution_logs(
33383436
</dl>
33393437
</details>
33403438

3439+
<details><summary><code>client.workflows.<a href="src/browser_use_sdk/workflows/client.py">get_execution_state</a>(...)</code></summary>
3440+
<dl>
3441+
<dd>
3442+
3443+
#### 📝 Description
3444+
3445+
<dl>
3446+
<dd>
3447+
3448+
<dl>
3449+
<dd>
3450+
3451+
Get workflow execution state with steps for live UI polling.
3452+
3453+
This endpoint returns the current state of a workflow execution including all steps
3454+
with their details. It's designed to be polled every 2 seconds during execution
3455+
to show real-time progress in the frontend.
3456+
</dd>
3457+
</dl>
3458+
</dd>
3459+
</dl>
3460+
3461+
#### 🔌 Usage
3462+
3463+
<dl>
3464+
<dd>
3465+
3466+
<dl>
3467+
<dd>
3468+
3469+
```python
3470+
from browser_use_sdk import BrowserUse
3471+
3472+
client = BrowserUse(
3473+
api_key="YOUR_API_KEY",
3474+
)
3475+
client.workflows.get_execution_state(
3476+
execution_id="execution_id",
3477+
)
3478+
3479+
```
3480+
</dd>
3481+
</dl>
3482+
</dd>
3483+
</dl>
3484+
3485+
#### ⚙️ Parameters
3486+
3487+
<dl>
3488+
<dd>
3489+
3490+
<dl>
3491+
<dd>
3492+
3493+
**execution_id:** `str`
3494+
3495+
</dd>
3496+
</dl>
3497+
3498+
<dl>
3499+
<dd>
3500+
3501+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
3502+
3503+
</dd>
3504+
</dl>
3505+
</dd>
3506+
</dl>
3507+
3508+
3509+
</dd>
3510+
</dl>
3511+
</details>
3512+
3513+
<details><summary><code>client.workflows.<a href="src/browser_use_sdk/workflows/client.py">get_execution_media</a>(...)</code></summary>
3514+
<dl>
3515+
<dd>
3516+
3517+
#### 📝 Description
3518+
3519+
<dl>
3520+
<dd>
3521+
3522+
<dl>
3523+
<dd>
3524+
3525+
Get workflow execution media (screenshots) with presigned URLs.
3526+
3527+
This endpoint returns media URLs for completed executions. Screenshots
3528+
are returned with presigned S3 URLs for direct access from the frontend.
3529+
Should be called when execution status is 'completed', 'failed', or 'cancelled'.
3530+
</dd>
3531+
</dl>
3532+
</dd>
3533+
</dl>
3534+
3535+
#### 🔌 Usage
3536+
3537+
<dl>
3538+
<dd>
3539+
3540+
<dl>
3541+
<dd>
3542+
3543+
```python
3544+
from browser_use_sdk import BrowserUse
3545+
3546+
client = BrowserUse(
3547+
api_key="YOUR_API_KEY",
3548+
)
3549+
client.workflows.get_execution_media(
3550+
execution_id="execution_id",
3551+
)
3552+
3553+
```
3554+
</dd>
3555+
</dl>
3556+
</dd>
3557+
</dl>
3558+
3559+
#### ⚙️ Parameters
3560+
3561+
<dl>
3562+
<dd>
3563+
3564+
<dl>
3565+
<dd>
3566+
3567+
**execution_id:** `str`
3568+
3569+
</dd>
3570+
</dl>
3571+
3572+
<dl>
3573+
<dd>
3574+
3575+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
3576+
3577+
</dd>
3578+
</dl>
3579+
</dd>
3580+
</dl>
3581+
3582+
3583+
</dd>
3584+
</dl>
3585+
</details>
3586+

0 commit comments

Comments
 (0)