browser-use-sdk 2.0.12 → 2.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (150) hide show
  1. package/dist/cjs/BaseClient.d.ts +1 -1
  2. package/dist/cjs/Client.d.ts +1 -1
  3. package/dist/cjs/Client.js +3 -3
  4. package/dist/cjs/api/errors/ForbiddenError.d.ts +1 -2
  5. package/dist/cjs/api/resources/billing/client/Client.d.ts +2 -2
  6. package/dist/cjs/api/resources/billing/client/Client.js +2 -2
  7. package/dist/cjs/api/resources/browsers/client/Client.d.ts +9 -7
  8. package/dist/cjs/api/resources/browsers/client/Client.js +9 -7
  9. package/dist/cjs/api/resources/browsers/client/requests/CreateBrowserSessionRequest.d.ts +1 -1
  10. package/dist/cjs/api/resources/files/client/Client.d.ts +1 -1
  11. package/dist/cjs/api/resources/files/client/Client.js +1 -1
  12. package/dist/cjs/api/resources/profiles/client/Client.d.ts +1 -1
  13. package/dist/cjs/api/resources/profiles/client/Client.js +1 -1
  14. package/dist/cjs/api/resources/sessions/client/Client.d.ts +1 -1
  15. package/dist/cjs/api/resources/sessions/client/Client.js +1 -1
  16. package/dist/cjs/api/resources/sessions/client/requests/CreateSessionRequest.d.ts +2 -0
  17. package/dist/cjs/api/resources/skills/client/Client.d.ts +6 -4
  18. package/dist/cjs/api/resources/skills/client/Client.js +12 -5
  19. package/dist/cjs/api/resources/skills/client/requests/ExecuteSkillSkillsSkillIdExecutePostRequest.d.ts +12 -0
  20. package/dist/cjs/api/resources/skills/client/requests/ExecuteSkillSkillsSkillIdExecutePostRequest.js +3 -0
  21. package/dist/cjs/api/resources/skills/client/requests/ListSkillsSkillsGetRequest.d.ts +2 -0
  22. package/dist/cjs/api/resources/skills/client/requests/UpdateSkillRequest.d.ts +5 -2
  23. package/dist/cjs/api/resources/skills/client/requests/index.d.ts +1 -1
  24. package/dist/cjs/api/resources/skillsMarketplace/client/Client.d.ts +24 -5
  25. package/dist/cjs/api/resources/skillsMarketplace/client/Client.js +87 -7
  26. package/dist/cjs/api/resources/skillsMarketplace/client/requests/ExecuteSkillMarketplaceSkillsSkillIdExecutePostRequest.d.ts +12 -0
  27. package/dist/cjs/api/resources/skillsMarketplace/client/requests/ExecuteSkillMarketplaceSkillsSkillIdExecutePostRequest.js +3 -0
  28. package/dist/cjs/api/resources/skillsMarketplace/client/requests/GetSkillMarketplaceSkillsSkillSlugGetRequest.d.ts +9 -0
  29. package/dist/cjs/api/resources/skillsMarketplace/client/requests/GetSkillMarketplaceSkillsSkillSlugGetRequest.js +3 -0
  30. package/dist/cjs/api/resources/skillsMarketplace/client/requests/ListSkillsMarketplaceSkillsGetRequest.d.ts +2 -0
  31. package/dist/cjs/api/resources/skillsMarketplace/client/requests/index.d.ts +2 -1
  32. package/dist/cjs/api/resources/tasks/client/Client.d.ts +9 -3
  33. package/dist/cjs/api/resources/tasks/client/Client.js +9 -3
  34. package/dist/cjs/api/resources/tasks/client/requests/CreateTaskRequest.d.ts +2 -0
  35. package/dist/cjs/api/resources/workflows/client/Client.d.ts +29 -1
  36. package/dist/cjs/api/resources/workflows/client/Client.js +85 -1
  37. package/dist/cjs/api/resources/workflows/client/requests/WorkflowCreateFromTaskRequest.d.ts +18 -0
  38. package/dist/cjs/api/resources/workflows/client/requests/WorkflowCreateFromTaskRequest.js +3 -0
  39. package/dist/cjs/api/resources/workflows/client/requests/index.d.ts +1 -0
  40. package/dist/cjs/api/types/AccountNotFoundError.d.ts +1 -1
  41. package/dist/cjs/api/types/AccountView.d.ts +5 -5
  42. package/dist/cjs/api/types/AppEndpointsApiV2MarketplaceSkillsViewsInsufficientCreditsError.d.ts +6 -0
  43. package/dist/cjs/api/types/AppEndpointsApiV2MarketplaceSkillsViewsInsufficientCreditsError.js +3 -0
  44. package/dist/cjs/api/types/AppEndpointsApiV2SkillsViewsInsufficientCreditsError.d.ts +6 -0
  45. package/dist/cjs/api/types/AppEndpointsApiV2SkillsViewsInsufficientCreditsError.js +3 -0
  46. package/dist/cjs/api/types/CommonUtilsErrorsInsufficientCreditsError.d.ts +6 -0
  47. package/dist/cjs/api/types/CommonUtilsErrorsInsufficientCreditsError.js +3 -0
  48. package/dist/cjs/api/types/EnabledSkillsLimitExceededError.d.ts +6 -0
  49. package/dist/cjs/api/types/EnabledSkillsLimitExceededError.js +3 -0
  50. package/dist/cjs/api/types/ExecuteSkillRequest.d.ts +7 -0
  51. package/dist/cjs/api/types/ExecuteSkillRequest.js +3 -0
  52. package/dist/cjs/api/types/MarketplaceSkillResponse.d.ts +14 -0
  53. package/dist/cjs/api/types/SessionItemView.d.ts +2 -0
  54. package/dist/cjs/api/types/SessionStatus.d.ts +3 -3
  55. package/dist/cjs/api/types/SessionStatus.js +3 -3
  56. package/dist/cjs/api/types/SessionTimeoutLimitExceededError.d.ts +1 -1
  57. package/dist/cjs/api/types/SessionView.d.ts +2 -0
  58. package/dist/cjs/api/types/SkillCategory.d.ts +20 -0
  59. package/dist/cjs/api/types/SkillCategory.js +23 -0
  60. package/dist/cjs/api/types/SkillResponse.d.ts +14 -2
  61. package/dist/cjs/api/types/SkillsGenerationStatus.d.ts +1 -0
  62. package/dist/cjs/api/types/SkillsGenerationStatus.js +1 -0
  63. package/dist/cjs/api/types/WorkflowCreateFromTaskResponse.d.ts +11 -0
  64. package/dist/cjs/api/types/WorkflowCreateFromTaskResponse.js +3 -0
  65. package/dist/cjs/api/types/WorkflowExecutionResponse.d.ts +4 -0
  66. package/dist/cjs/api/types/WorkflowExecutionStateView.d.ts +4 -0
  67. package/dist/cjs/api/types/WorkflowExecutionStepView.d.ts +4 -4
  68. package/dist/cjs/api/types/WorkflowGenerationStateView.d.ts +6 -0
  69. package/dist/cjs/api/types/WorkflowItemView.d.ts +7 -0
  70. package/dist/cjs/api/types/WorkflowResponse.d.ts +2 -0
  71. package/dist/cjs/api/types/index.d.ts +7 -2
  72. package/dist/cjs/api/types/index.js +7 -2
  73. package/dist/cjs/version.d.ts +1 -1
  74. package/dist/cjs/version.js +1 -1
  75. package/dist/esm/BaseClient.d.mts +1 -1
  76. package/dist/esm/Client.d.mts +1 -1
  77. package/dist/esm/Client.mjs +3 -3
  78. package/dist/esm/api/errors/ForbiddenError.d.mts +1 -2
  79. package/dist/esm/api/resources/billing/client/Client.d.mts +2 -2
  80. package/dist/esm/api/resources/billing/client/Client.mjs +2 -2
  81. package/dist/esm/api/resources/browsers/client/Client.d.mts +9 -7
  82. package/dist/esm/api/resources/browsers/client/Client.mjs +9 -7
  83. package/dist/esm/api/resources/browsers/client/requests/CreateBrowserSessionRequest.d.mts +1 -1
  84. package/dist/esm/api/resources/files/client/Client.d.mts +1 -1
  85. package/dist/esm/api/resources/files/client/Client.mjs +1 -1
  86. package/dist/esm/api/resources/profiles/client/Client.d.mts +1 -1
  87. package/dist/esm/api/resources/profiles/client/Client.mjs +1 -1
  88. package/dist/esm/api/resources/sessions/client/Client.d.mts +1 -1
  89. package/dist/esm/api/resources/sessions/client/Client.mjs +1 -1
  90. package/dist/esm/api/resources/sessions/client/requests/CreateSessionRequest.d.mts +2 -0
  91. package/dist/esm/api/resources/skills/client/Client.d.mts +6 -4
  92. package/dist/esm/api/resources/skills/client/Client.mjs +12 -5
  93. package/dist/esm/api/resources/skills/client/requests/ExecuteSkillSkillsSkillIdExecutePostRequest.d.mts +12 -0
  94. package/dist/esm/api/resources/skills/client/requests/ExecuteSkillSkillsSkillIdExecutePostRequest.mjs +2 -0
  95. package/dist/esm/api/resources/skills/client/requests/ListSkillsSkillsGetRequest.d.mts +2 -0
  96. package/dist/esm/api/resources/skills/client/requests/UpdateSkillRequest.d.mts +5 -2
  97. package/dist/esm/api/resources/skills/client/requests/index.d.mts +1 -1
  98. package/dist/esm/api/resources/skillsMarketplace/client/Client.d.mts +24 -5
  99. package/dist/esm/api/resources/skillsMarketplace/client/Client.mjs +87 -7
  100. package/dist/esm/api/resources/skillsMarketplace/client/requests/ExecuteSkillMarketplaceSkillsSkillIdExecutePostRequest.d.mts +12 -0
  101. package/dist/esm/api/resources/skillsMarketplace/client/requests/ExecuteSkillMarketplaceSkillsSkillIdExecutePostRequest.mjs +2 -0
  102. package/dist/esm/api/resources/skillsMarketplace/client/requests/GetSkillMarketplaceSkillsSkillSlugGetRequest.d.mts +9 -0
  103. package/dist/esm/api/resources/skillsMarketplace/client/requests/GetSkillMarketplaceSkillsSkillSlugGetRequest.mjs +2 -0
  104. package/dist/esm/api/resources/skillsMarketplace/client/requests/ListSkillsMarketplaceSkillsGetRequest.d.mts +2 -0
  105. package/dist/esm/api/resources/skillsMarketplace/client/requests/index.d.mts +2 -1
  106. package/dist/esm/api/resources/tasks/client/Client.d.mts +9 -3
  107. package/dist/esm/api/resources/tasks/client/Client.mjs +9 -3
  108. package/dist/esm/api/resources/tasks/client/requests/CreateTaskRequest.d.mts +2 -0
  109. package/dist/esm/api/resources/workflows/client/Client.d.mts +29 -1
  110. package/dist/esm/api/resources/workflows/client/Client.mjs +85 -1
  111. package/dist/esm/api/resources/workflows/client/requests/WorkflowCreateFromTaskRequest.d.mts +18 -0
  112. package/dist/esm/api/resources/workflows/client/requests/WorkflowCreateFromTaskRequest.mjs +2 -0
  113. package/dist/esm/api/resources/workflows/client/requests/index.d.mts +1 -0
  114. package/dist/esm/api/types/AccountNotFoundError.d.mts +1 -1
  115. package/dist/esm/api/types/AccountView.d.mts +5 -5
  116. package/dist/esm/api/types/AppEndpointsApiV2MarketplaceSkillsViewsInsufficientCreditsError.d.mts +6 -0
  117. package/dist/esm/api/types/AppEndpointsApiV2MarketplaceSkillsViewsInsufficientCreditsError.mjs +2 -0
  118. package/dist/esm/api/types/AppEndpointsApiV2SkillsViewsInsufficientCreditsError.d.mts +6 -0
  119. package/dist/esm/api/types/AppEndpointsApiV2SkillsViewsInsufficientCreditsError.mjs +2 -0
  120. package/dist/esm/api/types/CommonUtilsErrorsInsufficientCreditsError.d.mts +6 -0
  121. package/dist/esm/api/types/CommonUtilsErrorsInsufficientCreditsError.mjs +2 -0
  122. package/dist/esm/api/types/EnabledSkillsLimitExceededError.d.mts +6 -0
  123. package/dist/esm/api/types/EnabledSkillsLimitExceededError.mjs +2 -0
  124. package/dist/esm/api/types/ExecuteSkillRequest.d.mts +7 -0
  125. package/dist/esm/api/types/ExecuteSkillRequest.mjs +2 -0
  126. package/dist/esm/api/types/MarketplaceSkillResponse.d.mts +14 -0
  127. package/dist/esm/api/types/SessionItemView.d.mts +2 -0
  128. package/dist/esm/api/types/SessionStatus.d.mts +3 -3
  129. package/dist/esm/api/types/SessionStatus.mjs +3 -3
  130. package/dist/esm/api/types/SessionTimeoutLimitExceededError.d.mts +1 -1
  131. package/dist/esm/api/types/SessionView.d.mts +2 -0
  132. package/dist/esm/api/types/SkillCategory.d.mts +20 -0
  133. package/dist/esm/api/types/SkillCategory.mjs +20 -0
  134. package/dist/esm/api/types/SkillResponse.d.mts +14 -2
  135. package/dist/esm/api/types/SkillsGenerationStatus.d.mts +1 -0
  136. package/dist/esm/api/types/SkillsGenerationStatus.mjs +1 -0
  137. package/dist/esm/api/types/WorkflowCreateFromTaskResponse.d.mts +11 -0
  138. package/dist/esm/api/types/WorkflowCreateFromTaskResponse.mjs +2 -0
  139. package/dist/esm/api/types/WorkflowExecutionResponse.d.mts +4 -0
  140. package/dist/esm/api/types/WorkflowExecutionStateView.d.mts +4 -0
  141. package/dist/esm/api/types/WorkflowExecutionStepView.d.mts +4 -4
  142. package/dist/esm/api/types/WorkflowGenerationStateView.d.mts +6 -0
  143. package/dist/esm/api/types/WorkflowItemView.d.mts +7 -0
  144. package/dist/esm/api/types/WorkflowResponse.d.mts +2 -0
  145. package/dist/esm/api/types/index.d.mts +7 -2
  146. package/dist/esm/api/types/index.mjs +7 -2
  147. package/dist/esm/version.d.mts +1 -1
  148. package/dist/esm/version.mjs +1 -1
  149. package/package.json +83 -82
  150. package/reference.md +166 -14
