1
1
# Reference
2
2
3
- ## Account
3
+ ## Accounts
4
4
5
- <details ><summary ><code >client.account .<a href =" /src/api/resources/account /client/Client.ts " >getAccountMe</a >() -> BrowserUse.AccountView</code ></summary >
5
+ <details ><summary ><code >client.accounts .<a href =" /src/api/resources/accounts /client/Client.ts " >getAccountMe</a >() -> BrowserUse.AccountView</code ></summary >
6
6
<dl >
7
7
<dd >
8
8
@@ -30,7 +30,7 @@ Get authenticated account information including credit balances and account deta
30
30
<dd >
31
31
32
32
``` typescript
33
- await client .account .getAccountMe ();
33
+ await client .accounts .getAccountMe ();
34
34
```
35
35
36
36
</dd >
@@ -46,7 +46,7 @@ await client.account.getAccountMe();
46
46
<dl >
47
47
<dd >
48
48
49
- ** requestOptions:** ` Account .RequestOptions`
49
+ ** requestOptions:** ` Accounts .RequestOptions`
50
50
51
51
</dd >
52
52
</dl >
@@ -453,7 +453,7 @@ await client.sessions.listSessions();
453
453
</dl >
454
454
</details >
455
455
456
- <details ><summary ><code >client.sessions.<a href =" /src/api/resources/sessions/client/Client.ts " >createSession</a >({ ...params }) -> BrowserUse.SessionView </code ></summary >
456
+ <details ><summary ><code >client.sessions.<a href =" /src/api/resources/sessions/client/Client.ts " >createSession</a >({ ...params }) -> BrowserUse.SessionItemView </code ></summary >
457
457
<dl >
458
458
<dd >
459
459
@@ -979,7 +979,7 @@ await client.files.userUploadFilePresignedUrl("session_id", {
979
979
</dl >
980
980
</details >
981
981
982
- <details ><summary ><code >client.files.<a href =" /src/api/resources/files/client/Client.ts " >getTaskUserUploadedFilePresignedUrl </a >(taskId, fileId) -> BrowserUse.TaskUploadedFileResponse </code ></summary >
982
+ <details ><summary ><code >client.files.<a href =" /src/api/resources/files/client/Client.ts " >getTaskOutputFilePresignedUrl </a >(taskId, fileId) -> BrowserUse.TaskOutputFileResponse </code ></summary >
983
983
<dl >
984
984
<dd >
985
985
@@ -991,7 +991,7 @@ await client.files.userUploadFilePresignedUrl("session_id", {
991
991
<dl >
992
992
<dd >
993
993
994
- Get secure download URL for a user uploaded file used in the task .
994
+ Get secure download URL for an output file generated by the AI agent .
995
995
996
996
</dd >
997
997
</dl >
@@ -1007,7 +1007,7 @@ Get secure download URL for a user uploaded file used in the task.
1007
1007
<dd >
1008
1008
1009
1009
``` typescript
1010
- await client .files .getTaskUserUploadedFilePresignedUrl (" task_id" , " file_id" );
1010
+ await client .files .getTaskOutputFilePresignedUrl (" task_id" , " file_id" );
1011
1011
```
1012
1012
1013
1013
</dd >
@@ -1050,7 +1050,9 @@ await client.files.getTaskUserUploadedFilePresignedUrl("task_id", "file_id");
1050
1050
</dl >
1051
1051
</details >
1052
1052
1053
- <details ><summary ><code >client.files.<a href =" /src/api/resources/files/client/Client.ts " >getTaskOutputFilePresignedUrl</a >(taskId, fileId) -> BrowserUse.TaskOutputFileResponse</code ></summary >
1053
+ ## Profiles
1054
+
1055
+ <details ><summary ><code >client.profiles.<a href =" /src/api/resources/profiles/client/Client.ts " >listProfiles</a >({ ...params }) -> BrowserUse.ProfileListResponse</code ></summary >
1054
1056
<dl >
1055
1057
<dd >
1056
1058
@@ -1062,7 +1064,7 @@ await client.files.getTaskUserUploadedFilePresignedUrl("task_id", "file_id");
1062
1064
<dl >
1063
1065
<dd >
1064
1066
1065
- Get secure download URL for an output file generated by the AI agent .
1067
+ Get paginated list of profiles .
1066
1068
1067
1069
</dd >
1068
1070
</dl >
@@ -1078,7 +1080,7 @@ Get secure download URL for an output file generated by the AI agent.
1078
1080
<dd >
1079
1081
1080
1082
``` typescript
1081
- await client .files . getTaskOutputFilePresignedUrl ( " task_id " , " file_id " );
1083
+ await client .profiles . listProfiles ( );
1082
1084
```
1083
1085
1084
1086
</dd >
@@ -1094,23 +1096,15 @@ await client.files.getTaskOutputFilePresignedUrl("task_id", "file_id");
1094
1096
<dl >
1095
1097
<dd >
1096
1098
1097
- ** taskId:** ` string `
1098
-
1099
- </dd >
1100
- </dl >
1101
-
1102
- <dl >
1103
- <dd >
1104
-
1105
- ** fileId:** ` string `
1099
+ ** request:** ` BrowserUse.ListProfilesProfilesGetRequest `
1106
1100
1107
1101
</dd >
1108
1102
</dl >
1109
1103
1110
1104
<dl >
1111
1105
<dd >
1112
1106
1113
- ** requestOptions:** ` Files .RequestOptions`
1107
+ ** requestOptions:** ` Profiles .RequestOptions`
1114
1108
1115
1109
</dd >
1116
1110
</dl >
@@ -1121,9 +1115,7 @@ await client.files.getTaskOutputFilePresignedUrl("task_id", "file_id");
1121
1115
</dl >
1122
1116
</details >
1123
1117
1124
- ## Profiles
1125
-
1126
- <details ><summary ><code >client.profiles.<a href =" /src/api/resources/profiles/client/Client.ts " >listProfiles</a >({ ...params }) -> BrowserUse.ProfileListResponse</code ></summary >
1118
+ <details ><summary ><code >client.profiles.<a href =" /src/api/resources/profiles/client/Client.ts " >createProfile</a >() -> BrowserUse.ProfileView</code ></summary >
1127
1119
<dl >
1128
1120
<dd >
1129
1121
@@ -1135,7 +1127,12 @@ await client.files.getTaskOutputFilePresignedUrl("task_id", "file_id");
1135
1127
<dl >
1136
1128
<dd >
1137
1129
1138
- Get paginated list of profiles.
1130
+ Profiles allow you to preserve the state of the browser between tasks.
1131
+
1132
+ They are most commonly used to allow users to preserve the log-in state in the agent between tasks.
1133
+ You'd normally create one profile per user and then use it for all their tasks.
1134
+
1135
+ You can create a new profile by calling this endpoint.
1139
1136
1140
1137
</dd >
1141
1138
</dl >
@@ -1151,7 +1148,7 @@ Get paginated list of profiles.
1151
1148
<dd >
1152
1149
1153
1150
``` typescript
1154
- await client .profiles .listProfiles ();
1151
+ await client .profiles .createProfile ();
1155
1152
```
1156
1153
1157
1154
</dd >
@@ -1167,14 +1164,6 @@ await client.profiles.listProfiles();
1167
1164
<dl >
1168
1165
<dd >
1169
1166
1170
- ** request:** ` BrowserUse.ListProfilesProfilesGetRequest `
1171
-
1172
- </dd >
1173
- </dl >
1174
-
1175
- <dl >
1176
- <dd >
1177
-
1178
1167
** requestOptions:** ` Profiles.RequestOptions `
1179
1168
1180
1169
</dd >
@@ -1186,7 +1175,7 @@ await client.profiles.listProfiles();
1186
1175
</dl >
1187
1176
</details >
1188
1177
1189
- <details ><summary ><code >client.profiles.<a href =" /src/api/resources/profiles/client/Client.ts " >createProfile </a >() -> BrowserUse.ProfileView</code ></summary >
1178
+ <details ><summary ><code >client.profiles.<a href =" /src/api/resources/profiles/client/Client.ts " >getProfile </a >(profileId ) -> BrowserUse.ProfileView</code ></summary >
1190
1179
<dl >
1191
1180
<dd >
1192
1181
@@ -1198,12 +1187,7 @@ await client.profiles.listProfiles();
1198
1187
<dl >
1199
1188
<dd >
1200
1189
1201
- Profiles allow you to preserve the state of the browser between tasks.
1202
-
1203
- They are most commonly used to allow users to preserve the log-in state in the agent between tasks.
1204
- You'd normally create one profile per user and then use it for all their tasks.
1205
-
1206
- You can create a new profile by calling this endpoint.
1190
+ Get profile details.
1207
1191
1208
1192
</dd >
1209
1193
</dl >
@@ -1219,7 +1203,7 @@ You can create a new profile by calling this endpoint.
1219
1203
<dd >
1220
1204
1221
1205
``` typescript
1222
- await client .profiles .createProfile ( );
1206
+ await client .profiles .getProfile ( " profile_id " );
1223
1207
```
1224
1208
1225
1209
</dd >
@@ -1235,6 +1219,14 @@ await client.profiles.createProfile();
1235
1219
<dl >
1236
1220
<dd >
1237
1221
1222
+ ** profileId:** ` string `
1223
+
1224
+ </dd >
1225
+ </dl >
1226
+
1227
+ <dl >
1228
+ <dd >
1229
+
1238
1230
** requestOptions:** ` Profiles.RequestOptions `
1239
1231
1240
1232
</dd >
@@ -1246,7 +1238,7 @@ await client.profiles.createProfile();
1246
1238
</dl >
1247
1239
</details >
1248
1240
1249
- <details ><summary ><code >client.profiles.<a href =" /src/api/resources/profiles/client/Client.ts " >getProfile </a >(profileId) -> BrowserUse.ProfileView </code ></summary >
1241
+ <details ><summary ><code >client.profiles.<a href =" /src/api/resources/profiles/client/Client.ts " >deleteBrowserProfile </a >(profileId) -> void </code ></summary >
1250
1242
<dl >
1251
1243
<dd >
1252
1244
@@ -1258,7 +1250,7 @@ await client.profiles.createProfile();
1258
1250
<dl >
1259
1251
<dd >
1260
1252
1261
- Get profile details .
1253
+ Permanently delete a browser profile and its configuration .
1262
1254
1263
1255
</dd >
1264
1256
</dl >
@@ -1274,7 +1266,7 @@ Get profile details.
1274
1266
<dd >
1275
1267
1276
1268
``` typescript
1277
- await client .profiles .getProfile (" profile_id" );
1269
+ await client .profiles .deleteBrowserProfile (" profile_id" );
1278
1270
```
1279
1271
1280
1272
</dd >
0 commit comments