browser-use-sdk 0.1.1 → 0.2.0

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 (168) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/README.md +10 -10
  3. package/client.d.mts +9 -6
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +9 -6
  6. package/client.d.ts.map +1 -1
  7. package/client.js +3 -0
  8. package/client.js.map +1 -1
  9. package/client.mjs +3 -0
  10. package/client.mjs.map +1 -1
  11. package/lib/parse.d.mts +5 -9
  12. package/lib/parse.d.mts.map +1 -1
  13. package/lib/parse.d.ts +5 -9
  14. package/lib/parse.d.ts.map +1 -1
  15. package/lib/parse.js +7 -7
  16. package/lib/parse.js.map +1 -1
  17. package/lib/parse.mjs +7 -7
  18. package/lib/parse.mjs.map +1 -1
  19. package/lib/stream.d.mts +15 -0
  20. package/lib/stream.d.mts.map +1 -0
  21. package/lib/stream.d.ts +15 -0
  22. package/lib/stream.d.ts.map +1 -0
  23. package/lib/stream.js +44 -0
  24. package/lib/stream.js.map +1 -0
  25. package/lib/stream.mjs +41 -0
  26. package/lib/stream.mjs.map +1 -0
  27. package/lib/types.d.mts +75 -0
  28. package/lib/types.d.mts.map +1 -0
  29. package/lib/types.d.ts +75 -0
  30. package/lib/types.d.ts.map +1 -0
  31. package/lib/types.js +14 -0
  32. package/lib/types.js.map +1 -0
  33. package/lib/types.mjs +10 -0
  34. package/lib/types.mjs.map +1 -0
  35. package/package.json +1 -1
  36. package/resources/agent-profiles.d.mts +94 -14
  37. package/resources/agent-profiles.d.mts.map +1 -1
  38. package/resources/agent-profiles.d.ts +94 -14
  39. package/resources/agent-profiles.d.ts.map +1 -1
  40. package/resources/agent-profiles.js +91 -6
  41. package/resources/agent-profiles.js.map +1 -1
  42. package/resources/agent-profiles.mjs +91 -6
  43. package/resources/agent-profiles.mjs.map +1 -1
  44. package/resources/browser-profiles.d.mts +91 -10
  45. package/resources/browser-profiles.d.mts.map +1 -1
  46. package/resources/browser-profiles.d.ts +91 -10
  47. package/resources/browser-profiles.d.ts.map +1 -1
  48. package/resources/browser-profiles.js +92 -6
  49. package/resources/browser-profiles.js.map +1 -1
  50. package/resources/browser-profiles.mjs +92 -6
  51. package/resources/browser-profiles.mjs.map +1 -1
  52. package/resources/index.d.mts +4 -3
  53. package/resources/index.d.mts.map +1 -1
  54. package/resources/index.d.ts +4 -3
  55. package/resources/index.d.ts.map +1 -1
  56. package/resources/index.js +3 -1
  57. package/resources/index.js.map +1 -1
  58. package/resources/index.mjs +1 -0
  59. package/resources/index.mjs.map +1 -1
  60. package/resources/sessions/index.d.mts +1 -1
  61. package/resources/sessions/index.d.mts.map +1 -1
  62. package/resources/sessions/index.d.ts +1 -1
  63. package/resources/sessions/index.d.ts.map +1 -1
  64. package/resources/sessions/index.js.map +1 -1
  65. package/resources/sessions/index.mjs.map +1 -1
  66. package/resources/sessions/public-share.d.mts +59 -6
  67. package/resources/sessions/public-share.d.mts.map +1 -1
  68. package/resources/sessions/public-share.d.ts +59 -6
  69. package/resources/sessions/public-share.d.ts.map +1 -1
  70. package/resources/sessions/public-share.js +62 -4
  71. package/resources/sessions/public-share.js.map +1 -1
  72. package/resources/sessions/public-share.mjs +62 -4
  73. package/resources/sessions/public-share.mjs.map +1 -1
  74. package/resources/sessions/sessions.d.mts +117 -22
  75. package/resources/sessions/sessions.d.mts.map +1 -1
  76. package/resources/sessions/sessions.d.ts +117 -22
  77. package/resources/sessions/sessions.d.ts.map +1 -1
  78. package/resources/sessions/sessions.js +80 -3
  79. package/resources/sessions/sessions.js.map +1 -1
  80. package/resources/sessions/sessions.mjs +80 -3
  81. package/resources/sessions/sessions.mjs.map +1 -1
  82. package/resources/tasks.d.mts +332 -108
  83. package/resources/tasks.d.mts.map +1 -1
  84. package/resources/tasks.d.ts +332 -108
  85. package/resources/tasks.d.ts.map +1 -1
  86. package/resources/tasks.js +207 -22
  87. package/resources/tasks.js.map +1 -1
  88. package/resources/tasks.mjs +207 -22
  89. package/resources/tasks.mjs.map +1 -1
  90. package/resources/users/index.d.mts +3 -0
  91. package/resources/users/index.d.mts.map +1 -0
  92. package/resources/users/index.d.ts +3 -0
  93. package/resources/users/index.d.ts.map +1 -0
  94. package/resources/users/index.js +9 -0
  95. package/resources/users/index.js.map +1 -0
  96. package/resources/users/index.mjs +4 -0
  97. package/resources/users/index.mjs.map +1 -0
  98. package/resources/users/me/files.d.mts +64 -0
  99. package/resources/users/me/files.d.mts.map +1 -0
  100. package/resources/users/me/files.d.ts +64 -0
  101. package/resources/users/me/files.d.ts.map +1 -0
  102. package/resources/users/me/files.js +43 -0
  103. package/resources/users/me/files.js.map +1 -0
  104. package/resources/users/me/files.mjs +39 -0
  105. package/resources/users/me/files.mjs.map +1 -0
  106. package/resources/users/me/index.d.mts +3 -0
  107. package/resources/users/me/index.d.mts.map +1 -0
  108. package/resources/users/me/index.d.ts +3 -0
  109. package/resources/users/me/index.d.ts.map +1 -0
  110. package/resources/users/me/index.js +9 -0
  111. package/resources/users/me/index.js.map +1 -0
  112. package/resources/users/me/index.mjs +4 -0
  113. package/resources/users/me/index.mjs.map +1 -0
  114. package/resources/users/me/me.d.mts +50 -0
  115. package/resources/users/me/me.d.mts.map +1 -0
  116. package/resources/users/me/me.d.ts +50 -0
  117. package/resources/users/me/me.d.ts.map +1 -0
  118. package/resources/users/me/me.js +41 -0
  119. package/resources/users/me/me.js.map +1 -0
  120. package/resources/users/me/me.mjs +36 -0
  121. package/resources/users/me/me.mjs.map +1 -0
  122. package/resources/users/me.d.mts +2 -0
  123. package/resources/users/me.d.mts.map +1 -0
  124. package/resources/users/me.d.ts +2 -0
  125. package/resources/users/me.d.ts.map +1 -0
  126. package/resources/users/me.js +6 -0
  127. package/resources/users/me.js.map +1 -0
  128. package/resources/users/me.mjs +3 -0
  129. package/resources/users/me.mjs.map +1 -0
  130. package/resources/users/users.d.mts +10 -0
  131. package/resources/users/users.d.mts.map +1 -0
  132. package/resources/users/users.d.ts +10 -0
  133. package/resources/users/users.d.ts.map +1 -0
  134. package/resources/users/users.js +17 -0
  135. package/resources/users/users.js.map +1 -0
  136. package/resources/users/users.mjs +12 -0
  137. package/resources/users/users.mjs.map +1 -0
  138. package/resources/users.d.mts +2 -0
  139. package/resources/users.d.mts.map +1 -0
  140. package/resources/users.d.ts +2 -0
  141. package/resources/users.d.ts.map +1 -0
  142. package/resources/users.js +6 -0
  143. package/resources/users.js.map +1 -0
  144. package/resources/users.mjs +3 -0
  145. package/resources/users.mjs.map +1 -0
  146. package/src/client.ts +21 -14
  147. package/src/lib/parse.ts +12 -24
  148. package/src/lib/stream.ts +70 -0
  149. package/src/lib/types.ts +73 -0
  150. package/src/resources/agent-profiles.ts +101 -19
  151. package/src/resources/browser-profiles.ts +95 -12
  152. package/src/resources/index.ts +9 -7
  153. package/src/resources/sessions/index.ts +1 -1
  154. package/src/resources/sessions/public-share.ts +64 -8
  155. package/src/resources/sessions/sessions.ts +130 -26
  156. package/src/resources/tasks.ts +479 -146
  157. package/src/resources/users/index.ts +4 -0
  158. package/src/resources/users/me/files.ts +95 -0
  159. package/src/resources/users/me/index.ts +4 -0
  160. package/src/resources/users/me/me.ts +68 -0
  161. package/src/resources/users/me.ts +3 -0
  162. package/src/resources/users/users.ts +15 -0
  163. package/src/resources/users.ts +3 -0
  164. package/src/version.ts +1 -1
  165. package/version.d.mts +1 -1
  166. package/version.d.ts +1 -1
  167. package/version.js +1 -1
  168. package/version.mjs +1 -1