package/reference.md CHANGED
@@ -12,7 +12,7 @@
12
12
  <dl>
13
13
  <dd>
14
14
 
15
- Get authenticated account information including credit balances and account details.
15
+ Get authenticated account information including credit balance and account details.
16
16
  </dd>
17
17
  </dl>
18
18
  </dd>
@@ -131,9 +131,15 @@ await client.tasks.listTasks();
131
131
  <dl>
132
132
  <dd>
133
133
 
134
+ Create and start a new task.
135
+
134
136
  You can either:
135
- 1. Start a new task (auto creates a new simple session)
136
- 2. Start a new task in an existing session (you can create a custom session before starting the task and reuse it for follow-up tasks)
137
+ 1. Start a new task without a sessionId (auto-creates a session with US proxy by default)
138
+ 2. Start a new task in an existing session (reuse for follow-up tasks or custom configuration)
139
+
140
+ Important: Proxy configuration (proxyCountryCode) is a session-level setting, not a task-level setting.
141
+ To use a custom proxy location, create a session first via POST /sessions with your desired proxyCountryCode,
142
+ then pass that sessionId when creating tasks.
137
143
  </dd>
138
144
  </dl>
139
145
  </dd>
@@ -1512,16 +1518,18 @@ await client.browsers.listBrowserSessions();
1512
1518
 
