Skip to content

Commit 0471f62

Browse files
fern-api[bot]fern-api[bot]
authored
Release 2.0.8
1 parent fe21084 commit 0471f62

27 files changed

+696
-60
lines changed

‎.fern/metadata.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@
1616
}
1717
},
1818
"extraDependencies": {
19-
"fast-json-stable-stringify": "^2.1.0",
20-
"zod": "^4"
19+
"fast-json-stable-stringify": "^2.1.0"
2120
},
2221
"extraDevDependencies": {
2322
"@dotenvx/dotenvx": "^1.49.0",
2423
"react": "^19.1.1",
2524
"react-dom": "^19.1.1",
2625
"tsconfig-paths": "^4.2.0",
27-
"ts-node": "^10.5.0"
26+
"ts-node": "^10.5.0",
27+
"zod": "^4"
2828
},
2929
"extraPeerDependencies": {
3030
"react": "^18 || ^19",

‎package.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "browser-use-sdk",
3-
"version": "2.0.7",
3+
"version": "2.0.8",
44
"private": false,
55
"repository": "github:browser-use/browser-use-node",
66
"type": "commonjs",
@@ -44,8 +44,7 @@
4444
"tsn": "ts-node -r tsconfig-paths/register"
4545
},
4646
"dependencies": {
47-
"fast-json-stable-stringify": "^2.1.0",
48-
"zod": "^4"
47+
"fast-json-stable-stringify": "^2.1.0"
4948
},
5049
"peerDependencies": {
5150
"react": "^18 || ^19",
@@ -63,7 +62,8 @@
6362
"react": "^19.1.1",
6463
"react-dom": "^19.1.1",
6564
"tsconfig-paths": "^4.2.0",
66-
"ts-node": "^10.5.0"
65+
"ts-node": "^10.5.0",
66+
"zod": "^4"
6767
},
6868
"browser": {
6969
"fs": false,

‎pnpm-lock.yaml‎

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

‎reference.md‎

Lines changed: 212 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2025,6 +2025,75 @@ await client.workflows.updateWorkflow({
20252025
</dl>
20262026

20272027

2028+
</dd>
2029+
</dl>
2030+
</details>
2031+
2032+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">getWorkflowGenerationState</a>({ ...params }) -> BrowserUse.WorkflowGenerationStateView</code></summary>
2033+
<dl>
2034+
<dd>
2035+
2036+
#### 📝 Description
2037+
2038+
<dl>
2039+
<dd>
2040+
2041+
<dl>
2042+
<dd>
2043+
2044+
Get workflow generation state with live browser URL for polling.
2045+
2046+
This endpoint returns the current state of workflow generation including
2047+
the live browser URL (if available). It's designed to be polled every 2 seconds
2048+
during generation to show real-time browser activity in the frontend.
2049+
</dd>
2050+
</dl>
2051+
</dd>
2052+
</dl>
2053+
2054+
#### 🔌 Usage
2055+
2056+
<dl>
2057+
<dd>
2058+
2059+
<dl>
2060+
<dd>
2061+
2062+
```typescript
2063+
await client.workflows.getWorkflowGenerationState({
2064+
workflow_id: "workflow_id"
2065+
});
2066+
2067+
```
2068+
</dd>
2069+
</dl>
2070+
</dd>
2071+
</dl>
2072+
2073+
#### ⚙️ Parameters
2074+
2075+
<dl>
2076+
<dd>
2077+
2078+
<dl>
2079+
<dd>
2080+
2081+
**request:** `BrowserUse.GetWorkflowGenerationStateWorkflowsWorkflowIdGenerationStateGetRequest`
2082+
2083+
</dd>
2084+
</dl>
2085+
2086+
<dl>
2087+
<dd>
2088+
2089+
**requestOptions:** `Workflows.RequestOptions`
2090+
2091+
</dd>
2092+
</dl>
2093+
</dd>
2094+
</dl>
2095+
2096+
20282097
</dd>
20292098
</dl>
20302099
</details>
@@ -2098,7 +2167,7 @@ await client.workflows.getWorkflowYamlPresignedUrl({
20982167
</dl>
20992168
</details>
21002169

2101-
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">executeWorkflow</a>({ ...params }) -> BrowserUse.ExecuteWorkflowWorkflowsWorkflowIdExecutePostResponse</code></summary>
2170+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">runWorkflow</a>({ ...params }) -> BrowserUse.WorkflowExecutionCreatedResponse</code></summary>
21022171
<dl>
21032172
<dd>
21042173

@@ -2110,10 +2179,10 @@ await client.workflows.getWorkflowYamlPresignedUrl({
21102179
<dl>
21112180
<dd>
21122181

2113-
Execute a workflow either synchronously or asynchronously.
2182+
Execute a workflow asynchronously.
21142183

2115-
- ASYNC mode: Returns execution ID immediately and processes in background via Lambda
2116-
- SYNC mode: Waits for execution to complete and returns results inline (max 5 min timeout)
2184+
Returns execution ID immediately and processes in background via Inngest.
2185+
Use the GET /workflows/executions/{execution_id} endpoint to check status and retrieve results.
21172186
</dd>
21182187
</dl>
21192188
</dd>
@@ -2128,7 +2197,7 @@ Execute a workflow either synchronously or asynchronously.
21282197
<dd>
21292198

21302199
```typescript
2131-
await client.workflows.executeWorkflow({
2200+
await client.workflows.runWorkflow({
21322201
workflow_id: "workflow_id"
21332202
});
21342203

@@ -2559,6 +2628,144 @@ await client.workflows.getExecutionLogs({
25592628
</dl>
25602629

25612630

2631+
</dd>
2632+
</dl>
2633+
</details>
2634+
2635+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">getExecutionState</a>({ ...params }) -> BrowserUse.WorkflowExecutionStateView</code></summary>
2636+
<dl>
2637+
<dd>
2638+
2639+
#### 📝 Description
2640+
2641+
<dl>
2642+
<dd>
2643+
2644+
<dl>
2645+
<dd>
2646+
2647+
Get workflow execution state with steps for live UI polling.
2648+
2649+
This endpoint returns the current state of a workflow execution including all steps
2650+
with their details. It's designed to be polled every 2 seconds during execution
2651+
to show real-time progress in the frontend.
2652+
</dd>
2653+
</dl>
2654+
</dd>
2655+
</dl>
2656+
2657+
#### 🔌 Usage
2658+
2659+
<dl>
2660+
<dd>
2661+
2662+
<dl>
2663+
<dd>
2664+
2665+
```typescript
2666+
await client.workflows.getExecutionState({
2667+
execution_id: "execution_id"
2668+
});
2669+
2670+
```
2671+
</dd>
2672+
</dl>
2673+
</dd>
2674+
</dl>
2675+
2676+
#### ⚙️ Parameters
2677+
2678+
<dl>
2679+
<dd>
2680+
2681+
<dl>
2682+
<dd>
2683+
2684+
**request:** `BrowserUse.GetExecutionStateWorkflowsExecutionsExecutionIdStateGetRequest`
2685+
2686+
</dd>
2687+
</dl>
2688+
2689+
<dl>
2690+
<dd>
2691+
2692+
**requestOptions:** `Workflows.RequestOptions`
2693+
2694+
</dd>
2695+
</dl>
2696+
</dd>
2697+
</dl>
2698+
2699+
2700+
</dd>
2701+
</dl>
2702+
</details>
2703+
2704+
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">getExecutionMedia</a>({ ...params }) -> BrowserUse.WorkflowExecutionMediaView</code></summary>
2705+
<dl>
2706+
<dd>
2707+
2708+
#### 📝 Description
2709+
2710+
<dl>
2711+
<dd>
2712+
2713+
<dl>
2714+
<dd>
2715+
2716+
Get workflow execution media (screenshots) with presigned URLs.
2717+
2718+
This endpoint returns media URLs for completed executions. Screenshots
2719+
are returned with presigned S3 URLs for direct access from the frontend.
2720+
Should be called when execution status is 'completed', 'failed', or 'cancelled'.
2721+
</dd>
2722+
</dl>
2723+
</dd>
2724+
</dl>
2725+
2726+
#### 🔌 Usage
2727+
2728+
<dl>
2729+
<dd>
2730+
2731+
<dl>
2732+
<dd>
2733+
2734+
```typescript
2735+
await client.workflows.getExecutionMedia({
2736+
execution_id: "execution_id"
2737+
});
2738+
2739+
```
2740+
</dd>
2741+
</dl>
2742+
</dd>
2743+
</dl>
2744+
2745+
#### ⚙️ Parameters
2746+
2747+
<dl>
2748+
<dd>
2749+
2750+
<dl>
2751+
<dd>
2752+
2753+
**request:** `BrowserUse.GetExecutionMediaWorkflowsExecutionsExecutionIdMediaGetRequest`
2754+
2755+
</dd>
2756+
</dl>
2757+
2758+
<dl>
2759+
<dd>
2760+
2761+
**requestOptions:** `Workflows.RequestOptions`
2762+
2763+
</dd>
2764+
</dl>
2765+
</dd>
2766+
</dl>
2767+
2768+
25622769
</dd>
25632770
</dl>
25642771
</details>

‎src/Client.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ export class BrowserUseClient {
3535
{
3636
"X-Fern-Language": "JavaScript",
3737
"X-Fern-SDK-Name": "browser-use-sdk",
38-
"X-Fern-SDK-Version": "2.0.7",
39-
"User-Agent": "browser-use-sdk/2.0.7",
38+
"X-Fern-SDK-Version": "2.0.8",
39+
"User-Agent": "browser-use-sdk/2.0.8",
4040
"X-Fern-Runtime": core.RUNTIME.type,
4141
"X-Fern-Runtime-Version": core.RUNTIME.version,
4242
},

‎src/api/resources/browsers/client/requests/CreateBrowserSessionRequest.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,8 @@ export interface CreateBrowserSessionRequest {
1313
proxyCountryCode?: BrowserUse.ProxyCountryCode | null;
1414
/** The timeout for the session in minutes. Free users are limited to 15 minutes, paid users can use up to 240 minutes (4 hours). */
1515
timeout?: number;
16+
/** Custom screen width in pixels for the browser. */
17+
browserScreenWidth?: number | null;
18+
/** Custom screen height in pixels for the browser. */
19+
browserScreenHeight?: number | null;
1620
}

‎src/api/resources/index.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,3 @@ export * from "./tasks/client/requests/index.js";
1111
export * as tasks from "./tasks/index.js";
1212
export * from "./workflows/client/requests/index.js";
1313
export * as workflows from "./workflows/index.js";
14-
export * from "./workflows/types/index.js";

‎src/api/resources/sessions/client/requests/CreateSessionRequest.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,8 @@ export interface CreateSessionRequest {
1313
proxyCountryCode?: BrowserUse.ProxyCountryCode | null;
1414
/** URL to navigate to when the session starts. */
1515
startUrl?: string | null;
16+
/** Custom screen width in pixels for the browser. */
17+
browserScreenWidth?: number | null;
18+
/** Custom screen height in pixels for the browser. */
19+
browserScreenHeight?: number | null;
1620
}

0 commit comments

Comments
 (0)