@@ -3,25 +3,106 @@ import { APIPromise } from "../core/api-promise.js";
3
3
  import { RequestOptions } from "../internal/request-options.js";
4
4
  export declare class AgentProfiles extends APIResource {
5
5
  /**
6
- * Create Agent Profile
6
+ * Create a new agent profile for the authenticated user.
7
+ *
8
+ * Agent profiles define how your AI agents behave during tasks. You can create
9
+ * multiple profiles for different use cases (e.g., customer support, data
10
+ * analysis, web scraping). Free users can create 1 profile; paid users can create
11
+ * unlimited profiles.
12
+ *
13
+ * Key features you can configure:
14
+ *
15
+ * - System prompt: The core instructions that define the agent's personality and
16
+ * behavior
17
+ * - Allowed domains: Restrict which websites the agent can access
18
+ * - Max steps: Limit how many actions the agent can take in a single task
19
+ * - Vision: Enable/disable the agent's ability to see and analyze screenshots
20
+ * - Thinking: Enable/disable the agent's reasoning process
21
+ *
22
+ * Args:
23
+ *
24
+ * - request: The agent profile configuration including name, description, and
25
+ * behavior settings
26
+ *
27
+ * Returns:
28
+ *
29
+ * - The newly created agent profile with all its details
30
+ *
31
+ * Raises:
32
+ *
33
+ * - 402: If user needs a subscription to create additional profiles
7
34
  */
8
35
  create(body: AgentProfileCreateParams, options?: RequestOptions): APIPromise<AgentProfileView>;
9
36
  /**
10
- * Get Agent Profile
37
+ * Get a specific agent profile by its ID.
38
+ *
39
+ * Retrieves the complete details of an agent profile, including all its
40
+ * configuration settings like system prompts, allowed domains, and behavior flags.
41
+ *
42
+ * Args:
43
+ *
44
+ * - profile_id: The unique identifier of the agent profile
45
+ *
46
+ * Returns:
47
+ *
48
+ * - Complete agent profile information
49
+ *
50
+ * Raises:
51
+ *
52
+ * - 404: If the user agent profile doesn't exist
11
53
  */
12
54
  retrieve(profileID: string, options?: RequestOptions): APIPromise<AgentProfileView>;
13
55
  /**
14
- * Update Agent Profile
56
+ * Update an existing agent profile.
57
+ *
58
+ * Modify any aspect of an agent profile, such as its name, description, system
59
+ * prompt, or behavior settings. Only the fields you provide will be updated; other
60
+ * fields remain unchanged.
61
+ *
62
+ * Args:
63
+ *
64
+ * - profile_id: The unique identifier of the agent profile to update
65
+ * - request: The fields to update (only provided fields will be changed)
66
+ *
67
+ * Returns:
68
+ *
69
+ * - The updated agent profile with all its current details
70
+ *
71
+ * Raises:
72
+ *
73
+ * - 404: If the user agent profile doesn't exist
15
74
  */
16
75
  update(profileID: string, body: AgentProfileUpdateParams, options?: RequestOptions): APIPromise<AgentProfileView>;
17
76
  /**
18
- * List Agent Profiles
77
+ * Get a paginated list of all agent profiles for the authenticated user.
78
+ *
79
+ * Agent profiles define how your AI agents behave, including their personality,
80
+ * capabilities, and limitations. Use this endpoint to see all your configured
81
+ * agent profiles.
82
+ *
83
+ * Returns:
84
+ *
85
+ * - A paginated list of agent profiles
86
+ * - Total count of profiles
87
+ * - Page information for navigation
19
88
  */
20
89
  list(query?: AgentProfileListParams | null | undefined, options?: RequestOptions): APIPromise<AgentProfileListResponse>;
21
90
  /**
22
- * Delete Agent Profile
91
+ * Delete an agent profile.
92
+ *
93
+ * Permanently removes an agent profile and all its configuration. This action
94
+ * cannot be undone. Any tasks that were using this profile will continue to work,
95
+ * but you won't be able to create new tasks with the deleted profile.
96
+ *
97
+ * Args:
98
+ *
99
+ * - profile_id: The unique identifier of the agent profile to delete
100
+ *
101
+ * Returns:
102
+ *
103
+ * - 204 No Content on successful deletion (idempotent)
23
104
  */
24
- delete(profileID: string, options?: RequestOptions): APIPromise<unknown>;
105
+ delete(profileID: string, options?: RequestOptions): APIPromise<void>;
25
106
  }