1513
1519
  Create a new browser session.
1514
1520
 
1515
- **Pricing:** Browser sessions are charged at $0.05 per hour.
1516
- The full hourly rate is charged upfront when the session starts.
1521
+ **Pricing:** Browser sessions are charged per hour with tiered pricing:
1522
+ - Pay As You Go users: $0.06/hour
1523
+ - Business/Scaleup subscribers: $0.03/hour (50% discount)
1524
+
1525
+ The full rate is charged upfront when the session starts.
1517
1526
  When you stop the session, any unused time is automatically refunded proportionally.
1518
1527
 
1519
- Billing is rounded to the nearest minute (minimum 1 minute).
1520
- For example, if you stop a session after 30 minutes, you'll be refunded $0.025.
1528
+ Billing is rounded up to the minute (minimum 1 minute).
1529
+ For example, if you stop a session after 30 minutes, you'll be refunded half the charged amount.
1521
1530
 
1522
1531
  **Session Limits:**
1523
- - Free users (without active subscription): Maximum 15 minutes per session
1524
- - Paid subscribers: Up to 4 hours per session
1532
+ - All users: Up to 4 hours per session
1525
1533
  </dd>
1526
1534
  </dl>
1527
1535
  </dd>
@@ -2190,7 +2198,8 @@ Execute a skill with the provided parameters.
2190
2198
 
