Skip to content

Commit d975467

Browse files
marijahorvat171ivicac
marijahorvat171
authored and
ivicac
committed
4653 - json and docs generated
1 parent 90c4fd8 commit d975467

2 files changed

Lines changed: 5585 additions & 0 deletions

File tree

‎docs/content/docs/reference/components/browser-use_v1.mdx‎

Lines changed: 296 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,296 @@
1+
---
2+
title: "Browser Use"
3+
description: "AI-powered browser automation that enables agents to perform web tasks such as navigating websites and extracting data."
4+
---
5+
6+
7+
Categories: Artificial Intelligence
8+
9+
10+
Type: browserUse/v1
11+
12+
<hr />
13+
14+
15+
16+
17+
## Connections
18+
19+
Version: 1
20+
21+
22+
### API Key
23+
24+
#### Properties
25+
26+
| Name | Label | Type | Description | Required |
27+
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
28+
| key | Key | STRING | | true |
29+
| value | API Key | STRING | | true |
30+
31+
32+
33+
## Connection Setup
34+
35+
1. Go to your Browser Use Dashboard.
36+
2. On the left bar, you will find **Settings** -> **API Keys**.
37+
3. Click on **Create API Key**.
38+
4. Add label if you want and click **Create**.
39+
5. Copy your API Key and use it in ByteChef.
40+
41+
<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 49, boxSizing: 'border-box', paddingBottom: 'calc(53.05219207% + 32px)'}}>
42+
<iframe src="https://www.guidejar.com/embed/kUY5voL6TXCGKIsvVcd4?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowFullScreen frameBorder="0"></iframe>
43+
</div>
44+
45+
46+
47+
<hr />
48+
49+
50+
## Actions
51+
52+
53+
### Create Session
54+
Name: createSession
55+
56+
`Create a session and/or dispatch a task.`
57+
58+
#### Properties
59+
60+
| Name | Label | Type | Description | Required |
61+
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
62+
| task | Task | STRING | The natural-language instruction for the agent to execute. | true |
63+
| model | Model | STRING <details> <summary> Options </summary> <span>claude-sonnet-4.6</span>, <span>claude-opus-4.6</span>, <span>gpt-5.4-mini</span> </details> | The model to use. | true |
64+
| outputSchema | Output | OBJECT <details> <summary> Properties </summary> &#123;STRING\(format), STRING\(schema)&#125; </details> | Configure how the browser agent should return results. | true |
65+
| sessionId | Session ID | STRING | ID of an existing idle session to dispatch the task to. | false |
66+
| keepAlive | Keep Alive | BOOLEAN <details> <summary> Options </summary> <span>true</span>, <span>false</span> </details> | If true, the session stays alive in idle state after the task completes instead of automatically stopping. | false |
67+
| enableScheduledTasks | Enable Scheduled Tasks | BOOLEAN <details> <summary> Options </summary> <span>true</span>, <span>false</span> </details> | If true, the agent can create scheduled tasks that run on a recurring basis. | false |
68+
| skills | Skills | BOOLEAN <details> <summary> Options </summary> <span>true</span>, <span>false</span> </details> | If true, enables built-in agent skills. | false |
69+
70+
#### Example JSON Structure
71+
```json
72+
{
73+
"label" : "Create Session",
74+
"name" : "createSession",
75+
"parameters" : {
76+
"task" : "",
77+
"model" : "",
78+
"outputSchema" : {
79+
"format" : "",
80+
"schema" : ""
81+
},
82+
"sessionId" : "",
83+
"keepAlive" : false,
84+
"enableScheduledTasks" : false,
85+
"skills" : false
86+
},
87+
"type" : "browserUse/v1/createSession"
88+
}
89+
```
90+
91+
#### Output
92+
93+
94+
95+
Type: OBJECT
96+
97+
98+
#### Properties
99+
100+
| Name | Type | Description |
101+
|:------------:|:------------:|:-------------------:|
102+
| id | STRING | Unique session identifier. |
103+
| status | STRING | Current session lifecycle status. |
104+
| model | STRING | The model tier used for this session. |
105+
| createdAt | DATE_TIME | When the session was created. |
106+
| updatedAt | DATE_TIME | When the session was last updated. |
107+
| title | STRING | Auto-generated short title summarizing the task. |
108+
| output | OBJECT <details> <summary> Properties </summary> &#123;&#125; </details> | The agent's final output. |
109+
| outputSchema | OBJECT <details> <summary> Properties </summary> &#123;&#125; </details> | The JSON Schema that was requested for structured output, if any. |
110+
| stepCount | INTEGER | Number of steps the agent has executed so far. |
111+
| lastStepSummary | STRING | Human-readable summary of the most recent agent step. |
112+
| isTaskSuccessful | BOOLEAN <details> <summary> Options </summary> <span>true</span>, <span>false</span> </details> | Whether the task completed successfully. |
113+
| liveUrl | STRING | URL to view the live browser session. |
114+
| recordingUrls | ARRAY <details> <summary> Items </summary> [STRING] </details> | URLs to download session recordings. |
115+
| profileId | STRING | ID of the browser profile loaded in this session, if any. |
116+
| workspaceId | STRING | ID of the workspace attached to this session, if any. |
117+
| proxyCountryCode | STRING | Country code of the proxy used for this session, or null if no proxy. |
118+
| maxCostUsd | STRING | Maximum cost limit in USD set for this session. |
119+
| totalInputTokens | INTEGER | Total LLM input tokens consumed by this session. |
120+
| totalOutputTokens | INTEGER | Total LLM output tokens consumed by this session. |
121+
| proxyUsedMb | STRING | Proxy bandwidth used in megabytes. |
122+
| llmCostUsd | STRING | Cost of LLM usage in USD. |
123+
| proxyCostUsd | STRING | Cost of proxy bandwidth in USD. |
124+
| browserCostUsd | STRING | Cost of browser compute time in USD. |
125+
| totalCostUsd | STRING | Total session cost in USD (LLM + proxy + browser). |
126+
| screenshotUrl | STRING | URL of the latest browser screenshot. |
127+
| agentmailEmail | STRING | Temporary email address provisioned for this session (via AgentMail). |
128+
129+
130+
131+
132+
#### Output Example
133+
```json
134+
{
135+
"id" : "",
136+
"status" : "",
137+
"model" : "",
138+
"createdAt" : "2021-01-01T00:00:00",
139+
"updatedAt" : "2021-01-01T00:00:00",
140+
"title" : "",
141+
"output" : { },
142+
"outputSchema" : { },
143+
"stepCount" : 1,
144+
"lastStepSummary" : "",
145+
"isTaskSuccessful" : false,
146+
"liveUrl" : "",
147+
"recordingUrls" : [ "" ],
148+
"profileId" : "",
149+
"workspaceId" : "",
150+
"proxyCountryCode" : "",
151+
"maxCostUsd" : "",
152+
"totalInputTokens" : 1,
153+
"totalOutputTokens" : 1,
154+
"proxyUsedMb" : "",
155+
"llmCostUsd" : "",
156+
"proxyCostUsd" : "",
157+
"browserCostUsd" : "",
158+
"totalCostUsd" : "",
159+
"screenshotUrl" : "",
160+
"agentmailEmail" : ""
161+
}
162+
```
163+
164+
#### Find Session ID
165+
166+
To find the Session ID, click [here](/reference/components/browser-use_v1#how-to-find-the-session-id).
167+
168+
169+
170+
### Get Session
171+
Name: getSession
172+
173+
`Get session details.`
174+
175+
#### Properties
176+
177+
| Name | Label | Type | Description | Required |
178+
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
179+
| sessionId | Session ID | STRING | ID of an existing idle session. | true |
180+
181+
#### Example JSON Structure
182+
```json
183+
{
184+
"label" : "Get Session",
185+
"name" : "getSession",
186+
"parameters" : {
187+
"sessionId" : ""
188+
},
189+
"type" : "browserUse/v1/getSession"
190+
}
191+
```
192+
193+
#### Output
194+
195+
196+
197+
Type: OBJECT
198+
199+
200+
#### Properties
201+
202+
| Name | Type | Description |
203+
|:------------:|:------------:|:-------------------:|
204+
| id | STRING | Unique session identifier. |
205+
| status | STRING | Current session lifecycle status. |
206+
| model | STRING | The model tier used for this session. |
207+
| createdAt | DATE_TIME | When the session was created. |
208+
| updatedAt | DATE_TIME | When the session was last updated. |
209+
| title | STRING | Auto-generated short title summarizing the task. |
210+
| output | OBJECT <details> <summary> Properties </summary> &#123;&#125; </details> | The agent's final output. |
211+
| outputSchema | OBJECT <details> <summary> Properties </summary> &#123;&#125; </details> | The JSON Schema that was requested for structured output, if any. |
212+
| stepCount | INTEGER | Number of steps the agent has executed so far. |
213+
| lastStepSummary | STRING | Human-readable summary of the most recent agent step. |
214+
| isTaskSuccessful | BOOLEAN <details> <summary> Options </summary> <span>true</span>, <span>false</span> </details> | Whether the task completed successfully. |
215+
| liveUrl | STRING | URL to view the live browser session. |
216+
| recordingUrls | ARRAY <details> <summary> Items </summary> [STRING] </details> | URLs to download session recordings. |
217+
| profileId | STRING | ID of the browser profile loaded in this session, if any. |
218+
| workspaceId | STRING | ID of the workspace attached to this session, if any. |
219+
| proxyCountryCode | STRING | Country code of the proxy used for this session, or null if no proxy. |
220+
| maxCostUsd | STRING | Maximum cost limit in USD set for this session. |
221+
| totalInputTokens | INTEGER | Total LLM input tokens consumed by this session. |
222+
| totalOutputTokens | INTEGER | Total LLM output tokens consumed by this session. |
223+
| proxyUsedMb | STRING | Proxy bandwidth used in megabytes. |
224+
| llmCostUsd | STRING | Cost of LLM usage in USD. |
225+
| proxyCostUsd | STRING | Cost of proxy bandwidth in USD. |
226+
| browserCostUsd | STRING | Cost of browser compute time in USD. |
227+
| totalCostUsd | STRING | Total session cost in USD (LLM + proxy + browser). |
228+
| screenshotUrl | STRING | URL of the latest browser screenshot. |
229+
| agentmailEmail | STRING | Temporary email address provisioned for this session (via AgentMail). |
230+
231+
232+
233+
234+
#### Output Example
235+
```json
236+
{
237+
"id" : "",
238+
"status" : "",
239+
"model" : "",
240+
"createdAt" : "2021-01-01T00:00:00",
241+
"updatedAt" : "2021-01-01T00:00:00",
242+
"title" : "",
243+
"output" : { },
244+
"outputSchema" : { },
245+
"stepCount" : 1,
246+
"lastStepSummary" : "",
247+
"isTaskSuccessful" : false,
248+
"liveUrl" : "",
249+
"recordingUrls" : [ "" ],
250+
"profileId" : "",
251+
"workspaceId" : "",
252+
"proxyCountryCode" : "",
253+
"maxCostUsd" : "",
254+
"totalInputTokens" : 1,
255+
"totalOutputTokens" : 1,
256+
"proxyUsedMb" : "",
257+
"llmCostUsd" : "",
258+
"proxyCostUsd" : "",
259+
"browserCostUsd" : "",
260+
"totalCostUsd" : "",
261+
"screenshotUrl" : "",
262+
"agentmailEmail" : ""
263+
}
264+
```
265+
266+
#### Find Session ID
267+
268+
To find the Session ID, click [here](/reference/components/browser-use_v1#how-to-find-the-session-id).
269+
270+
271+
272+
273+
274+
## What to do if your action is not listed here?
275+
276+
If this component doesn't have the action you need, you can use **Custom Action** to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.
277+
278+
To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.
279+
280+
<hr />
281+
282+
# Additional Instructions
283+
284+
### How to find the Session ID
285+
286+
- **Method 1: Via API**
287+
288+
Use the `GET /sessions` endpoint to retrieve a list of all sessions and their IDs.
289+
290+
- **Method 2: Via UI**
291+
292+
Open your Browser Use dashboard and on the left bar your will find Agent Sessions. Open Agent Sessions and there you will find a list of sessions. The second column in the table is Session ID.
293+
294+
The Session ID can also be found in the output of the following actions:
295+
* **Create Session**
296+
* **Get Session**

0 commit comments

Comments
 (0)