26
107
  /**
27
108
  * View model for representing an agent profile
@@ -32,20 +113,20 @@ export declare class AgentProfiles extends APIResource {
32
113
  * max_agent_steps: Maximum number of steps the agent can take before stopping
33
114
  * allowed_domains: List of domains the agent is allowed to access flash_mode:
34
115
  * Whether flash mode is enabled thinking: Whether thinking mode is enabled vision:
35
- * Whether vision capabilities are enabled system_prompt: Custom system prompt for
36
- * the agent (optionally set by the user) created_at: Timestamp when the profile
37
- * was created updated_at: Timestamp when the profile was last updated
116
+ * Whether vision capabilities are enabled custom_system_prompt_extension: Optional
117
+ * custom system prompt for the agent created_at: Timestamp when the profile was
118
+ * created updated_at: Timestamp when the profile was last updated
38
119
  */
39
120
  export interface AgentProfileView {
40
121
  id: string;
41
122
  allowedDomains: Array<string>;
42
123
  createdAt: string;
124
+ customSystemPromptExtension: string;
43
125
  description: string;
44
126
  flashMode: boolean;
45
127
  highlightElements: boolean;
46
128
  maxAgentSteps: number;
47
129
  name: string;
48
- systemPrompt: string;
49
130
  thinking: boolean;
50
131
  updatedAt: string;
51
132
  vision: boolean;
@@ -61,26 +142,25 @@ export interface AgentProfileListResponse {
61
142
  pageSize: number;
62
143
  totalItems: number;
63
144
  }
64
- export type AgentProfileDeleteResponse = unknown;
65
145
  export interface AgentProfileCreateParams {
66
146
  name: string;
67
147
  allowedDomains?: Array<string>;
148
+ customSystemPromptExtension?: string;
68
149
  description?: string;
69
150
  flashMode?: boolean;
70
151
  highlightElements?: boolean;
71
152
  maxAgentSteps?: number;
72
- systemPrompt?: string;
73
153
  thinking?: boolean;
74
154
  vision?: boolean;
75
155
  }
76
156
  export interface AgentProfileUpdateParams {
77
157
  allowedDomains?: Array<string> | null;
158
+ customSystemPromptExtension?: string | null;
78
159
  description?: string | null;
79
160
  flashMode?: boolean | null;
80
161
  highlightElements?: boolean | null;
81
162
  maxAgentSteps?: number | null;
82
163
  name?: string | null;
83
- systemPrompt?: string | null;
84
164
  thinking?: boolean | null;
85
165
  vision?: boolean | null;
86
166
  }
@@ -89,6 +169,6 @@ export interface AgentProfileListParams {
89
169
  pageSize?: number;
90
170
  }
91
171
  export declare namespace AgentProfiles {
92
- export { type AgentProfileView as AgentProfileView, type AgentProfileListResponse as AgentProfileListResponse, type AgentProfileDeleteResponse as AgentProfileDeleteResponse, type AgentProfileCreateParams as AgentProfileCreateParams, type AgentProfileUpdateParams as AgentProfileUpdateParams, type AgentProfileListParams as AgentProfileListParams, };
172
+ export { type AgentProfileView as AgentProfileView, type AgentProfileListResponse as AgentProfileListResponse, type AgentProfileCreateParams as AgentProfileCreateParams, type AgentProfileUpdateParams as AgentProfileUpdateParams, type AgentProfileListParams as AgentProfileListParams, };
93
173
  }
94
174
  //# sourceMappingURL=agent-profiles.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"agent-profiles.d.ts","sourceRoot":"","sources":["../src/resources/agent-profiles.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAI9F;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAInF;;OAEG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAGzE;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IAEX,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;IAEpB,SAAS,EAAE,OAAO,CAAC;IAEnB,iBAAiB,EAAE,OAAO,CAAC;IAE3B,aAAa,EAAE,MAAM,CAAC;IAEtB,IAAI,EAAE,MAAM,CAAC;IAEb,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,EAAE,OAAO,CAAC;IAElB,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAE/B,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAAC;AAEjD,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IAEb,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,wBAAwB;IACvC,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEtC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B,iBAAiB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEnC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
1
+ {"version":3,"file":"agent-profiles.d.ts","sourceRoot":"","sources":["../src/resources/agent-profiles.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAI9F;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAInF;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMtE;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IAEX,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B,SAAS,EAAE,MAAM,CAAC;IAElB,2BAA2B,EAAE,MAAM,CAAC;IAEpC,WAAW,EAAE,MAAM,CAAC;IAEpB,SAAS,EAAE,OAAO,CAAC;IAEnB,iBAAiB,EAAE,OAAO,CAAC;IAE3B,aAAa,EAAE,MAAM,CAAC;IAEtB,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,EAAE,OAAO,CAAC;IAElB,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAE/B,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IAEb,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,wBAAwB;IACvC,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEtC,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B,iBAAiB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEnC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
@@ -3,37 +3,122 @@
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.AgentProfiles = void 0;
5
5
  const resource_1 = require("../core/resource.js");
6
+ const headers_1 = require("../internal/headers.js");
6
7
  const path_1 = require("../internal/utils/path.js");
7
8
  class AgentProfiles extends resource_1.APIResource {
8
9
  /**
9
- * Create Agent Profile
10
+ * Create a new agent profile for the authenticated user.
11
+ *
12
+ * Agent profiles define how your AI agents behave during tasks. You can create
13
+ * multiple profiles for different use cases (e.g., customer support, data
14
+ * analysis, web scraping). Free users can create 1 profile; paid users can create
15
+ * unlimited profiles.
16
+ *
17
+ * Key features you can configure:
18
+ *
19
+ * - System prompt: The core instructions that define the agent's personality and
20
+ * behavior
21
+ * - Allowed domains: Restrict which websites the agent can access
22
+ * - Max steps: Limit how many actions the agent can take in a single task
23
+ * - Vision: Enable/disable the agent's ability to see and analyze screenshots
24
+ * - Thinking: Enable/disable the agent's reasoning process
25
+ *
26
+ * Args:
27
+ *
28
+ * - request: The agent profile configuration including name, description, and
29
+ * behavior settings
30
+ *
31
+ * Returns:
32
+ *
33
+ * - The newly created agent profile with all its details
34
+ *
35
+ * Raises:
36
+ *
37
+ * - 402: If user needs a subscription to create additional profiles
10
38
  */
11
39
  create(body, options) {
12
40
  return this._client.post('/agent-profiles', { body, ...options });
13
41
  }
14
42
  /**
15
- * Get Agent Profile
43
+ * Get a specific agent profile by its ID.
44
+ *
45
+ * Retrieves the complete details of an agent profile, including all its
46
+ * configuration settings like system prompts, allowed domains, and behavior flags.
47
+ *
48
+ * Args:
49
+ *
50
+ * - profile_id: The unique identifier of the agent profile
51
+ *
52
+ * Returns:
53
+ *
54
+ * - Complete agent profile information
55
+ *
56
+ * Raises:
57
+ *
58
+ * - 404: If the user agent profile doesn't exist
16
59
  */
17
60
  retrieve(profileID, options) {
18
61
  return this._client.get((0, path_1.path) `/agent-profiles/${profileID}`, options);
19
62
  }
20
63
  /**
21
- * Update Agent Profile
64
+ * Update an existing agent profile.
65
+ *
66
+ * Modify any aspect of an agent profile, such as its name, description, system
67
+ * prompt, or behavior settings. Only the fields you provide will be updated; other
68
+ * fields remain unchanged.
69
+ *
70
+ * Args:
71
+ *
72
+ * - profile_id: The unique identifier of the agent profile to update
73
+ * - request: The fields to update (only provided fields will be changed)
74
+ *
75
+ * Returns:
76
+ *
77
+ * - The updated agent profile with all its current details
78
+ *
79
+ * Raises:
80
+ *
81
+ * - 404: If the user agent profile doesn't exist
22
82
  */
23
83
  update(profileID, body, options) {
24
84
  return this._client.patch((0, path_1.path) `/agent-profiles/${profileID}`, { body, ...options });
25
85
  }
26
86
  /**
27
- * List Agent Profiles
87
+ * Get a paginated list of all agent profiles for the authenticated user.
88
+ *
89
+ * Agent profiles define how your AI agents behave, including their personality,
90
+ * capabilities, and limitations. Use this endpoint to see all your configured
91
+ * agent profiles.
92
+ *
93
+ * Returns:
94
+ *
95
+ * - A paginated list of agent profiles
96
+ * - Total count of profiles
97
+ * - Page information for navigation
28
98
  */
29
99
  list(query = {}, options) {
30
100
  return this._client.get('/agent-profiles', { query, ...options });
31
101
  }
32
102
  /**
33
- * Delete Agent Profile
103
+ * Delete an agent profile.
104
+ *
105
+ * Permanently removes an agent profile and all its configuration. This action
106
+ * cannot be undone. Any tasks that were using this profile will continue to work,
107
+ * but you won't be able to create new tasks with the deleted profile.
108
+ *
109
+ * Args:
110
+ *
111
+ * - profile_id: The unique identifier of the agent profile to delete
112
+ *
113
+ * Returns:
114
+ *
115
+ * - 204 No Content on successful deletion (idempotent)
34
116
  */
35
117
  delete(profileID, options) {
36
- return this._client.delete((0, path_1.path) `/agent-profiles/${profileID}`, options);
118
+ return this._client.delete((0, path_1.path) `/agent-profiles/${profileID}`, {
119
+ ...options,
120
+ headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
121
+ });
37
122
  }
38
123
  }
39
124
  exports.AgentProfiles = AgentProfiles;
@@ -1 +1 @@
1
- {"version":3,"file":"agent-profiles.js","sourceRoot":"","sources":["../src/resources/agent-profiles.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;OAEG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,SAAiB,EACjB,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,mBAAmB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,SAAiB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,mBAAmB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF;AA1CD,sCA0CC"}
1
+ {"version":3,"file":"agent-profiles.js","sourceRoot":"","sources":["../src/resources/agent-profiles.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,SAAiB,EACjB,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,mBAAmB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,SAAiB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,mBAAmB,SAAS,EAAE,EAAE;YAC7D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA9HD,sCA8HC"}
@@ -1,36 +1,121 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
  import { APIResource } from "../core/resource.mjs";
3
+ import { buildHeaders } from "../internal/headers.mjs";
3
4
  import { path } from "../internal/utils/path.mjs";
4
5
  export class AgentProfiles extends APIResource {
5
6
  /**
6
- * Create Agent Profile
7
+ * Create a new agent profile for the authenticated user.
8
+ *
9
+ * Agent profiles define how your AI agents behave during tasks. You can create
10
+ * multiple profiles for different use cases (e.g., customer support, data
11
+ * analysis, web scraping). Free users can create 1 profile; paid users can create
12
+ * unlimited profiles.
13
+ *
14
+ * Key features you can configure:
15
+ *
16
+ * - System prompt: The core instructions that define the agent's personality and
17
+ * behavior
18
+ * - Allowed domains: Restrict which websites the agent can access
19
+ * - Max steps: Limit how many actions the agent can take in a single task
20
+ * - Vision: Enable/disable the agent's ability to see and analyze screenshots
21
+ * - Thinking: Enable/disable the agent's reasoning process
22
+ *
23
+ * Args:
24
+ *
25
+ * - request: The agent profile configuration including name, description, and
26
+ * behavior settings
27
+ *
28
+ * Returns:
29
+ *
30
+ * - The newly created agent profile with all its details
31
+ *
32
+ * Raises:
33
+ *
34
+ * - 402: If user needs a subscription to create additional profiles
7
35
  */
8
36
  create(body, options) {
9
37
  return this._client.post('/agent-profiles', { body, ...options });
10
38
  }
11
39
  /**
12
- * Get Agent Profile
40
+ * Get a specific agent profile by its ID.
41
+ *
42
+ * Retrieves the complete details of an agent profile, including all its
43
+ * configuration settings like system prompts, allowed domains, and behavior flags.
44
+ *
45
+ * Args:
46
+ *
47
+ * - profile_id: The unique identifier of the agent profile
48
+ *
49
+ * Returns:
50
+ *
51
+ * - Complete agent profile information
52
+ *
53
+ * Raises:
54
+ *
55
+ * - 404: If the user agent profile doesn't exist
13
56
  */
14
57
  retrieve(profileID, options) {
15
58
  return this._client.get(path `/agent-profiles/${profileID}`, options);
16
59
  }
17
60
  /**
18
- * Update Agent Profile
61
+ * Update an existing agent profile.
62
+ *
63
+ * Modify any aspect of an agent profile, such as its name, description, system
64
+ * prompt, or behavior settings. Only the fields you provide will be updated; other
65
+ * fields remain unchanged.
66
+ *
67
+ * Args:
68
+ *
69
+ * - profile_id: The unique identifier of the agent profile to update
70
+ * - request: The fields to update (only provided fields will be changed)
71
+ *
72
+ * Returns:
73
+ *
74
+ * - The updated agent profile with all its current details
75
+ *
76
+ * Raises:
77
+ *
78
+ * - 404: If the user agent profile doesn't exist
19
79
  */
20
80
  update(profileID, body, options) {
21
81
  return this._client.patch(path `/agent-profiles/${profileID}`, { body, ...options });
22
82
  }
23
83
  /**
24
- * List Agent Profiles
84
+ * Get a paginated list of all agent profiles for the authenticated user.
85
+ *
86
+ * Agent profiles define how your AI agents behave, including their personality,
87
+ * capabilities, and limitations. Use this endpoint to see all your configured
88
+ * agent profiles.
89
+ *
90
+ * Returns:
91
+ *
92
+ * - A paginated list of agent profiles
93
+ * - Total count of profiles
94
+ * - Page information for navigation
25
95
  */
26
96
  list(query = {}, options) {
27
97
  return this._client.get('/agent-profiles', { query, ...options });
28
98
  }
29
99
  /**
30
- * Delete Agent Profile
100
+ * Delete an agent profile.
101
+ *
102
+ * Permanently removes an agent profile and all its configuration. This action
103
+ * cannot be undone. Any tasks that were using this profile will continue to work,
104
+ * but you won't be able to create new tasks with the deleted profile.
105
+ *
106
+ * Args:
107
+ *
108
+ * - profile_id: The unique identifier of the agent profile to delete
109
+ *
110
+ * Returns:
111
+ *
112
+ * - 204 No Content on successful deletion (idempotent)
31
113
  */
32
114
  delete(profileID, options) {
33
- return this._client.delete(path `/agent-profiles/${profileID}`, options);
115
+ return this._client.delete(path `/agent-profiles/${profileID}`, {
116
+ ...options,
117
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
118
+ });
34
119
  }
35
120
  }
36
121
  //# sourceMappingURL=agent-profiles.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"agent-profiles.mjs","sourceRoot":"","sources":["../src/resources/agent-profiles.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,SAAiB,EACjB,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,mBAAmB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,SAAiB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,mBAAmB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF"}
1
+ {"version":3,"file":"agent-profiles.mjs","sourceRoot":"","sources":["../src/resources/agent-profiles.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,SAAiB,EACjB,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,mBAAmB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,SAAiB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,mBAAmB,SAAS,EAAE,EAAE;YAC7D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -3,25 +3,107 @@ import { APIPromise } from "../core/api-promise.mjs";
3
3
  import { RequestOptions } from "../internal/request-options.mjs";
4
4
  export declare class BrowserProfiles extends APIResource {
5
5
  /**
6
- * Create Browser Profile
6
+ * Create a new browser profile for the authenticated user.
7
+ *
8
+ * Browser profiles define how your web browsers behave during AI agent tasks. You
9
+ * can create multiple profiles for different use cases (e.g., mobile testing,
10
+ * desktop browsing, proxy-enabled scraping). Free users can create up to 10
11
+ * profiles; paid users can create unlimited profiles.
12
+ *
13
+ * Key features you can configure:
14
+ *
15
+ * - Viewport dimensions: Set the browser window size for consistent rendering
16
+ * - Mobile emulation: Enable mobile device simulation
17
+ * - Proxy settings: Route traffic through specific locations or proxy servers
18
+ * - Ad blocking: Enable/disable ad blocking for cleaner browsing
19
+ * - Cache persistence: Choose whether to save browser data between sessions
20
+ *
21
+ * Args:
22
+ *
23
+ * - request: The browser profile configuration including name, description, and
24
+ * browser settings
25
+ *
26
+ * Returns:
27
+ *
28
+ * - The newly created browser profile with all its details
29
+ *
30
+ * Raises:
31
+ *
32
+ * - 402: If user needs a subscription to create additional profiles
7
33
  */
8
34
  create(body: BrowserProfileCreateParams, options?: RequestOptions): APIPromise<BrowserProfileView>;
9
35
  /**
10
- * Get Browser Profile
36
+ * Get a specific browser profile by its ID.
37
+ *
38
+ * Retrieves the complete details of a browser profile, including all its
39
+ * configuration settings like viewport dimensions, proxy settings, and behavior
40
+ * flags.
41
+ *
42
+ * Args:
43
+ *
44
+ * - profile_id: The unique identifier of the browser profile
45
+ *
46
+ * Returns:
47
+ *
48
+ * - Complete browser profile information
49
+ *
50
+ * Raises:
51
+ *
52
+ * - 404: If the user browser profile doesn't exist
11
53
  */
12
54
  retrieve(profileID: string, options?: RequestOptions): APIPromise<BrowserProfileView>;
13
55
  /**
14
- * Update Browser Profile
56
+ * Update an existing browser profile.
57
+ *
58
+ * Modify any aspect of a browser profile, such as its name, description, viewport
59
+ * settings, or proxy configuration. Only the fields you provide will be updated;
60
+ * other fields remain unchanged.
61
+ *
62
+ * Args:
63
+ *
64
+ * - profile_id: The unique identifier of the browser profile to update
65
+ * - request: The fields to update (only provided fields will be changed)
66
+ *
67
+ * Returns:
68
+ *
69
+ * - The updated browser profile with all its current details
70
+ *
71
+ * Raises:
72
+ *
73
+ * - 404: If the user browser profile doesn't exist
15
74
  */
16
75
  update(profileID: string, body: BrowserProfileUpdateParams, options?: RequestOptions): APIPromise<BrowserProfileView>;
17
76
  /**
18
- * List Browser Profiles
77
+ * Get a paginated list of all browser profiles for the authenticated user.
78
+ *
79
+ * Browser profiles define how your web browsers behave during AI agent tasks,
80
+ * including settings like viewport size, mobile emulation, proxy configuration,
81
+ * and ad blocking. Use this endpoint to see all your configured browser profiles.
82
+ *
83
+ * Returns:
84
+ *
85
+ * - A paginated list of browser profiles
86
+ * - Total count of profiles
87
+ * - Page information for navigation
19
88
  */
20
89
  list(query?: BrowserProfileListParams | null | undefined, options?: RequestOptions): APIPromise<BrowserProfileListResponse>;
21
90
  /**
22
- * Delete Browser Profile
91
+ * Delete a browser profile.
92
+ *
93
+ * Permanently removes a browser profile and all its configuration. This action
94
+ * cannot be undone. The profile will also be removed from the browser service. Any
95
+ * active sessions using this profile will continue to work, but you won't be able
96
+ * to create new sessions with the deleted profile.
97
+ *
98
+ * Args:
99
+ *
100
+ * - profile_id: The unique identifier of the browser profile to delete
101
+ *
102
+ * Returns:
103
+ *
104
+ * - 204 No Content on successful deletion (idempotent)
23
105
  */
24
- delete(profileID: string, options?: RequestOptions): APIPromise<unknown>;
106
+ delete(profileID: string, options?: RequestOptions): APIPromise<void>;
25
107
  }
26
108
  /**
27
109
  * View model for representing a browser profile
@@ -33,8 +115,8 @@ export declare class BrowserProfiles extends APIResource {
33
115
  * proxy location store_cache: Whether to store browser cache
34
116
  * browser_viewport_width: Browser viewport width in pixels
35
117
  * browser_viewport_height: Browser viewport height in pixels is_mobile: Whether
36
- * the browser is mobile view created_at: Timestamp when the profile was created
37
- * updated_at: Timestamp when the profile was last updated
118
+ * the browser should be in mobile view created_at: Timestamp when the profile was
119
+ * created updated_at: Timestamp when the profile was last updated
38
120
  */
39
121
  export interface BrowserProfileView {
40
122
  id: string;
@@ -63,7 +145,6 @@ export interface BrowserProfileListResponse {
63
145
  pageSize: number;
64
146
  totalItems: number;
65
147
  }
66
- export type BrowserProfileDeleteResponse = unknown;
67
148
  export interface BrowserProfileCreateParams {
68
149
  name: string;
69
150
  adBlocker?: boolean;
@@ -93,6 +174,6 @@ export interface BrowserProfileListParams {
93
174
  pageSize?: number;
94
175
  }
95
176
  export declare namespace BrowserProfiles {
96
- export { type BrowserProfileView as BrowserProfileView, type ProxyCountryCode as ProxyCountryCode, type BrowserProfileListResponse as BrowserProfileListResponse, type BrowserProfileDeleteResponse as BrowserProfileDeleteResponse, type BrowserProfileCreateParams as BrowserProfileCreateParams, type BrowserProfileUpdateParams as BrowserProfileUpdateParams, type BrowserProfileListParams as BrowserProfileListParams, };
177
+ export { type BrowserProfileView as BrowserProfileView, type ProxyCountryCode as ProxyCountryCode, type BrowserProfileListResponse as BrowserProfileListResponse, type BrowserProfileCreateParams as BrowserProfileCreateParams, type BrowserProfileUpdateParams as BrowserProfileUpdateParams, type BrowserProfileListParams as BrowserProfileListParams, };
97
178
  }
98
179
  //# sourceMappingURL=browser-profiles.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"browser-profiles.d.mts","sourceRoot":"","sources":["../src/resources/browser-profiles.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAIlG;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAIrF;;OAEG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAGzE;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,OAAO,CAAC;IAEnB,qBAAqB,EAAE,MAAM,CAAC;IAE9B,oBAAoB,EAAE,MAAM,CAAC;IAE7B,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;IAEpB,QAAQ,EAAE,OAAO,CAAC;IAElB,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,OAAO,CAAC;IAEjB,KAAK,EAAE,OAAO,CAAC;IAEf,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC,UAAU,EAAE,OAAO,CAAC;IAEpB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,gBAAgB,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;AAEnG;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,KAAK,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEjC,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,4BAA4B,GAAG,OAAO,CAAC;AAEnD,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,0BAA0B;IACzC,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEzB,KAAK,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEvB,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE3C,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,wBAAwB;IACvC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
1
+ {"version":3,"file":"browser-profiles.d.mts","sourceRoot":"","sources":["../src/resources/browser-profiles.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAIlG;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAIrF;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMtE;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,OAAO,CAAC;IAEnB,qBAAqB,EAAE,MAAM,CAAC;IAE9B,oBAAoB,EAAE,MAAM,CAAC;IAE7B,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;IAEpB,QAAQ,EAAE,OAAO,CAAC;IAElB,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,OAAO,CAAC;IAEjB,KAAK,EAAE,OAAO,CAAC;IAEf,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC,UAAU,EAAE,OAAO,CAAC;IAEpB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,gBAAgB,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;AAEnG;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,KAAK,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEjC,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,0BAA0B;IACzC,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEzB,KAAK,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEvB,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE3C,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,wBAAwB;IACvC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}