2191
2199
  ```typescript
2192
2200
  await client.skills.executeSkill({
2193
- skill_id: "skill_id"
2201
+ skill_id: "skill_id",
2202
+ body: {}
2194
2203
  });
2195
2204
 
2196
2205
  ```
@@ -2207,7 +2216,7 @@ await client.skills.executeSkill({
2207
2216
  <dl>
2208
2217
  <dd>
2209
2218
 
2210
- **request:** `BrowserUse.ExecuteSkillRequest`
2219
+ **request:** `BrowserUse.ExecuteSkillSkillsSkillIdExecutePostRequest`
2211
2220
 
2212
2221
  </dd>
2213
2222
  </dl>
@@ -2385,7 +2394,7 @@ Get details of a specific public skill from the marketplace.
2385
2394
 
2386
2395
  ```typescript
2387
2396
  await client.skillsMarketplace.getSkill({
2388
- skill_id: "skill_id"
2397
+ skill_slug: "skill_slug"
2389
2398
  });
2390
2399
 
2391
2400
  ```
@@ -2402,7 +2411,7 @@ await client.skillsMarketplace.getSkill({
2402
2411
  <dl>
2403
2412
  <dd>
2404
2413
 
2405
- **request:** `BrowserUse.GetSkillMarketplaceSkillsSkillIdGetRequest`
2414
+ **request:** `BrowserUse.GetSkillMarketplaceSkillsSkillSlugGetRequest`
2406
2415
 
2407
2416
  </dd>
2408
2417
  </dl>
@@ -2422,7 +2431,7 @@ await client.skillsMarketplace.getSkill({
2422
2431
  </dl>
2423
2432
  </details>
2424
2433
 
2425
- <details><summary><code>client.skillsMarketplace.<a href="/src/api/resources/skillsMarketplace/client/Client.ts">cloneSkill</a>({ ...params }) -> BrowserUse.MarketplaceSkillResponse</code></summary>
2434
+ <details><summary><code>client.skillsMarketplace.<a href="/src/api/resources/skillsMarketplace/client/Client.ts">cloneSkill</a>({ ...params }) -> BrowserUse.SkillResponse</code></summary>
2426
2435
  <dl>
2427
2436
  <dd>
2428
2437
 
@@ -2483,6 +2492,72 @@ await client.skillsMarketplace.cloneSkill({
2483
2492
  </dl>
2484
2493
 
2485
2494
 
2495
+ </dd>
2496
+ </dl>
2497
+ </details>
2498
+
2499
+ <details><summary><code>client.skillsMarketplace.<a href="/src/api/resources/skillsMarketplace/client/Client.ts">executeSkill</a>({ ...params }) -> BrowserUse.ExecuteSkillResponse</code></summary>
2500
+ <dl>
2501
+ <dd>
2502
+
2503
+ #### 📝 Description
2504
+
2505
+ <dl>
2506
+ <dd>
2507
+
2508
+ <dl>
2509
+ <dd>
2510
+
2511
+ Execute a skill with the provided parameters.
2512
+ </dd>
2513
+ </dl>
2514
+ </dd>
2515
+ </dl>
2516
+
2517
+ #### 🔌 Usage
2518
+
2519
+ <dl>
2520
+ <dd>
2521
+
2522
+ <dl>
2523
+ <dd>
2524
+
2525
+ ```typescript
2526
+ await client.skillsMarketplace.executeSkill({
2527
+ skill_id: "skill_id",
2528
+ body: {}
2529
+ });
2530
+
2531
+ ```
2532
+ </dd>
2533
+ </dl>
2534
+ </dd>
2535
+ </dl>
2536
+
2537
+ #### ⚙️ Parameters
2538
+
2539
+ <dl>
2540
+ <dd>
2541
+
2542
+ <dl>
2543
+ <dd>
2544
+
2545
+ **request:** `BrowserUse.ExecuteSkillMarketplaceSkillsSkillIdExecutePostRequest`
2546
+
2547
+ </dd>
2548
+ </dl>
2549
+
2550
+ <dl>
2551
+ <dd>
2552
+
2553
+ **requestOptions:** `SkillsMarketplace.RequestOptions`
2554
+
2555
+ </dd>
2556
+ </dl>
2557
+ </dd>
2558
+ </dl>
2559
+
2560
+
2486
2561
  </dd>
2487
2562
  </dl>
2488
2563
  </details>
@@ -2876,6 +2951,83 @@ await client.workflows.getWorkflowGenerationState({
2876
2951
  </dl>
2877
2952
 
2878
2953
 
2954
+ </dd>
2955
+ </dl>
2956
+ </details>
2957
+
2958
+ <details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">createWorkflowFromTask</a>({ ...params }) -> BrowserUse.WorkflowCreateFromTaskResponse</code></summary>
2959
+ <dl>
2960
+ <dd>
2961
+
2962
+ #### 📝 Description
2963
+
2964
+ <dl>
2965
+ <dd>
2966
+
2967
+ <dl>
2968
+ <dd>
2969
+
2970
+ Create a workflow from an existing agent task's recorded history.
2971
+
2972
+ This endpoint creates a workflow by using the browser-use rerun history
2973
+ feature. The task must have completed with history stored in S3.
2974
+
2975
+ The workflow creation process:
2976
+ 1. Creates a new workflow record in pending state
2977
+ 2. Triggers an Inngest event to process the task history
2978
+ 3. The Inngest handler downloads history, detects variables, and updates the workflow
2979
+
2980
+ Use GET /workflows/{workflow_id} to poll for creation completion.
2981
+ </dd>
2982
+ </dl>
2983
+ </dd>
2984
+ </dl>
2985
+
2986
+ #### 🔌 Usage
2987
+
2988
+ <dl>
2989
+ <dd>
2990
+
2991
+ <dl>
2992
+ <dd>
2993
+
2994
+ ```typescript
2995
+ await client.workflows.createWorkflowFromTask({
2996
+ name: "name",
2997
+ taskId: "taskId",
2998
+ sessionId: "sessionId"
2999
+ });
3000
+
3001
+ ```
3002
+ </dd>
3003
+ </dl>
3004
+ </dd>
3005
+ </dl>
3006
+
3007
+ #### ⚙️ Parameters
3008
+
3009
+ <dl>
3010
+ <dd>
3011
+
3012
+ <dl>
3013
+ <dd>
3014
+
3015
+ **request:** `BrowserUse.WorkflowCreateFromTaskRequest`
3016
+
3017
+ </dd>
3018
+ </dl>
3019
+
3020
+ <dl>
3021
+ <dd>
3022
+
3023
+ **requestOptions:** `Workflows.RequestOptions`
3024
+
3025
+ </dd>
3026
+ </dl>
3027
+ </dd>
3028
+ </dl>
3029
+
3030
+
2879
3031
  </dd>
2880
3032
  </dl>
2881
3033
  </details>