@nimble-way/nimble-js 0.20.0 → 1.0.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 (252) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/README.md +10 -10
  3. package/client.d.mts +10 -39
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +10 -39
  6. package/client.d.ts.map +1 -1
  7. package/client.js +8 -43
  8. package/client.js.map +1 -1
  9. package/client.mjs +8 -43
  10. package/client.mjs.map +1 -1
  11. package/package.json +1 -1
  12. package/resources/{task-agent/task-agent.d.mts → agents/agents.d.mts} +51 -213
  13. package/resources/agents/agents.d.mts.map +1 -0
  14. package/resources/{task-agent/task-agent.d.ts → agents/agents.d.ts} +51 -213
  15. package/resources/agents/agents.d.ts.map +1 -0
  16. package/resources/agents/agents.js +67 -0
  17. package/resources/agents/agents.js.map +1 -0
  18. package/resources/agents/agents.mjs +62 -0
  19. package/resources/agents/agents.mjs.map +1 -0
  20. package/resources/agents/index.d.mts +4 -0
  21. package/resources/agents/index.d.mts.map +1 -0
  22. package/resources/agents/index.d.ts +4 -0
  23. package/resources/agents/index.d.ts.map +1 -0
  24. package/resources/{task-agent → agents}/index.js +3 -3
  25. package/resources/agents/index.js.map +1 -0
  26. package/resources/{task-agent → agents}/index.mjs +1 -1
  27. package/resources/agents/index.mjs.map +1 -0
  28. package/resources/{task-agent → agents}/runs.d.mts +192 -43
  29. package/resources/agents/runs.d.mts.map +1 -0
  30. package/resources/{task-agent → agents}/runs.d.ts +192 -43
  31. package/resources/agents/runs.d.ts.map +1 -0
  32. package/resources/agents/runs.js +63 -0
  33. package/resources/agents/runs.js.map +1 -0
  34. package/resources/agents/runs.mjs +59 -0
  35. package/resources/agents/runs.mjs.map +1 -0
  36. package/resources/{task-agent → agents}/templates.d.mts +3 -6
  37. package/resources/agents/templates.d.mts.map +1 -0
  38. package/resources/{task-agent → agents}/templates.d.ts +3 -6
  39. package/resources/agents/templates.d.ts.map +1 -0
  40. package/resources/{task-agent → agents}/templates.js +5 -8
  41. package/resources/agents/templates.js.map +1 -0
  42. package/resources/agents/templates.mjs +19 -0
  43. package/resources/agents/templates.mjs.map +1 -0
  44. package/resources/agents.d.mts +2 -0
  45. package/resources/agents.d.mts.map +1 -0
  46. package/resources/agents.d.ts +2 -0
  47. package/resources/agents.d.ts.map +1 -0
  48. package/resources/{task-agent.js → agents.js} +2 -2
  49. package/resources/agents.js.map +1 -0
  50. package/resources/{task-agent.mjs → agents.mjs} +2 -2
  51. package/resources/agents.mjs.map +1 -0
  52. package/resources/batches.js +3 -3
  53. package/resources/batches.mjs +3 -3
  54. package/resources/crawl.js +4 -4
  55. package/resources/crawl.mjs +4 -4
  56. package/resources/domain-knowledge.js +1 -1
  57. package/resources/domain-knowledge.mjs +1 -1
  58. package/resources/extract/extract.d.mts +1243 -0
  59. package/resources/extract/extract.d.mts.map +1 -0
  60. package/resources/extract/extract.d.ts +1243 -0
  61. package/resources/extract/extract.d.ts.map +1 -0
  62. package/resources/extract/extract.js +52 -0
  63. package/resources/extract/extract.js.map +1 -0
  64. package/resources/extract/extract.mjs +47 -0
  65. package/resources/extract/extract.mjs.map +1 -0
  66. package/resources/extract/index.d.mts +3 -0
  67. package/resources/extract/index.d.mts.map +1 -0
  68. package/resources/extract/index.d.ts +3 -0
  69. package/resources/extract/index.d.ts.map +1 -0
  70. package/resources/extract/index.js +9 -0
  71. package/resources/extract/index.js.map +1 -0
  72. package/resources/extract/index.mjs +4 -0
  73. package/resources/extract/index.mjs.map +1 -0
  74. package/resources/extract/templates/generations.d.mts +364 -0
  75. package/resources/extract/templates/generations.d.mts.map +1 -0
  76. package/resources/extract/templates/generations.d.ts +364 -0
  77. package/resources/extract/templates/generations.d.ts.map +1 -0
  78. package/resources/extract/templates/generations.js +39 -0
  79. package/resources/extract/templates/generations.js.map +1 -0
  80. package/resources/extract/templates/generations.mjs +35 -0
  81. package/resources/extract/templates/generations.mjs.map +1 -0
  82. package/resources/extract/templates/index.d.mts +4 -0
  83. package/resources/extract/templates/index.d.mts.map +1 -0
  84. package/resources/extract/templates/index.d.ts +4 -0
  85. package/resources/extract/templates/index.d.ts.map +1 -0
  86. package/resources/extract/templates/index.js +11 -0
  87. package/resources/extract/templates/index.js.map +1 -0
  88. package/resources/extract/templates/index.mjs +5 -0
  89. package/resources/extract/templates/index.mjs.map +1 -0
  90. package/resources/extract/templates/templates.d.mts +870 -0
  91. package/resources/extract/templates/templates.d.mts.map +1 -0
  92. package/resources/extract/templates/templates.d.ts +870 -0
  93. package/resources/extract/templates/templates.d.ts.map +1 -0
  94. package/resources/extract/templates/templates.js +120 -0
  95. package/resources/extract/templates/templates.js.map +1 -0
  96. package/resources/extract/templates/templates.mjs +115 -0
  97. package/resources/extract/templates/templates.mjs.map +1 -0
  98. package/resources/extract/templates/versions.d.mts +226 -0
  99. package/resources/extract/templates/versions.d.mts.map +1 -0
  100. package/resources/extract/templates/versions.d.ts +226 -0
  101. package/resources/extract/templates/versions.d.ts.map +1 -0
  102. package/resources/extract/templates/versions.js +42 -0
  103. package/resources/extract/templates/versions.js.map +1 -0
  104. package/resources/extract/templates/versions.mjs +38 -0
  105. package/resources/extract/templates/versions.mjs.map +1 -0
  106. package/resources/extract/templates.d.mts +2 -0
  107. package/resources/extract/templates.d.mts.map +1 -0
  108. package/resources/extract/templates.d.ts +2 -0
  109. package/resources/extract/templates.d.ts.map +1 -0
  110. package/resources/extract/templates.js +6 -0
  111. package/resources/extract/templates.js.map +1 -0
  112. package/resources/extract/templates.mjs +3 -0
  113. package/resources/extract/templates.mjs.map +1 -0
  114. package/resources/extract.d.mts +2 -0
  115. package/resources/extract.d.mts.map +1 -0
  116. package/resources/extract.d.ts +2 -0
  117. package/resources/extract.d.ts.map +1 -0
  118. package/resources/extract.js +6 -0
  119. package/resources/extract.js.map +1 -0
  120. package/resources/extract.mjs +3 -0
  121. package/resources/extract.mjs.map +1 -0
  122. package/resources/fast-serp.js +1 -1
  123. package/resources/fast-serp.mjs +1 -1
  124. package/resources/index.d.mts +4 -4
  125. package/resources/index.d.mts.map +1 -1
  126. package/resources/index.d.ts +4 -4
  127. package/resources/index.d.ts.map +1 -1
  128. package/resources/index.js +5 -5
  129. package/resources/index.js.map +1 -1
  130. package/resources/index.mjs +2 -2
  131. package/resources/index.mjs.map +1 -1
  132. package/resources/jobs/index.d.mts +2 -2
  133. package/resources/jobs/index.d.mts.map +1 -1
  134. package/resources/jobs/index.d.ts +2 -2
  135. package/resources/jobs/index.d.ts.map +1 -1
  136. package/resources/jobs/index.js.map +1 -1
  137. package/resources/jobs/index.mjs.map +1 -1
  138. package/resources/jobs/jobs.d.mts +35 -103
  139. package/resources/jobs/jobs.d.mts.map +1 -1
  140. package/resources/jobs/jobs.d.ts +35 -103
  141. package/resources/jobs/jobs.d.ts.map +1 -1
  142. package/resources/jobs/jobs.js +10 -28
  143. package/resources/jobs/jobs.js.map +1 -1
  144. package/resources/jobs/jobs.mjs +11 -29
  145. package/resources/jobs/jobs.mjs.map +1 -1
  146. package/resources/jobs/runs/artifacts.d.mts +4 -12
  147. package/resources/jobs/runs/artifacts.d.mts.map +1 -1
  148. package/resources/jobs/runs/artifacts.d.ts +4 -12
  149. package/resources/jobs/runs/artifacts.d.ts.map +1 -1
  150. package/resources/jobs/runs/artifacts.js +8 -16
  151. package/resources/jobs/runs/artifacts.js.map +1 -1
  152. package/resources/jobs/runs/artifacts.mjs +8 -16
  153. package/resources/jobs/runs/artifacts.mjs.map +1 -1
  154. package/resources/jobs/runs/index.d.mts +1 -1
  155. package/resources/jobs/runs/index.d.mts.map +1 -1
  156. package/resources/jobs/runs/index.d.ts +1 -1
  157. package/resources/jobs/runs/index.d.ts.map +1 -1
  158. package/resources/jobs/runs/index.js.map +1 -1
  159. package/resources/jobs/runs/index.mjs.map +1 -1
  160. package/resources/jobs/runs/runs.d.mts +60 -28
  161. package/resources/jobs/runs/runs.d.mts.map +1 -1
  162. package/resources/jobs/runs/runs.d.ts +60 -28
  163. package/resources/jobs/runs/runs.d.ts.map +1 -1
  164. package/resources/jobs/runs/runs.js +12 -12
  165. package/resources/jobs/runs/runs.js.map +1 -1
  166. package/resources/jobs/runs/runs.mjs +12 -12
  167. package/resources/jobs/runs/runs.mjs.map +1 -1
  168. package/resources/media.js +2 -2
  169. package/resources/media.mjs +2 -2
  170. package/resources/serp.js +3 -3
  171. package/resources/serp.mjs +3 -3
  172. package/resources/tasks.js +3 -3
  173. package/resources/tasks.mjs +3 -3
  174. package/resources/top-level.d.mts +1 -1202
  175. package/resources/top-level.d.mts.map +1 -1
  176. package/resources/top-level.d.ts +1 -1202
  177. package/resources/top-level.d.ts.map +1 -1
  178. package/src/client.ts +41 -123
  179. package/src/resources/{task-agent/task-agent.ts → agents/agents.ts} +71 -258
  180. package/src/resources/{task-agent → agents}/index.ts +14 -14
  181. package/src/resources/{task-agent → agents}/runs.ts +228 -54
  182. package/src/resources/{task-agent → agents}/templates.ts +5 -8
  183. package/src/resources/{task-agent.ts → agents.ts} +1 -1
  184. package/src/resources/batches.ts +3 -3
  185. package/src/resources/crawl.ts +4 -4
  186. package/src/resources/domain-knowledge.ts +1 -1
  187. package/src/resources/extract/extract.ts +5182 -0
  188. package/src/resources/extract/index.ts +25 -0
  189. package/src/resources/extract/templates/generations.ts +435 -0
  190. package/src/resources/extract/templates/index.ts +29 -0
  191. package/src/resources/extract/templates/templates.ts +1176 -0
  192. package/src/resources/extract/templates/versions.ts +284 -0
  193. package/src/resources/extract/templates.ts +3 -0
  194. package/src/resources/extract.ts +3 -0
  195. package/src/resources/fast-serp.ts +1 -1
  196. package/src/resources/index.ts +16 -36
  197. package/src/resources/jobs/index.ts +1 -1
  198. package/src/resources/jobs/jobs.ts +50 -125
  199. package/src/resources/jobs/runs/artifacts.ts +8 -16
  200. package/src/resources/jobs/runs/index.ts +1 -0
  201. package/src/resources/jobs/runs/runs.ts +75 -31
  202. package/src/resources/media.ts +2 -2
  203. package/src/resources/serp.ts +3 -3
  204. package/src/resources/tasks.ts +3 -3
  205. package/src/resources/top-level.ts +72 -5171
  206. package/src/version.ts +1 -1
  207. package/version.d.mts +1 -1
  208. package/version.d.mts.map +1 -1
  209. package/version.d.ts +1 -1
  210. package/version.d.ts.map +1 -1
  211. package/version.js +1 -1
  212. package/version.js.map +1 -1
  213. package/version.mjs +1 -1
  214. package/version.mjs.map +1 -1
  215. package/resources/agent.d.mts +0 -641
  216. package/resources/agent.d.mts.map +0 -1
  217. package/resources/agent.d.ts +0 -641
  218. package/resources/agent.d.ts.map +0 -1
  219. package/resources/agent.js +0 -84
  220. package/resources/agent.js.map +0 -1
  221. package/resources/agent.mjs +0 -80
  222. package/resources/agent.mjs.map +0 -1
  223. package/resources/task-agent/index.d.mts +0 -4
  224. package/resources/task-agent/index.d.mts.map +0 -1
  225. package/resources/task-agent/index.d.ts +0 -4
  226. package/resources/task-agent/index.d.ts.map +0 -1
  227. package/resources/task-agent/index.js.map +0 -1
  228. package/resources/task-agent/index.mjs.map +0 -1
  229. package/resources/task-agent/runs.d.mts.map +0 -1
  230. package/resources/task-agent/runs.d.ts.map +0 -1
  231. package/resources/task-agent/runs.js +0 -63
  232. package/resources/task-agent/runs.js.map +0 -1
  233. package/resources/task-agent/runs.mjs +0 -59
  234. package/resources/task-agent/runs.mjs.map +0 -1
  235. package/resources/task-agent/task-agent.d.mts.map +0 -1
  236. package/resources/task-agent/task-agent.d.ts.map +0 -1
  237. package/resources/task-agent/task-agent.js +0 -80
  238. package/resources/task-agent/task-agent.js.map +0 -1
  239. package/resources/task-agent/task-agent.mjs +0 -75
  240. package/resources/task-agent/task-agent.mjs.map +0 -1
  241. package/resources/task-agent/templates.d.mts.map +0 -1
  242. package/resources/task-agent/templates.d.ts.map +0 -1
  243. package/resources/task-agent/templates.js.map +0 -1
  244. package/resources/task-agent/templates.mjs +0 -22
  245. package/resources/task-agent/templates.mjs.map +0 -1
  246. package/resources/task-agent.d.mts +0 -2
  247. package/resources/task-agent.d.mts.map +0 -1
  248. package/resources/task-agent.d.ts +0 -2
  249. package/resources/task-agent.d.ts.map +0 -1
  250. package/resources/task-agent.js.map +0 -1
  251. package/resources/task-agent.mjs.map +0 -1
  252. package/src/resources/agent.ts +0 -935
@@ -1,398 +1,3 @@
1
- import * as Shared from "./shared.js";
2
- export interface ExtractResponse {
3
- data: ExtractResponse.Data;
4
- metadata: ExtractResponse.Metadata;
5
- /**
6
- * The status of the task.
7
- */
8
- status: 'success' | 'skipped' | 'fatal' | 'error' | 'postponed' | 'ignored' | 'rejected' | 'blocked';
9
- /**
10
- * Unique identifier for the task.
11
- */
12
- task_id: string;
13
- /**
14
- * The final URL.
15
- */
16
- url: string;
17
- debug?: ExtractResponse.Debug;
18
- /**
19
- * Pagination information if applicable.
20
- */
21
- pagination?: ExtractResponse.NextPageParams | Array<ExtractResponse.UnionMember1>;
22
- /**
23
- * The HTTP status code of the task.
24
- */
25
- status_code?: number;
26
- /**
27
- * List of warnings generated during the task.
28
- */
29
- warnings?: Array<string>;
30
- }
31
- export declare namespace ExtractResponse {
32
- interface Data {
33
- /**
34
- * Browser actions execution results. Present only when browser_actions were
35
- * specified in the request.
36
- */
37
- browser_actions?: Data.BrowserActions;
38
- /**
39
- * The cookies collected from browser actions during the task.
40
- */
41
- cookies?: Array<unknown>;
42
- /**
43
- * The evaluation results from browser actions during the task.
44
- */
45
- eval?: Array<unknown>;
46
- /**
47
- * The http requests from browser actions made during the task.
48
- */
49
- fetch?: Array<unknown>;
50
- /**
51
- * The headers received during the task.
52
- */
53
- headers?: {
54
- [key: string]: string;
55
- };
56
- /**
57
- * The HTML content of the page.
58
- */
59
- html?: string;
60
- /**
61
- * List of all unique URLs found on the page.
62
- */
63
- links?: Array<string>;
64
- /**
65
- * The Markdown version of the HTML content.
66
- */
67
- markdown?: string;
68
- /**
69
- * The network capture data collected during the task.
70
- */
71
- network_capture?: Array<Data.NetworkCapture>;
72
- /**
73
- * Individual HTML content of each pagination page, before merging.
74
- */
75
- pages_html?: Array<string>;
76
- /**
77
- * The parsing results extracted from the HTML & network content.
78
- */
79
- parsing?: Data.ParsingSuccessResult | Data.ParsingErrorResult | {
80
- [key: string]: unknown;
81
- };
82
- /**
83
- * The list of redirects that occurred during the task.
84
- */
85
- redirects?: Array<Data.Redirect>;
86
- /**
87
- * Screenshots taken during the task, from browser actions, or the screenshot
88
- * format.
89
- */
90
- screenshots?: Array<unknown>;
91
- }
92
- namespace Data {
93
- /**
94
- * Browser actions execution results. Present only when browser_actions were
95
- * specified in the request.
96
- */
97
- interface BrowserActions {
98
- results: Array<BrowserActions.Result>;
99
- success: boolean;
100
- total_duration: number;
101
- }
102
- namespace BrowserActions {
103
- interface Result {
104
- duration: number;
105
- name: 'goto' | 'wait' | 'wait_for_element' | 'wait_for_navigation' | 'click' | 'fill' | 'press' | 'scroll' | 'auto_scroll' | 'screenshot' | 'get_cookies' | 'eval' | 'fetch';
106
- status: 'no-run' | 'in-progress' | 'done' | 'error' | 'skipped';
107
- error?: string;
108
- result?: unknown;
109
- }
110
- }
111
- interface NetworkCapture {
112
- filter: NetworkCapture.Filter;
113
- results: Array<NetworkCapture.Result>;
114
- errorMessage?: string;
115
- }
116
- namespace NetworkCapture {
117
- interface Filter {
118
- validation: boolean;
119
- wait_for_requests_count: number;
120
- method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
121
- /**
122
- * Resource type for network capture filtering
123
- */
124
- resource_type?: 'document' | 'stylesheet' | 'image' | 'media' | 'font' | 'script' | 'texttrack' | 'xhr' | 'fetch' | 'prefetch' | 'eventsource' | 'websocket' | 'manifest' | 'signedexchange' | 'ping' | 'cspviolationreport' | 'preflight' | 'other' | 'fedcm' | Array<'document' | 'stylesheet' | 'image' | 'media' | 'font' | 'script' | 'texttrack' | 'xhr' | 'fetch' | 'prefetch' | 'eventsource' | 'websocket' | 'manifest' | 'signedexchange' | 'ping' | 'cspviolationreport' | 'preflight' | 'other' | 'fedcm'>;
125
- status_code?: number | Array<number>;
126
- url?: Filter.URL;
127
- wait_for_requests_count_timeout?: number;
128
- }
129
- namespace Filter {
130
- interface URL {
131
- type: 'exact' | 'contains';
132
- value: string;
133
- }
134
- }
135
- interface Result {
136
- request: Result.Request;
137
- response: Result.Response;
138
- }
139
- namespace Result {
140
- interface Request {
141
- headers: {
142
- [key: string]: string;
143
- };
144
- method: string;
145
- /**
146
- * Resource type for network capture filtering
147
- */
148
- resource_type: 'document' | 'stylesheet' | 'image' | 'media' | 'font' | 'script' | 'texttrack' | 'xhr' | 'fetch' | 'prefetch' | 'eventsource' | 'websocket' | 'manifest' | 'signedexchange' | 'ping' | 'cspviolationreport' | 'preflight' | 'other' | 'fedcm';
149
- url: string;
150
- body?: string;
151
- }
152
- interface Response {
153
- body: string;
154
- headers: {
155
- [key: string]: string;
156
- };
157
- serialization: 'none' | 'base64';
158
- status: number;
159
- status_text: string;
160
- }
161
- }
162
- }
163
- interface ParsingSuccessResult {
164
- entities: {
165
- [key: string]: unknown;
166
- };
167
- status: 'success';
168
- }
169
- interface ParsingErrorResult {
170
- error: string;
171
- status: 'error';
172
- }
173
- interface Redirect {
174
- status_code: number;
175
- url: string;
176
- }
177
- }
178
- interface Metadata {
179
- /**
180
- * The name of the agent used for the query.
181
- */
182
- agent?: string;
183
- /**
184
- * The driver used for the task.
185
- */
186
- driver?: string;
187
- /**
188
- * The localization identifier for the query.
189
- */
190
- localization_id?: string;
191
- /**
192
- * The duration in milliseconds of the query processing.
193
- */
194
- query_duration?: number;
195
- /**
196
- * The time when the query was received.
197
- */
198
- query_time?: string;
199
- /**
200
- * Additional response parameters.
201
- */
202
- response_parameters?: unknown;
203
- /**
204
- * A tag associated with the query.
205
- */
206
- tag?: string;
207
- }
208
- interface Debug {
209
- /**
210
- * Performance metrics collected during the task.
211
- */
212
- performance_metrics?: {
213
- [key: string]: number;
214
- };
215
- /**
216
- * Total bytes used by the proxy during the task.
217
- */
218
- proxy_total_bytes_usage?: number;
219
- /**
220
- * The transformed output after applying any transformations.
221
- */
222
- transformed_output?: unknown;
223
- /**
224
- * The userbrowser instance using during the task.
225
- */
226
- userbrowser?: unknown;
227
- }
228
- interface NextPageParams {
229
- next_page_params: {
230
- [key: string]: unknown;
231
- };
232
- }
233
- interface UnionMember1 {
234
- next_page_params: {
235
- [key: string]: unknown;
236
- };
237
- }
238
- }
239
- /**
240
- * Response when an async extract task is created successfully.
241
- */
242
- export interface ExtractAsyncResponse {
243
- /**
244
- * Status indicating the async task was created successfully.
245
- */
246
- status: 'success';
247
- /**
248
- * The created async task details.
249
- */
250
- task: ExtractAsyncResponse.Task;
251
- }
252
- export declare namespace ExtractAsyncResponse {
253
- /**
254
- * The created async task details.
255
- */
256
- interface Task {
257
- /**
258
- * Unique task identifier.
259
- */
260
- id: string;
261
- _query: unknown;
262
- /**
263
- * Timestamp when the task was created.
264
- */
265
- created_at: string;
266
- /**
267
- * Original input data for the task.
268
- */
269
- input: unknown;
270
- /**
271
- * Current state of the task.
272
- */
273
- state: 'pending' | 'queued' | 'in_progress' | 'success' | 'error';
274
- /**
275
- * URL for checking the task status.
276
- */
277
- status_url: string;
278
- /**
279
- * Account name that owns the task.
280
- */
281
- account_name?: string;
282
- api_type?: 'web' | 'serp' | 'ecommerce' | 'social' | 'media' | 'agent' | 'extract' | 'fast-serp' | 'labs';
283
- /**
284
- * Batch ID if this task is part of a batch.
285
- */
286
- batch_id?: string | null;
287
- /**
288
- * URL for downloading the task results.
289
- */
290
- download_url?: string | null;
291
- /**
292
- * Error message if the task failed.
293
- */
294
- error?: string | null;
295
- /**
296
- * Classification of the error type.
297
- */
298
- error_type?: string | null;
299
- /**
300
- * Timestamp when the task was last modified.
301
- */
302
- modified_at?: string;
303
- /**
304
- * Storage location of the output data.
305
- */
306
- output_url?: string | null;
307
- /**
308
- * Queue name the task was submitted to.
309
- */
310
- queue?: string;
311
- /**
312
- * HTTP status code from the task execution.
313
- */
314
- status_code?: number;
315
- }
316
- }
317
- /**
318
- * Response when a batch of extract tasks is created successfully.
319
- */
320
- export interface ExtractBatchResponse {
321
- /**
322
- * Unique identifier for the batch.
323
- */
324
- batch_id: string;
325
- /**
326
- * Number of tasks in the batch.
327
- */
328
- batch_size: number;
329
- /**
330
- * List of created tasks.
331
- */
332
- tasks: Array<ExtractBatchResponse.Task>;
333
- }
334
- export declare namespace ExtractBatchResponse {
335
- interface Task {
336
- /**
337
- * Unique task identifier.
338
- */
339
- id: string;
340
- _query: unknown;
341
- /**
342
- * Timestamp when the task was created.
343
- */
344
- created_at: string;
345
- /**
346
- * Original input data for the task.
347
- */
348
- input: unknown;
349
- /**
350
- * Current state of the task.
351
- */
352
- state: 'pending' | 'queued' | 'in_progress' | 'success' | 'error';
353
- /**
354
- * URL for checking the task status.
355
- */
356
- status_url: string;
357
- /**
358
- * Account name that owns the task.
359
- */
360
- account_name?: string;
361
- api_type?: 'web' | 'serp' | 'ecommerce' | 'social' | 'media' | 'agent' | 'extract' | 'fast-serp' | 'labs';
362
- /**
363
- * Batch ID if this task is part of a batch.
364
- */
365
- batch_id?: string | null;
366
- /**
367
- * URL for downloading the task results.
368
- */
369
- download_url?: string | null;
370
- /**
371
- * Error message if the task failed.
372
- */
373
- error?: string | null;
374
- /**
375
- * Classification of the error type.
376
- */
377
- error_type?: string | null;
378
- /**
379
- * Timestamp when the task was last modified.
380
- */
381
- modified_at?: string;
382
- /**
383
- * Storage location of the output data.
384
- */
385
- output_url?: string | null;
386
- /**
387
- * Queue name the task was submitted to.
388
- */
389
- queue?: string;
390
- /**
391
- * HTTP status code from the task execution.
392
- */
393
- status_code?: number;
394
- }
395
- }
396
1
  /**
397
2
  * Response schema for map requests.
398
3
  */
@@ -502,812 +107,6 @@ export declare namespace SearchResponse {
502
107
  result_index: number;
503
108
  }
504
109
  }
505
- export interface ExtractParams {
506
- /**
507
- * Target URL to scrape
508
- */
509
- url: string;
510
- /**
511
- * Custom flow for the optimization engine: maps candidate names to the number of
512
- * attempts to spend on each candidate before advancing (0 skips it). Key order
513
- * defines the flow order. Providing it opts the request into 'auto' driver
514
- * selection.
515
- */
516
- auto_driver_configuration?: {
517
- [key: string]: number;
518
- };
519
- /**
520
- * Request body for POST, PUT, PATCH methods
521
- */
522
- body?: unknown;
523
- /**
524
- * Browser type to emulate
525
- */
526
- browser?: 'chrome' | 'firefox' | ExtractParams.UnionMember1;
527
- /**
528
- * Array of browser automation actions to execute sequentially
529
- */
530
- browser_actions?: Array<Shared.AutoScrollAction | Shared.ClickAction | Shared.EvalAction | Shared.FetchAction | Shared.FillAction | Shared.GetCookiesAction | Shared.GotoAction | Shared.PressAction | Shared.ScreenshotAction | Shared.ScrollAction | Shared.WaitAction | Shared.WaitForElementAction | Shared.WaitForNavigationAction>;
531
- /**
532
- * City for geolocation
533
- */
534
- city?: string;
535
- /**
536
- * Whether to automatically handle cookie consent headers
537
- */
538
- consent_header?: boolean;
539
- /**
540
- * Browser cookies as array of cookie objects
541
- */
542
- cookies?: Array<ExtractParams.UnionMember0> | string;
543
- /**
544
- * Country code for geolocation and proxy selection
545
- */
546
- country?: 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ALL';
547
- /**
548
- * Device type for browser emulation
549
- */
550
- device?: 'desktop' | 'mobile' | 'tablet';
551
- /**
552
- * Browser driver to use
553
- */
554
- driver?: 'auto' | 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro' | 'media-vx6' | 'fast-vx6';
555
- /**
556
- * Expected HTTP status codes for successful requests
557
- */
558
- expected_status_codes?: Array<number>;
559
- /**
560
- * List of acceptable response formats in order of preference
561
- */
562
- formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
563
- /**
564
- * Custom HTTP headers to include in the request
565
- */
566
- headers?: {
567
- [key: string]: string | Array<string> | null;
568
- };
569
- /**
570
- * Whether to use HTTP/2 protocol
571
- */
572
- http2?: boolean;
573
- /**
574
- * Whether to emulate XMLHttpRequest behavior
575
- */
576
- is_xhr?: boolean;
577
- /**
578
- * Locale for browser language and region settings
579
- */
580
- locale?: 'aa-DJ' | 'aa-ER' | 'aa-ET' | 'af' | 'af-NA' | 'af-ZA' | 'ak' | 'ak-GH' | 'am' | 'am-ET' | 'an-ES' | 'ar' | 'ar-AE' | 'ar-BH' | 'ar-DZ' | 'ar-EG' | 'ar-IN' | 'ar-IQ' | 'ar-JO' | 'ar-KW' | 'ar-LB' | 'ar-LY' | 'ar-MA' | 'ar-OM' | 'ar-QA' | 'ar-SA' | 'ar-SD' | 'ar-SY' | 'ar-TN' | 'ar-YE' | 'as' | 'as-IN' | 'asa' | 'asa-TZ' | 'ast-ES' | 'az' | 'az-AZ' | 'az-Cyrl' | 'az-Cyrl-AZ' | 'az-Latn' | 'az-Latn-AZ' | 'be' | 'be-BY' | 'bem' | 'bem-ZM' | 'ber-DZ' | 'ber-MA' | 'bez' | 'bez-TZ' | 'bg' | 'bg-BG' | 'bho-IN' | 'bm' | 'bm-ML' | 'bn' | 'bn-BD' | 'bn-IN' | 'bo' | 'bo-CN' | 'bo-IN' | 'br-FR' | 'brx-IN' | 'bs' | 'bs-BA' | 'byn-ER' | 'ca' | 'ca-AD' | 'ca-ES' | 'ca-FR' | 'ca-IT' | 'cgg' | 'cgg-UG' | 'chr' | 'chr-US' | 'crh-UA' | 'cs' | 'cs-CZ' | 'csb-PL' | 'cv-RU' | 'cy' | 'cy-GB' | 'da' | 'da-DK' | 'dav' | 'dav-KE' | 'de' | 'de-AT' | 'de-BE' | 'de-CH' | 'de-DE' | 'de-LI' | 'de-LU' | 'dv-MV' | 'dz-BT' | 'ebu' | 'ebu-KE' | 'ee' | 'ee-GH' | 'ee-TG' | 'el' | 'el-CY' | 'el-GR' | 'en' | 'en-AG' | 'en-AS' | 'en-AU' | 'en-BE' | 'en-BW' | 'en-BZ' | 'en-CA' | 'en-DK' | 'en-GB' | 'en-GU' | 'en-HK' | 'en-IE' | 'en-IN' | 'en-JM' | 'en-MH' | 'en-MP' | 'en-MT' | 'en-MU' | 'en-NA' | 'en-NG' | 'en-NZ' | 'en-PH' | 'en-PK' | 'en-SG' | 'en-TT' | 'en-UM' | 'en-US' | 'en-VI' | 'en-ZA' | 'en-ZM' | 'en-ZW' | 'eo' | 'es' | 'es-419' | 'es-AR' | 'es-BO' | 'es-CL' | 'es-CO' | 'es-CR' | 'es-CU' | 'es-DO' | 'es-EC' | 'es-ES' | 'es-GQ' | 'es-GT' | 'es-HN' | 'es-MX' | 'es-NI' | 'es-PA' | 'es-PE' | 'es-PR' | 'es-PY' | 'es-SV' | 'es-US' | 'es-UY' | 'es-VE' | 'et' | 'et-EE' | 'eu' | 'eu-ES' | 'fa' | 'fa-AF' | 'fa-IR' | 'ff' | 'ff-SN' | 'fi' | 'fi-FI' | 'fil' | 'fil-PH' | 'fo' | 'fo-FO' | 'fr' | 'fr-BE' | 'fr-BF' | 'fr-BI' | 'fr-BJ' | 'fr-BL' | 'fr-CA' | 'fr-CD' | 'fr-CF' | 'fr-CG' | 'fr-CH' | 'fr-CI' | 'fr-CM' | 'fr-DJ' | 'fr-FR' | 'fr-GA' | 'fr-GN' | 'fr-GP' | 'fr-GQ' | 'fr-KM' | 'fr-LU' | 'fr-MC' | 'fr-MF' | 'fr-MG' | 'fr-ML' | 'fr-MQ' | 'fr-NE' | 'fr-RE' | 'fr-RW' | 'fr-SN' | 'fr-TD' | 'fr-TG' | 'fur-IT' | 'fy-DE' | 'fy-NL' | 'ga' | 'ga-IE' | 'gd-GB' | 'gez-ER' | 'gez-ET' | 'gl' | 'gl-ES' | 'gsw' | 'gsw-CH' | 'gu' | 'gu-IN' | 'guz' | 'guz-KE' | 'gv' | 'gv-GB' | 'ha' | 'ha-Latn' | 'ha-Latn-GH' | 'ha-Latn-NE' | 'ha-Latn-NG' | 'ha-NG' | 'haw' | 'haw-US' | 'he' | 'he-IL' | 'hi' | 'hi-IN' | 'hne-IN' | 'hr' | 'hr-HR' | 'hsb-DE' | 'ht-HT' | 'hu' | 'hu-HU' | 'hy' | 'hy-AM' | 'id' | 'id-ID' | 'ig' | 'ig-NG' | 'ii' | 'ii-CN' | 'ik-CA' | 'is' | 'is-IS' | 'it' | 'it-CH' | 'it-IT' | 'iu-CA' | 'iw-IL' | 'ja' | 'ja-JP' | 'jmc' | 'jmc-TZ' | 'ka' | 'ka-GE' | 'kab' | 'kab-DZ' | 'kam' | 'kam-KE' | 'kde' | 'kde-TZ' | 'kea' | 'kea-CV' | 'khq' | 'khq-ML' | 'ki' | 'ki-KE' | 'kk' | 'kk-Cyrl' | 'kk-Cyrl-KZ' | 'kk-KZ' | 'kl' | 'kl-GL' | 'kln' | 'kln-KE' | 'km' | 'km-KH' | 'kn' | 'kn-IN' | 'ko' | 'ko-KR' | 'kok' | 'kok-IN' | 'ks-IN' | 'ku-TR' | 'kw' | 'kw-GB' | 'ky-KG' | 'lag' | 'lag-TZ' | 'lb-LU' | 'lg' | 'lg-UG' | 'li-BE' | 'li-NL' | 'lij-IT' | 'lo-LA' | 'lt' | 'lt-LT' | 'luo' | 'luo-KE' | 'luy' | 'luy-KE' | 'lv' | 'lv-LV' | 'mag-IN' | 'mai-IN' | 'mas' | 'mas-KE' | 'mas-TZ' | 'mer' | 'mer-KE' | 'mfe' | 'mfe-MU' | 'mg' | 'mg-MG' | 'mhr-RU' | 'mi-NZ' | 'mk' | 'mk-MK' | 'ml' | 'ml-IN' | 'mn-MN' | 'mr' | 'mr-IN' | 'ms' | 'ms-BN' | 'ms-MY' | 'mt' | 'mt-MT' | 'my' | 'my-MM' | 'nan-TW' | 'naq' | 'naq-NA' | 'nb' | 'nb-NO' | 'nd' | 'nd-ZW' | 'nds-DE' | 'nds-NL' | 'ne' | 'ne-IN' | 'ne-NP' | 'nl' | 'nl-AW' | 'nl-BE' | 'nl-NL' | 'nn' | 'nn-NO' | 'nr-ZA' | 'nso-ZA' | 'nyn' | 'nyn-UG' | 'oc-FR' | 'om' | 'om-ET' | 'om-KE' | 'or' | 'or-IN' | 'os-RU' | 'pa' | 'pa-Arab' | 'pa-Arab-PK' | 'pa-Guru' | 'pa-Guru-IN' | 'pa-IN' | 'pa-PK' | 'pap-AN' | 'pl' | 'pl-PL' | 'ps' | 'ps-AF' | 'pt' | 'pt-BR' | 'pt-GW' | 'pt-MZ' | 'pt-PT' | 'rm' | 'rm-CH' | 'ro' | 'ro-MD' | 'ro-RO' | 'rof' | 'rof-TZ' | 'ru' | 'ru-MD' | 'ru-RU' | 'ru-UA' | 'rw' | 'rw-RW' | 'rwk' | 'rwk-TZ' | 'sa-IN' | 'saq' | 'saq-KE' | 'sc-IT' | 'sd-IN' | 'se-NO' | 'seh' | 'seh-MZ' | 'ses' | 'ses-ML' | 'sg' | 'sg-CF' | 'shi' | 'shi-Latn' | 'shi-Latn-MA' | 'shi-Tfng' | 'shi-Tfng-MA' | 'shs-CA' | 'si' | 'si-LK' | 'sid-ET' | 'sk' | 'sk-SK' | 'sl' | 'sl-SI' | 'sn' | 'sn-ZW' | 'so' | 'so-DJ' | 'so-ET' | 'so-KE' | 'so-SO' | 'sq' | 'sq-AL' | 'sq-MK' | 'sr' | 'sr-Cyrl' | 'sr-Cyrl-BA' | 'sr-Cyrl-ME' | 'sr-Cyrl-RS' | 'sr-Latn' | 'sr-Latn-BA' | 'sr-Latn-ME' | 'sr-Latn-RS' | 'sr-ME' | 'sr-RS' | 'ss-ZA' | 'st-ZA' | 'sv' | 'sv-FI' | 'sv-SE' | 'sw' | 'sw-KE' | 'sw-TZ' | 'ta' | 'ta-IN' | 'ta-LK' | 'te' | 'te-IN' | 'teo' | 'teo-KE' | 'teo-UG' | 'tg-TJ' | 'th' | 'th-TH' | 'ti' | 'ti-ER' | 'ti-ET' | 'tig-ER' | 'tk-TM' | 'tl-PH' | 'tn-ZA' | 'to' | 'to-TO' | 'tr' | 'tr-CY' | 'tr-TR' | 'ts-ZA' | 'tt-RU' | 'tzm' | 'tzm-Latn' | 'tzm-Latn-MA' | 'ug-CN' | 'uk' | 'uk-UA' | 'unm-US' | 'ur' | 'ur-IN' | 'ur-PK' | 'uz' | 'uz-Arab' | 'uz-Arab-AF' | 'uz-Cyrl' | 'uz-Cyrl-UZ' | 'uz-Latn' | 'uz-Latn-UZ' | 'uz-UZ' | 've-ZA' | 'vi' | 'vi-VN' | 'vun' | 'vun-TZ' | 'wa-BE' | 'wae-CH' | 'wal-ET' | 'wo-SN' | 'xh-ZA' | 'xog' | 'xog-UG' | 'yi-US' | 'yo' | 'yo-NG' | 'yue-HK' | 'zh' | 'zh-CN' | 'zh-HK' | 'zh-Hans' | 'zh-Hans-CN' | 'zh-Hans-HK' | 'zh-Hans-MO' | 'zh-Hans-SG' | 'zh-Hant' | 'zh-Hant-HK' | 'zh-Hant-MO' | 'zh-Hant-TW' | 'zh-SG' | 'zh-TW' | 'zu' | 'zu-ZA' | 'auto';
581
- /**
582
- * Selects which markdown conversion strategy to use. "full_page" converts the
583
- * entire HTML page. "main_content" uses Mozilla Readability to extract the main
584
- * article content before converting.
585
- */
586
- markdown_backend?: 'full_page' | 'main_content';
587
- /**
588
- * HTTP method for the request
589
- */
590
- method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
591
- /**
592
- * Filters for capturing network traffic
593
- */
594
- network_capture?: Array<ExtractParams.NetworkCapture>;
595
- /**
596
- * Operating system to emulate
597
- */
598
- os?: 'windows' | 'mac os' | 'linux' | 'android' | 'ios';
599
- /**
600
- * Whether to parse the response content
601
- */
602
- parse?: boolean;
603
- /**
604
- * Custom parser configuration as a key-value map
605
- */
606
- parser?: {
607
- [key: string]: unknown;
608
- } | string;
609
- /**
610
- * Referrer policy for the request
611
- */
612
- referrer_type?: 'random' | 'no-referer' | 'same-origin' | 'google' | 'bing' | 'facebook' | 'twitter' | 'instagram';
613
- /**
614
- * Whether to render JavaScript content using a browser
615
- */
616
- render?: boolean | 'auto';
617
- /**
618
- * Request timeout in milliseconds
619
- */
620
- request_timeout?: number;
621
- session?: ExtractParams.Session;
622
- /**
623
- * Skills or capabilities required for the request
624
- */
625
- skill?: string | Array<string>;
626
- /**
627
- * US state for geolocation (only valid when country is US)
628
- */
629
- state?: 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'VI' | 'WA' | 'WV' | 'WI' | 'WY';
630
- /**
631
- * User-defined tag for request identification
632
- */
633
- tag?: string;
634
- }
635
- export declare namespace ExtractParams {
636
- interface UnionMember1 {
637
- name: 'chrome' | 'firefox';
638
- /**
639
- * Specific browser version to emulate
640
- */
641
- version?: string;
642
- }
643
- interface UnionMember0 {
644
- creation?: string | null;
645
- domain?: string | null;
646
- expires?: string;
647
- extensions?: Array<string> | null;
648
- hostOnly?: boolean | null;
649
- httpOnly?: boolean | null;
650
- lastAccessed?: string | null;
651
- maxAge?: 'Infinity' | '-Infinity' | number | null;
652
- name?: string;
653
- path?: string | null;
654
- pathIsDefault?: boolean | null;
655
- sameSite?: 'strict' | 'lax' | 'none';
656
- secure?: boolean;
657
- value?: string;
658
- [k: string]: unknown;
659
- }
660
- interface NetworkCapture {
661
- method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
662
- /**
663
- * Resource type for network capture filtering
664
- */
665
- resource_type?: string | Array<string>;
666
- status_code?: number | Array<number>;
667
- url?: NetworkCapture.URL;
668
- validation?: boolean;
669
- wait_for_requests_count?: number;
670
- wait_for_requests_count_timeout?: number;
671
- }
672
- namespace NetworkCapture {
673
- interface URL {
674
- value: string;
675
- type?: 'exact' | 'contains';
676
- }
677
- }
678
- interface Session {
679
- id?: string;
680
- prefetch_userbrowser?: boolean;
681
- renew_on_blocked?: boolean;
682
- retry?: boolean;
683
- timeout?: number;
684
- }
685
- }
686
- export interface ExtractAsyncParams {
687
- /**
688
- * Target URL to scrape
689
- */
690
- url: string;
691
- /**
692
- * Custom flow for the optimization engine: maps candidate names to the number of
693
- * attempts to spend on each candidate before advancing (0 skips it). Key order
694
- * defines the flow order. Providing it opts the request into 'auto' driver
695
- * selection.
696
- */
697
- auto_driver_configuration?: {
698
- [key: string]: number;
699
- };
700
- /**
701
- * Request body for POST, PUT, PATCH methods
702
- */
703
- body?: unknown;
704
- /**
705
- * Browser type to emulate
706
- */
707
- browser?: 'chrome' | 'firefox' | ExtractAsyncParams.UnionMember1;
708
- /**
709
- * Array of browser automation actions to execute sequentially
710
- */
711
- browser_actions?: Array<Shared.AutoScrollAction | Shared.ClickAction | Shared.EvalAction | Shared.FetchAction | Shared.FillAction | Shared.GetCookiesAction | Shared.GotoAction | Shared.PressAction | Shared.ScreenshotAction | Shared.ScrollAction | Shared.WaitAction | Shared.WaitForElementAction | Shared.WaitForNavigationAction>;
712
- /**
713
- * URL to call back when async operation completes
714
- */
715
- callback_url?: string;
716
- /**
717
- * City for geolocation
718
- */
719
- city?: string;
720
- /**
721
- * Whether to automatically handle cookie consent headers
722
- */
723
- consent_header?: boolean;
724
- /**
725
- * Browser cookies as array of cookie objects
726
- */
727
- cookies?: Array<ExtractAsyncParams.UnionMember0> | string;
728
- /**
729
- * Country code for geolocation and proxy selection
730
- */
731
- country?: 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ALL';
732
- /**
733
- * Device type for browser emulation
734
- */
735
- device?: 'desktop' | 'mobile' | 'tablet';
736
- /**
737
- * Browser driver to use
738
- */
739
- driver?: 'auto' | 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro' | 'media-vx6' | 'fast-vx6';
740
- /**
741
- * Expected HTTP status codes for successful requests
742
- */
743
- expected_status_codes?: Array<number>;
744
- /**
745
- * List of acceptable response formats in order of preference
746
- */
747
- formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
748
- /**
749
- * Custom HTTP headers to include in the request
750
- */
751
- headers?: {
752
- [key: string]: string | Array<string> | null;
753
- };
754
- /**
755
- * Whether to use HTTP/2 protocol
756
- */
757
- http2?: boolean;
758
- /**
759
- * Whether to emulate XMLHttpRequest behavior
760
- */
761
- is_xhr?: boolean;
762
- /**
763
- * Locale for browser language and region settings
764
- */
765
- locale?: 'aa-DJ' | 'aa-ER' | 'aa-ET' | 'af' | 'af-NA' | 'af-ZA' | 'ak' | 'ak-GH' | 'am' | 'am-ET' | 'an-ES' | 'ar' | 'ar-AE' | 'ar-BH' | 'ar-DZ' | 'ar-EG' | 'ar-IN' | 'ar-IQ' | 'ar-JO' | 'ar-KW' | 'ar-LB' | 'ar-LY' | 'ar-MA' | 'ar-OM' | 'ar-QA' | 'ar-SA' | 'ar-SD' | 'ar-SY' | 'ar-TN' | 'ar-YE' | 'as' | 'as-IN' | 'asa' | 'asa-TZ' | 'ast-ES' | 'az' | 'az-AZ' | 'az-Cyrl' | 'az-Cyrl-AZ' | 'az-Latn' | 'az-Latn-AZ' | 'be' | 'be-BY' | 'bem' | 'bem-ZM' | 'ber-DZ' | 'ber-MA' | 'bez' | 'bez-TZ' | 'bg' | 'bg-BG' | 'bho-IN' | 'bm' | 'bm-ML' | 'bn' | 'bn-BD' | 'bn-IN' | 'bo' | 'bo-CN' | 'bo-IN' | 'br-FR' | 'brx-IN' | 'bs' | 'bs-BA' | 'byn-ER' | 'ca' | 'ca-AD' | 'ca-ES' | 'ca-FR' | 'ca-IT' | 'cgg' | 'cgg-UG' | 'chr' | 'chr-US' | 'crh-UA' | 'cs' | 'cs-CZ' | 'csb-PL' | 'cv-RU' | 'cy' | 'cy-GB' | 'da' | 'da-DK' | 'dav' | 'dav-KE' | 'de' | 'de-AT' | 'de-BE' | 'de-CH' | 'de-DE' | 'de-LI' | 'de-LU' | 'dv-MV' | 'dz-BT' | 'ebu' | 'ebu-KE' | 'ee' | 'ee-GH' | 'ee-TG' | 'el' | 'el-CY' | 'el-GR' | 'en' | 'en-AG' | 'en-AS' | 'en-AU' | 'en-BE' | 'en-BW' | 'en-BZ' | 'en-CA' | 'en-DK' | 'en-GB' | 'en-GU' | 'en-HK' | 'en-IE' | 'en-IN' | 'en-JM' | 'en-MH' | 'en-MP' | 'en-MT' | 'en-MU' | 'en-NA' | 'en-NG' | 'en-NZ' | 'en-PH' | 'en-PK' | 'en-SG' | 'en-TT' | 'en-UM' | 'en-US' | 'en-VI' | 'en-ZA' | 'en-ZM' | 'en-ZW' | 'eo' | 'es' | 'es-419' | 'es-AR' | 'es-BO' | 'es-CL' | 'es-CO' | 'es-CR' | 'es-CU' | 'es-DO' | 'es-EC' | 'es-ES' | 'es-GQ' | 'es-GT' | 'es-HN' | 'es-MX' | 'es-NI' | 'es-PA' | 'es-PE' | 'es-PR' | 'es-PY' | 'es-SV' | 'es-US' | 'es-UY' | 'es-VE' | 'et' | 'et-EE' | 'eu' | 'eu-ES' | 'fa' | 'fa-AF' | 'fa-IR' | 'ff' | 'ff-SN' | 'fi' | 'fi-FI' | 'fil' | 'fil-PH' | 'fo' | 'fo-FO' | 'fr' | 'fr-BE' | 'fr-BF' | 'fr-BI' | 'fr-BJ' | 'fr-BL' | 'fr-CA' | 'fr-CD' | 'fr-CF' | 'fr-CG' | 'fr-CH' | 'fr-CI' | 'fr-CM' | 'fr-DJ' | 'fr-FR' | 'fr-GA' | 'fr-GN' | 'fr-GP' | 'fr-GQ' | 'fr-KM' | 'fr-LU' | 'fr-MC' | 'fr-MF' | 'fr-MG' | 'fr-ML' | 'fr-MQ' | 'fr-NE' | 'fr-RE' | 'fr-RW' | 'fr-SN' | 'fr-TD' | 'fr-TG' | 'fur-IT' | 'fy-DE' | 'fy-NL' | 'ga' | 'ga-IE' | 'gd-GB' | 'gez-ER' | 'gez-ET' | 'gl' | 'gl-ES' | 'gsw' | 'gsw-CH' | 'gu' | 'gu-IN' | 'guz' | 'guz-KE' | 'gv' | 'gv-GB' | 'ha' | 'ha-Latn' | 'ha-Latn-GH' | 'ha-Latn-NE' | 'ha-Latn-NG' | 'ha-NG' | 'haw' | 'haw-US' | 'he' | 'he-IL' | 'hi' | 'hi-IN' | 'hne-IN' | 'hr' | 'hr-HR' | 'hsb-DE' | 'ht-HT' | 'hu' | 'hu-HU' | 'hy' | 'hy-AM' | 'id' | 'id-ID' | 'ig' | 'ig-NG' | 'ii' | 'ii-CN' | 'ik-CA' | 'is' | 'is-IS' | 'it' | 'it-CH' | 'it-IT' | 'iu-CA' | 'iw-IL' | 'ja' | 'ja-JP' | 'jmc' | 'jmc-TZ' | 'ka' | 'ka-GE' | 'kab' | 'kab-DZ' | 'kam' | 'kam-KE' | 'kde' | 'kde-TZ' | 'kea' | 'kea-CV' | 'khq' | 'khq-ML' | 'ki' | 'ki-KE' | 'kk' | 'kk-Cyrl' | 'kk-Cyrl-KZ' | 'kk-KZ' | 'kl' | 'kl-GL' | 'kln' | 'kln-KE' | 'km' | 'km-KH' | 'kn' | 'kn-IN' | 'ko' | 'ko-KR' | 'kok' | 'kok-IN' | 'ks-IN' | 'ku-TR' | 'kw' | 'kw-GB' | 'ky-KG' | 'lag' | 'lag-TZ' | 'lb-LU' | 'lg' | 'lg-UG' | 'li-BE' | 'li-NL' | 'lij-IT' | 'lo-LA' | 'lt' | 'lt-LT' | 'luo' | 'luo-KE' | 'luy' | 'luy-KE' | 'lv' | 'lv-LV' | 'mag-IN' | 'mai-IN' | 'mas' | 'mas-KE' | 'mas-TZ' | 'mer' | 'mer-KE' | 'mfe' | 'mfe-MU' | 'mg' | 'mg-MG' | 'mhr-RU' | 'mi-NZ' | 'mk' | 'mk-MK' | 'ml' | 'ml-IN' | 'mn-MN' | 'mr' | 'mr-IN' | 'ms' | 'ms-BN' | 'ms-MY' | 'mt' | 'mt-MT' | 'my' | 'my-MM' | 'nan-TW' | 'naq' | 'naq-NA' | 'nb' | 'nb-NO' | 'nd' | 'nd-ZW' | 'nds-DE' | 'nds-NL' | 'ne' | 'ne-IN' | 'ne-NP' | 'nl' | 'nl-AW' | 'nl-BE' | 'nl-NL' | 'nn' | 'nn-NO' | 'nr-ZA' | 'nso-ZA' | 'nyn' | 'nyn-UG' | 'oc-FR' | 'om' | 'om-ET' | 'om-KE' | 'or' | 'or-IN' | 'os-RU' | 'pa' | 'pa-Arab' | 'pa-Arab-PK' | 'pa-Guru' | 'pa-Guru-IN' | 'pa-IN' | 'pa-PK' | 'pap-AN' | 'pl' | 'pl-PL' | 'ps' | 'ps-AF' | 'pt' | 'pt-BR' | 'pt-GW' | 'pt-MZ' | 'pt-PT' | 'rm' | 'rm-CH' | 'ro' | 'ro-MD' | 'ro-RO' | 'rof' | 'rof-TZ' | 'ru' | 'ru-MD' | 'ru-RU' | 'ru-UA' | 'rw' | 'rw-RW' | 'rwk' | 'rwk-TZ' | 'sa-IN' | 'saq' | 'saq-KE' | 'sc-IT' | 'sd-IN' | 'se-NO' | 'seh' | 'seh-MZ' | 'ses' | 'ses-ML' | 'sg' | 'sg-CF' | 'shi' | 'shi-Latn' | 'shi-Latn-MA' | 'shi-Tfng' | 'shi-Tfng-MA' | 'shs-CA' | 'si' | 'si-LK' | 'sid-ET' | 'sk' | 'sk-SK' | 'sl' | 'sl-SI' | 'sn' | 'sn-ZW' | 'so' | 'so-DJ' | 'so-ET' | 'so-KE' | 'so-SO' | 'sq' | 'sq-AL' | 'sq-MK' | 'sr' | 'sr-Cyrl' | 'sr-Cyrl-BA' | 'sr-Cyrl-ME' | 'sr-Cyrl-RS' | 'sr-Latn' | 'sr-Latn-BA' | 'sr-Latn-ME' | 'sr-Latn-RS' | 'sr-ME' | 'sr-RS' | 'ss-ZA' | 'st-ZA' | 'sv' | 'sv-FI' | 'sv-SE' | 'sw' | 'sw-KE' | 'sw-TZ' | 'ta' | 'ta-IN' | 'ta-LK' | 'te' | 'te-IN' | 'teo' | 'teo-KE' | 'teo-UG' | 'tg-TJ' | 'th' | 'th-TH' | 'ti' | 'ti-ER' | 'ti-ET' | 'tig-ER' | 'tk-TM' | 'tl-PH' | 'tn-ZA' | 'to' | 'to-TO' | 'tr' | 'tr-CY' | 'tr-TR' | 'ts-ZA' | 'tt-RU' | 'tzm' | 'tzm-Latn' | 'tzm-Latn-MA' | 'ug-CN' | 'uk' | 'uk-UA' | 'unm-US' | 'ur' | 'ur-IN' | 'ur-PK' | 'uz' | 'uz-Arab' | 'uz-Arab-AF' | 'uz-Cyrl' | 'uz-Cyrl-UZ' | 'uz-Latn' | 'uz-Latn-UZ' | 'uz-UZ' | 've-ZA' | 'vi' | 'vi-VN' | 'vun' | 'vun-TZ' | 'wa-BE' | 'wae-CH' | 'wal-ET' | 'wo-SN' | 'xh-ZA' | 'xog' | 'xog-UG' | 'yi-US' | 'yo' | 'yo-NG' | 'yue-HK' | 'zh' | 'zh-CN' | 'zh-HK' | 'zh-Hans' | 'zh-Hans-CN' | 'zh-Hans-HK' | 'zh-Hans-MO' | 'zh-Hans-SG' | 'zh-Hant' | 'zh-Hant-HK' | 'zh-Hant-MO' | 'zh-Hant-TW' | 'zh-SG' | 'zh-TW' | 'zu' | 'zu-ZA' | 'auto';
766
- /**
767
- * Selects which markdown conversion strategy to use. "full_page" converts the
768
- * entire HTML page. "main_content" uses Mozilla Readability to extract the main
769
- * article content before converting.
770
- */
771
- markdown_backend?: 'full_page' | 'main_content';
772
- /**
773
- * HTTP method for the request
774
- */
775
- method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
776
- /**
777
- * Filters for capturing network traffic
778
- */
779
- network_capture?: Array<ExtractAsyncParams.NetworkCapture>;
780
- /**
781
- * Operating system to emulate
782
- */
783
- os?: 'windows' | 'mac os' | 'linux' | 'android' | 'ios';
784
- /**
785
- * Whether to parse the response content
786
- */
787
- parse?: boolean;
788
- /**
789
- * Custom parser configuration as a key-value map
790
- */
791
- parser?: {
792
- [key: string]: unknown;
793
- } | string;
794
- /**
795
- * Referrer policy for the request
796
- */
797
- referrer_type?: 'random' | 'no-referer' | 'same-origin' | 'google' | 'bing' | 'facebook' | 'twitter' | 'instagram';
798
- /**
799
- * Whether to render JavaScript content using a browser
800
- */
801
- render?: boolean | 'auto';
802
- /**
803
- * Request timeout in milliseconds
804
- */
805
- request_timeout?: number;
806
- session?: ExtractAsyncParams.Session;
807
- /**
808
- * Skills or capabilities required for the request
809
- */
810
- skill?: string | Array<string>;
811
- /**
812
- * US state for geolocation (only valid when country is US)
813
- */
814
- state?: 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'VI' | 'WA' | 'WV' | 'WI' | 'WY';
815
- /**
816
- * Whether to compress stored data
817
- */
818
- storage_compress?: boolean;
819
- /**
820
- * Custom name for the stored object
821
- */
822
- storage_object_name?: string;
823
- /**
824
- * Type of storage to use for results
825
- */
826
- storage_type?: string;
827
- /**
828
- * URL for storage location
829
- */
830
- storage_url?: string;
831
- /**
832
- * User-defined tag for request identification
833
- */
834
- tag?: string;
835
- }
836
- export declare namespace ExtractAsyncParams {
837
- interface UnionMember1 {
838
- name: 'chrome' | 'firefox';
839
- /**
840
- * Specific browser version to emulate
841
- */
842
- version?: string;
843
- }
844
- interface UnionMember0 {
845
- creation?: string | null;
846
- domain?: string | null;
847
- expires?: string;
848
- extensions?: Array<string> | null;
849
- hostOnly?: boolean | null;
850
- httpOnly?: boolean | null;
851
- lastAccessed?: string | null;
852
- maxAge?: 'Infinity' | '-Infinity' | number | null;
853
- name?: string;
854
- path?: string | null;
855
- pathIsDefault?: boolean | null;
856
- sameSite?: 'strict' | 'lax' | 'none';
857
- secure?: boolean;
858
- value?: string;
859
- [k: string]: unknown;
860
- }
861
- interface NetworkCapture {
862
- method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
863
- /**
864
- * Resource type for network capture filtering
865
- */
866
- resource_type?: string | Array<string>;
867
- status_code?: number | Array<number>;
868
- url?: NetworkCapture.URL;
869
- validation?: boolean;
870
- wait_for_requests_count?: number;
871
- wait_for_requests_count_timeout?: number;
872
- }
873
- namespace NetworkCapture {
874
- interface URL {
875
- value: string;
876
- type?: 'exact' | 'contains';
877
- }
878
- }
879
- interface Session {
880
- id?: string;
881
- prefetch_userbrowser?: boolean;
882
- renew_on_blocked?: boolean;
883
- retry?: boolean;
884
- timeout?: number;
885
- }
886
- }
887
- export interface ExtractBatchParams {
888
- /**
889
- * Array of extraction requests. Each object can include extraction parameters and
890
- * async/storage settings.
891
- */
892
- inputs: Array<ExtractBatchParams.Input>;
893
- /**
894
- * Shared parameters applied to the entire batch. Can include extraction parameters
895
- * and async/storage settings.
896
- */
897
- shared_inputs?: ExtractBatchParams.SharedInputs;
898
- }
899
- export declare namespace ExtractBatchParams {
900
- interface Input {
901
- /**
902
- * Custom flow for the optimization engine: maps candidate names to the number of
903
- * attempts to spend on each candidate before advancing (0 skips it). Key order
904
- * defines the flow order. Providing it opts the request into 'auto' driver
905
- * selection.
906
- */
907
- auto_driver_configuration?: {
908
- [key: string]: number;
909
- };
910
- /**
911
- * Request body for POST, PUT, PATCH methods
912
- */
913
- body?: unknown;
914
- /**
915
- * Browser type to emulate
916
- */
917
- browser?: 'chrome' | 'firefox' | Input.UnionMember1;
918
- /**
919
- * Array of browser automation actions to execute sequentially
920
- */
921
- browser_actions?: Array<Shared.AutoScrollAction | Shared.ClickAction | Shared.EvalAction | Shared.FetchAction | Shared.FillAction | Shared.GetCookiesAction | Shared.GotoAction | Shared.PressAction | Shared.ScreenshotAction | Shared.ScrollAction | Shared.WaitAction | Shared.WaitForElementAction | Shared.WaitForNavigationAction>;
922
- /**
923
- * URL to call back when async operation completes
924
- */
925
- callback_url?: string;
926
- /**
927
- * City for geolocation
928
- */
929
- city?: string;
930
- /**
931
- * Whether to automatically handle cookie consent headers
932
- */
933
- consent_header?: boolean;
934
- /**
935
- * Browser cookies as array of cookie objects
936
- */
937
- cookies?: Array<Input.UnionMember0> | string;
938
- /**
939
- * Country code for geolocation and proxy selection
940
- */
941
- country?: 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ALL';
942
- /**
943
- * Device type for browser emulation
944
- */
945
- device?: 'desktop' | 'mobile' | 'tablet';
946
- /**
947
- * Browser driver to use. Use 'auto' to let the engine select the candidate config
948
- * per domain.
949
- */
950
- driver?: 'auto' | 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro' | 'media-vx6' | 'fast-vx6';
951
- /**
952
- * Expected HTTP status codes for successful requests
953
- */
954
- expected_status_codes?: Array<number>;
955
- /**
956
- * List of acceptable response formats in order of preference
957
- */
958
- formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
959
- /**
960
- * Custom HTTP headers to include in the request
961
- */
962
- headers?: {
963
- [key: string]: string | Array<string> | null;
964
- };
965
- /**
966
- * Whether to use HTTP/2 protocol
967
- */
968
- http2?: boolean;
969
- /**
970
- * Whether to emulate XMLHttpRequest behavior
971
- */
972
- is_xhr?: boolean;
973
- /**
974
- * Locale for browser language and region settings
975
- */
976
- locale?: 'aa-DJ' | 'aa-ER' | 'aa-ET' | 'af' | 'af-NA' | 'af-ZA' | 'ak' | 'ak-GH' | 'am' | 'am-ET' | 'an-ES' | 'ar' | 'ar-AE' | 'ar-BH' | 'ar-DZ' | 'ar-EG' | 'ar-IN' | 'ar-IQ' | 'ar-JO' | 'ar-KW' | 'ar-LB' | 'ar-LY' | 'ar-MA' | 'ar-OM' | 'ar-QA' | 'ar-SA' | 'ar-SD' | 'ar-SY' | 'ar-TN' | 'ar-YE' | 'as' | 'as-IN' | 'asa' | 'asa-TZ' | 'ast-ES' | 'az' | 'az-AZ' | 'az-Cyrl' | 'az-Cyrl-AZ' | 'az-Latn' | 'az-Latn-AZ' | 'be' | 'be-BY' | 'bem' | 'bem-ZM' | 'ber-DZ' | 'ber-MA' | 'bez' | 'bez-TZ' | 'bg' | 'bg-BG' | 'bho-IN' | 'bm' | 'bm-ML' | 'bn' | 'bn-BD' | 'bn-IN' | 'bo' | 'bo-CN' | 'bo-IN' | 'br-FR' | 'brx-IN' | 'bs' | 'bs-BA' | 'byn-ER' | 'ca' | 'ca-AD' | 'ca-ES' | 'ca-FR' | 'ca-IT' | 'cgg' | 'cgg-UG' | 'chr' | 'chr-US' | 'crh-UA' | 'cs' | 'cs-CZ' | 'csb-PL' | 'cv-RU' | 'cy' | 'cy-GB' | 'da' | 'da-DK' | 'dav' | 'dav-KE' | 'de' | 'de-AT' | 'de-BE' | 'de-CH' | 'de-DE' | 'de-LI' | 'de-LU' | 'dv-MV' | 'dz-BT' | 'ebu' | 'ebu-KE' | 'ee' | 'ee-GH' | 'ee-TG' | 'el' | 'el-CY' | 'el-GR' | 'en' | 'en-AG' | 'en-AS' | 'en-AU' | 'en-BE' | 'en-BW' | 'en-BZ' | 'en-CA' | 'en-DK' | 'en-GB' | 'en-GU' | 'en-HK' | 'en-IE' | 'en-IN' | 'en-JM' | 'en-MH' | 'en-MP' | 'en-MT' | 'en-MU' | 'en-NA' | 'en-NG' | 'en-NZ' | 'en-PH' | 'en-PK' | 'en-SG' | 'en-TT' | 'en-UM' | 'en-US' | 'en-VI' | 'en-ZA' | 'en-ZM' | 'en-ZW' | 'eo' | 'es' | 'es-419' | 'es-AR' | 'es-BO' | 'es-CL' | 'es-CO' | 'es-CR' | 'es-CU' | 'es-DO' | 'es-EC' | 'es-ES' | 'es-GQ' | 'es-GT' | 'es-HN' | 'es-MX' | 'es-NI' | 'es-PA' | 'es-PE' | 'es-PR' | 'es-PY' | 'es-SV' | 'es-US' | 'es-UY' | 'es-VE' | 'et' | 'et-EE' | 'eu' | 'eu-ES' | 'fa' | 'fa-AF' | 'fa-IR' | 'ff' | 'ff-SN' | 'fi' | 'fi-FI' | 'fil' | 'fil-PH' | 'fo' | 'fo-FO' | 'fr' | 'fr-BE' | 'fr-BF' | 'fr-BI' | 'fr-BJ' | 'fr-BL' | 'fr-CA' | 'fr-CD' | 'fr-CF' | 'fr-CG' | 'fr-CH' | 'fr-CI' | 'fr-CM' | 'fr-DJ' | 'fr-FR' | 'fr-GA' | 'fr-GN' | 'fr-GP' | 'fr-GQ' | 'fr-KM' | 'fr-LU' | 'fr-MC' | 'fr-MF' | 'fr-MG' | 'fr-ML' | 'fr-MQ' | 'fr-NE' | 'fr-RE' | 'fr-RW' | 'fr-SN' | 'fr-TD' | 'fr-TG' | 'fur-IT' | 'fy-DE' | 'fy-NL' | 'ga' | 'ga-IE' | 'gd-GB' | 'gez-ER' | 'gez-ET' | 'gl' | 'gl-ES' | 'gsw' | 'gsw-CH' | 'gu' | 'gu-IN' | 'guz' | 'guz-KE' | 'gv' | 'gv-GB' | 'ha' | 'ha-Latn' | 'ha-Latn-GH' | 'ha-Latn-NE' | 'ha-Latn-NG' | 'ha-NG' | 'haw' | 'haw-US' | 'he' | 'he-IL' | 'hi' | 'hi-IN' | 'hne-IN' | 'hr' | 'hr-HR' | 'hsb-DE' | 'ht-HT' | 'hu' | 'hu-HU' | 'hy' | 'hy-AM' | 'id' | 'id-ID' | 'ig' | 'ig-NG' | 'ii' | 'ii-CN' | 'ik-CA' | 'is' | 'is-IS' | 'it' | 'it-CH' | 'it-IT' | 'iu-CA' | 'iw-IL' | 'ja' | 'ja-JP' | 'jmc' | 'jmc-TZ' | 'ka' | 'ka-GE' | 'kab' | 'kab-DZ' | 'kam' | 'kam-KE' | 'kde' | 'kde-TZ' | 'kea' | 'kea-CV' | 'khq' | 'khq-ML' | 'ki' | 'ki-KE' | 'kk' | 'kk-Cyrl' | 'kk-Cyrl-KZ' | 'kk-KZ' | 'kl' | 'kl-GL' | 'kln' | 'kln-KE' | 'km' | 'km-KH' | 'kn' | 'kn-IN' | 'ko' | 'ko-KR' | 'kok' | 'kok-IN' | 'ks-IN' | 'ku-TR' | 'kw' | 'kw-GB' | 'ky-KG' | 'lag' | 'lag-TZ' | 'lb-LU' | 'lg' | 'lg-UG' | 'li-BE' | 'li-NL' | 'lij-IT' | 'lo-LA' | 'lt' | 'lt-LT' | 'luo' | 'luo-KE' | 'luy' | 'luy-KE' | 'lv' | 'lv-LV' | 'mag-IN' | 'mai-IN' | 'mas' | 'mas-KE' | 'mas-TZ' | 'mer' | 'mer-KE' | 'mfe' | 'mfe-MU' | 'mg' | 'mg-MG' | 'mhr-RU' | 'mi-NZ' | 'mk' | 'mk-MK' | 'ml' | 'ml-IN' | 'mn-MN' | 'mr' | 'mr-IN' | 'ms' | 'ms-BN' | 'ms-MY' | 'mt' | 'mt-MT' | 'my' | 'my-MM' | 'nan-TW' | 'naq' | 'naq-NA' | 'nb' | 'nb-NO' | 'nd' | 'nd-ZW' | 'nds-DE' | 'nds-NL' | 'ne' | 'ne-IN' | 'ne-NP' | 'nl' | 'nl-AW' | 'nl-BE' | 'nl-NL' | 'nn' | 'nn-NO' | 'nr-ZA' | 'nso-ZA' | 'nyn' | 'nyn-UG' | 'oc-FR' | 'om' | 'om-ET' | 'om-KE' | 'or' | 'or-IN' | 'os-RU' | 'pa' | 'pa-Arab' | 'pa-Arab-PK' | 'pa-Guru' | 'pa-Guru-IN' | 'pa-IN' | 'pa-PK' | 'pap-AN' | 'pl' | 'pl-PL' | 'ps' | 'ps-AF' | 'pt' | 'pt-BR' | 'pt-GW' | 'pt-MZ' | 'pt-PT' | 'rm' | 'rm-CH' | 'ro' | 'ro-MD' | 'ro-RO' | 'rof' | 'rof-TZ' | 'ru' | 'ru-MD' | 'ru-RU' | 'ru-UA' | 'rw' | 'rw-RW' | 'rwk' | 'rwk-TZ' | 'sa-IN' | 'saq' | 'saq-KE' | 'sc-IT' | 'sd-IN' | 'se-NO' | 'seh' | 'seh-MZ' | 'ses' | 'ses-ML' | 'sg' | 'sg-CF' | 'shi' | 'shi-Latn' | 'shi-Latn-MA' | 'shi-Tfng' | 'shi-Tfng-MA' | 'shs-CA' | 'si' | 'si-LK' | 'sid-ET' | 'sk' | 'sk-SK' | 'sl' | 'sl-SI' | 'sn' | 'sn-ZW' | 'so' | 'so-DJ' | 'so-ET' | 'so-KE' | 'so-SO' | 'sq' | 'sq-AL' | 'sq-MK' | 'sr' | 'sr-Cyrl' | 'sr-Cyrl-BA' | 'sr-Cyrl-ME' | 'sr-Cyrl-RS' | 'sr-Latn' | 'sr-Latn-BA' | 'sr-Latn-ME' | 'sr-Latn-RS' | 'sr-ME' | 'sr-RS' | 'ss-ZA' | 'st-ZA' | 'sv' | 'sv-FI' | 'sv-SE' | 'sw' | 'sw-KE' | 'sw-TZ' | 'ta' | 'ta-IN' | 'ta-LK' | 'te' | 'te-IN' | 'teo' | 'teo-KE' | 'teo-UG' | 'tg-TJ' | 'th' | 'th-TH' | 'ti' | 'ti-ER' | 'ti-ET' | 'tig-ER' | 'tk-TM' | 'tl-PH' | 'tn-ZA' | 'to' | 'to-TO' | 'tr' | 'tr-CY' | 'tr-TR' | 'ts-ZA' | 'tt-RU' | 'tzm' | 'tzm-Latn' | 'tzm-Latn-MA' | 'ug-CN' | 'uk' | 'uk-UA' | 'unm-US' | 'ur' | 'ur-IN' | 'ur-PK' | 'uz' | 'uz-Arab' | 'uz-Arab-AF' | 'uz-Cyrl' | 'uz-Cyrl-UZ' | 'uz-Latn' | 'uz-Latn-UZ' | 'uz-UZ' | 've-ZA' | 'vi' | 'vi-VN' | 'vun' | 'vun-TZ' | 'wa-BE' | 'wae-CH' | 'wal-ET' | 'wo-SN' | 'xh-ZA' | 'xog' | 'xog-UG' | 'yi-US' | 'yo' | 'yo-NG' | 'yue-HK' | 'zh' | 'zh-CN' | 'zh-HK' | 'zh-Hans' | 'zh-Hans-CN' | 'zh-Hans-HK' | 'zh-Hans-MO' | 'zh-Hans-SG' | 'zh-Hant' | 'zh-Hant-HK' | 'zh-Hant-MO' | 'zh-Hant-TW' | 'zh-SG' | 'zh-TW' | 'zu' | 'zu-ZA' | 'auto';
977
- /**
978
- * Selects which markdown conversion strategy to use. "full_page" converts the
979
- * entire HTML page. "main_content" uses Mozilla Readability to extract the main
980
- * article content before converting.
981
- */
982
- markdown_backend?: 'full_page' | 'main_content';
983
- /**
984
- * HTTP method for the request
985
- */
986
- method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
987
- /**
988
- * Filters for capturing network traffic
989
- */
990
- network_capture?: Array<Input.NetworkCapture>;
991
- /**
992
- * Operating system to emulate
993
- */
994
- os?: 'windows' | 'mac os' | 'linux' | 'android' | 'ios';
995
- /**
996
- * Whether to parse the response content
997
- */
998
- parse?: boolean;
999
- /**
1000
- * Custom parser configuration as a key-value map
1001
- */
1002
- parser?: {
1003
- [key: string]: unknown;
1004
- } | string;
1005
- /**
1006
- * Referrer policy for the request
1007
- */
1008
- referrer_type?: 'random' | 'no-referer' | 'same-origin' | 'google' | 'bing' | 'facebook' | 'twitter' | 'instagram';
1009
- /**
1010
- * Whether to render JavaScript content using a browser. Use 'auto' to let the
1011
- * engine select the candidate config per domain.
1012
- */
1013
- render?: boolean | 'auto';
1014
- /**
1015
- * Request timeout in milliseconds
1016
- */
1017
- request_timeout?: number;
1018
- session?: Input.Session;
1019
- /**
1020
- * Skills or capabilities required for the request
1021
- */
1022
- skill?: string | Array<string>;
1023
- /**
1024
- * US state for geolocation (only valid when country is US)
1025
- */
1026
- state?: 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'VI' | 'WA' | 'WV' | 'WI' | 'WY';
1027
- /**
1028
- * Whether to compress stored data
1029
- */
1030
- storage_compress?: boolean;
1031
- /**
1032
- * Custom name for the stored object
1033
- */
1034
- storage_object_name?: string;
1035
- /**
1036
- * Type of storage to use for results
1037
- */
1038
- storage_type?: string;
1039
- /**
1040
- * URL for storage location
1041
- */
1042
- storage_url?: string;
1043
- /**
1044
- * User-defined tag for request identification
1045
- */
1046
- tag?: string;
1047
- /**
1048
- * Target URL to scrape
1049
- */
1050
- url?: string;
1051
- }
1052
- namespace Input {
1053
- interface UnionMember1 {
1054
- name: 'chrome' | 'firefox';
1055
- /**
1056
- * Specific browser version to emulate
1057
- */
1058
- version?: string;
1059
- }
1060
- interface UnionMember0 {
1061
- creation?: string | null;
1062
- domain?: string | null;
1063
- expires?: string;
1064
- extensions?: Array<string> | null;
1065
- hostOnly?: boolean | null;
1066
- httpOnly?: boolean | null;
1067
- lastAccessed?: string | null;
1068
- maxAge?: 'Infinity' | '-Infinity' | number | null;
1069
- name?: string;
1070
- path?: string | null;
1071
- pathIsDefault?: boolean | null;
1072
- sameSite?: 'strict' | 'lax' | 'none';
1073
- secure?: boolean;
1074
- value?: string;
1075
- [k: string]: unknown;
1076
- }
1077
- interface NetworkCapture {
1078
- method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
1079
- /**
1080
- * Resource type for network capture filtering
1081
- */
1082
- resource_type?: string | Array<string>;
1083
- status_code?: number | Array<number>;
1084
- url?: NetworkCapture.URL;
1085
- validation?: boolean;
1086
- wait_for_requests_count?: number;
1087
- wait_for_requests_count_timeout?: number;
1088
- }
1089
- namespace NetworkCapture {
1090
- interface URL {
1091
- value: string;
1092
- type?: 'exact' | 'contains';
1093
- }
1094
- }
1095
- interface Session {
1096
- id?: string;
1097
- prefetch_userbrowser?: boolean;
1098
- renew_on_blocked?: boolean;
1099
- retry?: boolean;
1100
- timeout?: number;
1101
- }
1102
- }
1103
- /**
1104
- * Shared parameters applied to the entire batch. Can include extraction parameters
1105
- * and async/storage settings.
1106
- */
1107
- interface SharedInputs {
1108
- /**
1109
- * Custom flow for the optimization engine: maps candidate names to the number of
1110
- * attempts to spend on each candidate before advancing (0 skips it). Key order
1111
- * defines the flow order. Providing it opts the request into 'auto' driver
1112
- * selection.
1113
- */
1114
- auto_driver_configuration?: {
1115
- [key: string]: number;
1116
- };
1117
- /**
1118
- * Request body for POST, PUT, PATCH methods
1119
- */
1120
- body?: unknown;
1121
- /**
1122
- * Browser type to emulate
1123
- */
1124
- browser?: 'chrome' | 'firefox' | SharedInputs.UnionMember1;
1125
- /**
1126
- * Array of browser automation actions to execute sequentially
1127
- */
1128
- browser_actions?: Array<Shared.AutoScrollAction | Shared.ClickAction | Shared.EvalAction | Shared.FetchAction | Shared.FillAction | Shared.GetCookiesAction | Shared.GotoAction | Shared.PressAction | Shared.ScreenshotAction | Shared.ScrollAction | Shared.WaitAction | Shared.WaitForElementAction | Shared.WaitForNavigationAction>;
1129
- /**
1130
- * URL to call back when async operation completes
1131
- */
1132
- callback_url?: string;
1133
- /**
1134
- * City for geolocation
1135
- */
1136
- city?: string;
1137
- /**
1138
- * Whether to automatically handle cookie consent headers
1139
- */
1140
- consent_header?: boolean;
1141
- /**
1142
- * Browser cookies as array of cookie objects
1143
- */
1144
- cookies?: Array<SharedInputs.UnionMember0> | string;
1145
- /**
1146
- * Country code for geolocation and proxy selection
1147
- */
1148
- country?: 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ALL';
1149
- /**
1150
- * Device type for browser emulation
1151
- */
1152
- device?: 'desktop' | 'mobile' | 'tablet';
1153
- /**
1154
- * Browser driver to use. Use 'auto' to let the engine select the candidate config
1155
- * per domain.
1156
- */
1157
- driver?: 'auto' | 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro' | 'media-vx6' | 'fast-vx6';
1158
- /**
1159
- * Expected HTTP status codes for successful requests
1160
- */
1161
- expected_status_codes?: Array<number>;
1162
- /**
1163
- * List of acceptable response formats in order of preference
1164
- */
1165
- formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
1166
- /**
1167
- * Custom HTTP headers to include in the request
1168
- */
1169
- headers?: {
1170
- [key: string]: string | Array<string> | null;
1171
- };
1172
- /**
1173
- * Whether to use HTTP/2 protocol
1174
- */
1175
- http2?: boolean;
1176
- /**
1177
- * Whether to emulate XMLHttpRequest behavior
1178
- */
1179
- is_xhr?: boolean;
1180
- /**
1181
- * Locale for browser language and region settings
1182
- */
1183
- locale?: 'aa-DJ' | 'aa-ER' | 'aa-ET' | 'af' | 'af-NA' | 'af-ZA' | 'ak' | 'ak-GH' | 'am' | 'am-ET' | 'an-ES' | 'ar' | 'ar-AE' | 'ar-BH' | 'ar-DZ' | 'ar-EG' | 'ar-IN' | 'ar-IQ' | 'ar-JO' | 'ar-KW' | 'ar-LB' | 'ar-LY' | 'ar-MA' | 'ar-OM' | 'ar-QA' | 'ar-SA' | 'ar-SD' | 'ar-SY' | 'ar-TN' | 'ar-YE' | 'as' | 'as-IN' | 'asa' | 'asa-TZ' | 'ast-ES' | 'az' | 'az-AZ' | 'az-Cyrl' | 'az-Cyrl-AZ' | 'az-Latn' | 'az-Latn-AZ' | 'be' | 'be-BY' | 'bem' | 'bem-ZM' | 'ber-DZ' | 'ber-MA' | 'bez' | 'bez-TZ' | 'bg' | 'bg-BG' | 'bho-IN' | 'bm' | 'bm-ML' | 'bn' | 'bn-BD' | 'bn-IN' | 'bo' | 'bo-CN' | 'bo-IN' | 'br-FR' | 'brx-IN' | 'bs' | 'bs-BA' | 'byn-ER' | 'ca' | 'ca-AD' | 'ca-ES' | 'ca-FR' | 'ca-IT' | 'cgg' | 'cgg-UG' | 'chr' | 'chr-US' | 'crh-UA' | 'cs' | 'cs-CZ' | 'csb-PL' | 'cv-RU' | 'cy' | 'cy-GB' | 'da' | 'da-DK' | 'dav' | 'dav-KE' | 'de' | 'de-AT' | 'de-BE' | 'de-CH' | 'de-DE' | 'de-LI' | 'de-LU' | 'dv-MV' | 'dz-BT' | 'ebu' | 'ebu-KE' | 'ee' | 'ee-GH' | 'ee-TG' | 'el' | 'el-CY' | 'el-GR' | 'en' | 'en-AG' | 'en-AS' | 'en-AU' | 'en-BE' | 'en-BW' | 'en-BZ' | 'en-CA' | 'en-DK' | 'en-GB' | 'en-GU' | 'en-HK' | 'en-IE' | 'en-IN' | 'en-JM' | 'en-MH' | 'en-MP' | 'en-MT' | 'en-MU' | 'en-NA' | 'en-NG' | 'en-NZ' | 'en-PH' | 'en-PK' | 'en-SG' | 'en-TT' | 'en-UM' | 'en-US' | 'en-VI' | 'en-ZA' | 'en-ZM' | 'en-ZW' | 'eo' | 'es' | 'es-419' | 'es-AR' | 'es-BO' | 'es-CL' | 'es-CO' | 'es-CR' | 'es-CU' | 'es-DO' | 'es-EC' | 'es-ES' | 'es-GQ' | 'es-GT' | 'es-HN' | 'es-MX' | 'es-NI' | 'es-PA' | 'es-PE' | 'es-PR' | 'es-PY' | 'es-SV' | 'es-US' | 'es-UY' | 'es-VE' | 'et' | 'et-EE' | 'eu' | 'eu-ES' | 'fa' | 'fa-AF' | 'fa-IR' | 'ff' | 'ff-SN' | 'fi' | 'fi-FI' | 'fil' | 'fil-PH' | 'fo' | 'fo-FO' | 'fr' | 'fr-BE' | 'fr-BF' | 'fr-BI' | 'fr-BJ' | 'fr-BL' | 'fr-CA' | 'fr-CD' | 'fr-CF' | 'fr-CG' | 'fr-CH' | 'fr-CI' | 'fr-CM' | 'fr-DJ' | 'fr-FR' | 'fr-GA' | 'fr-GN' | 'fr-GP' | 'fr-GQ' | 'fr-KM' | 'fr-LU' | 'fr-MC' | 'fr-MF' | 'fr-MG' | 'fr-ML' | 'fr-MQ' | 'fr-NE' | 'fr-RE' | 'fr-RW' | 'fr-SN' | 'fr-TD' | 'fr-TG' | 'fur-IT' | 'fy-DE' | 'fy-NL' | 'ga' | 'ga-IE' | 'gd-GB' | 'gez-ER' | 'gez-ET' | 'gl' | 'gl-ES' | 'gsw' | 'gsw-CH' | 'gu' | 'gu-IN' | 'guz' | 'guz-KE' | 'gv' | 'gv-GB' | 'ha' | 'ha-Latn' | 'ha-Latn-GH' | 'ha-Latn-NE' | 'ha-Latn-NG' | 'ha-NG' | 'haw' | 'haw-US' | 'he' | 'he-IL' | 'hi' | 'hi-IN' | 'hne-IN' | 'hr' | 'hr-HR' | 'hsb-DE' | 'ht-HT' | 'hu' | 'hu-HU' | 'hy' | 'hy-AM' | 'id' | 'id-ID' | 'ig' | 'ig-NG' | 'ii' | 'ii-CN' | 'ik-CA' | 'is' | 'is-IS' | 'it' | 'it-CH' | 'it-IT' | 'iu-CA' | 'iw-IL' | 'ja' | 'ja-JP' | 'jmc' | 'jmc-TZ' | 'ka' | 'ka-GE' | 'kab' | 'kab-DZ' | 'kam' | 'kam-KE' | 'kde' | 'kde-TZ' | 'kea' | 'kea-CV' | 'khq' | 'khq-ML' | 'ki' | 'ki-KE' | 'kk' | 'kk-Cyrl' | 'kk-Cyrl-KZ' | 'kk-KZ' | 'kl' | 'kl-GL' | 'kln' | 'kln-KE' | 'km' | 'km-KH' | 'kn' | 'kn-IN' | 'ko' | 'ko-KR' | 'kok' | 'kok-IN' | 'ks-IN' | 'ku-TR' | 'kw' | 'kw-GB' | 'ky-KG' | 'lag' | 'lag-TZ' | 'lb-LU' | 'lg' | 'lg-UG' | 'li-BE' | 'li-NL' | 'lij-IT' | 'lo-LA' | 'lt' | 'lt-LT' | 'luo' | 'luo-KE' | 'luy' | 'luy-KE' | 'lv' | 'lv-LV' | 'mag-IN' | 'mai-IN' | 'mas' | 'mas-KE' | 'mas-TZ' | 'mer' | 'mer-KE' | 'mfe' | 'mfe-MU' | 'mg' | 'mg-MG' | 'mhr-RU' | 'mi-NZ' | 'mk' | 'mk-MK' | 'ml' | 'ml-IN' | 'mn-MN' | 'mr' | 'mr-IN' | 'ms' | 'ms-BN' | 'ms-MY' | 'mt' | 'mt-MT' | 'my' | 'my-MM' | 'nan-TW' | 'naq' | 'naq-NA' | 'nb' | 'nb-NO' | 'nd' | 'nd-ZW' | 'nds-DE' | 'nds-NL' | 'ne' | 'ne-IN' | 'ne-NP' | 'nl' | 'nl-AW' | 'nl-BE' | 'nl-NL' | 'nn' | 'nn-NO' | 'nr-ZA' | 'nso-ZA' | 'nyn' | 'nyn-UG' | 'oc-FR' | 'om' | 'om-ET' | 'om-KE' | 'or' | 'or-IN' | 'os-RU' | 'pa' | 'pa-Arab' | 'pa-Arab-PK' | 'pa-Guru' | 'pa-Guru-IN' | 'pa-IN' | 'pa-PK' | 'pap-AN' | 'pl' | 'pl-PL' | 'ps' | 'ps-AF' | 'pt' | 'pt-BR' | 'pt-GW' | 'pt-MZ' | 'pt-PT' | 'rm' | 'rm-CH' | 'ro' | 'ro-MD' | 'ro-RO' | 'rof' | 'rof-TZ' | 'ru' | 'ru-MD' | 'ru-RU' | 'ru-UA' | 'rw' | 'rw-RW' | 'rwk' | 'rwk-TZ' | 'sa-IN' | 'saq' | 'saq-KE' | 'sc-IT' | 'sd-IN' | 'se-NO' | 'seh' | 'seh-MZ' | 'ses' | 'ses-ML' | 'sg' | 'sg-CF' | 'shi' | 'shi-Latn' | 'shi-Latn-MA' | 'shi-Tfng' | 'shi-Tfng-MA' | 'shs-CA' | 'si' | 'si-LK' | 'sid-ET' | 'sk' | 'sk-SK' | 'sl' | 'sl-SI' | 'sn' | 'sn-ZW' | 'so' | 'so-DJ' | 'so-ET' | 'so-KE' | 'so-SO' | 'sq' | 'sq-AL' | 'sq-MK' | 'sr' | 'sr-Cyrl' | 'sr-Cyrl-BA' | 'sr-Cyrl-ME' | 'sr-Cyrl-RS' | 'sr-Latn' | 'sr-Latn-BA' | 'sr-Latn-ME' | 'sr-Latn-RS' | 'sr-ME' | 'sr-RS' | 'ss-ZA' | 'st-ZA' | 'sv' | 'sv-FI' | 'sv-SE' | 'sw' | 'sw-KE' | 'sw-TZ' | 'ta' | 'ta-IN' | 'ta-LK' | 'te' | 'te-IN' | 'teo' | 'teo-KE' | 'teo-UG' | 'tg-TJ' | 'th' | 'th-TH' | 'ti' | 'ti-ER' | 'ti-ET' | 'tig-ER' | 'tk-TM' | 'tl-PH' | 'tn-ZA' | 'to' | 'to-TO' | 'tr' | 'tr-CY' | 'tr-TR' | 'ts-ZA' | 'tt-RU' | 'tzm' | 'tzm-Latn' | 'tzm-Latn-MA' | 'ug-CN' | 'uk' | 'uk-UA' | 'unm-US' | 'ur' | 'ur-IN' | 'ur-PK' | 'uz' | 'uz-Arab' | 'uz-Arab-AF' | 'uz-Cyrl' | 'uz-Cyrl-UZ' | 'uz-Latn' | 'uz-Latn-UZ' | 'uz-UZ' | 've-ZA' | 'vi' | 'vi-VN' | 'vun' | 'vun-TZ' | 'wa-BE' | 'wae-CH' | 'wal-ET' | 'wo-SN' | 'xh-ZA' | 'xog' | 'xog-UG' | 'yi-US' | 'yo' | 'yo-NG' | 'yue-HK' | 'zh' | 'zh-CN' | 'zh-HK' | 'zh-Hans' | 'zh-Hans-CN' | 'zh-Hans-HK' | 'zh-Hans-MO' | 'zh-Hans-SG' | 'zh-Hant' | 'zh-Hant-HK' | 'zh-Hant-MO' | 'zh-Hant-TW' | 'zh-SG' | 'zh-TW' | 'zu' | 'zu-ZA' | 'auto';
1184
- /**
1185
- * Selects which markdown conversion strategy to use. "full_page" converts the
1186
- * entire HTML page. "main_content" uses Mozilla Readability to extract the main
1187
- * article content before converting.
1188
- */
1189
- markdown_backend?: 'full_page' | 'main_content';
1190
- /**
1191
- * HTTP method for the request
1192
- */
1193
- method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
1194
- /**
1195
- * Filters for capturing network traffic
1196
- */
1197
- network_capture?: Array<SharedInputs.NetworkCapture>;
1198
- /**
1199
- * Operating system to emulate
1200
- */
1201
- os?: 'windows' | 'mac os' | 'linux' | 'android' | 'ios';
1202
- /**
1203
- * Whether to parse the response content
1204
- */
1205
- parse?: boolean;
1206
- /**
1207
- * Custom parser configuration as a key-value map
1208
- */
1209
- parser?: {
1210
- [key: string]: unknown;
1211
- } | string;
1212
- /**
1213
- * Referrer policy for the request
1214
- */
1215
- referrer_type?: 'random' | 'no-referer' | 'same-origin' | 'google' | 'bing' | 'facebook' | 'twitter' | 'instagram';
1216
- /**
1217
- * Whether to render JavaScript content using a browser. Use 'auto' to let the
1218
- * engine select the candidate config per domain.
1219
- */
1220
- render?: boolean | 'auto';
1221
- /**
1222
- * Request timeout in milliseconds
1223
- */
1224
- request_timeout?: number;
1225
- session?: SharedInputs.Session;
1226
- /**
1227
- * Skills or capabilities required for the request
1228
- */
1229
- skill?: string | Array<string>;
1230
- /**
1231
- * US state for geolocation (only valid when country is US)
1232
- */
1233
- state?: 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'VI' | 'WA' | 'WV' | 'WI' | 'WY';
1234
- /**
1235
- * Whether to compress stored data
1236
- */
1237
- storage_compress?: boolean;
1238
- /**
1239
- * Custom name for the stored object
1240
- */
1241
- storage_object_name?: string;
1242
- /**
1243
- * Type of storage to use for results
1244
- */
1245
- storage_type?: string;
1246
- /**
1247
- * URL for storage location
1248
- */
1249
- storage_url?: string;
1250
- /**
1251
- * User-defined tag for request identification
1252
- */
1253
- tag?: string;
1254
- /**
1255
- * Target URL to scrape
1256
- */
1257
- url?: string;
1258
- }
1259
- namespace SharedInputs {
1260
- interface UnionMember1 {
1261
- name: 'chrome' | 'firefox';
1262
- /**
1263
- * Specific browser version to emulate
1264
- */
1265
- version?: string;
1266
- }
1267
- interface UnionMember0 {
1268
- creation?: string | null;
1269
- domain?: string | null;
1270
- expires?: string;
1271
- extensions?: Array<string> | null;
1272
- hostOnly?: boolean | null;
1273
- httpOnly?: boolean | null;
1274
- lastAccessed?: string | null;
1275
- maxAge?: 'Infinity' | '-Infinity' | number | null;
1276
- name?: string;
1277
- path?: string | null;
1278
- pathIsDefault?: boolean | null;
1279
- sameSite?: 'strict' | 'lax' | 'none';
1280
- secure?: boolean;
1281
- value?: string;
1282
- [k: string]: unknown;
1283
- }
1284
- interface NetworkCapture {
1285
- method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
1286
- /**
1287
- * Resource type for network capture filtering
1288
- */
1289
- resource_type?: string | Array<string>;
1290
- status_code?: number | Array<number>;
1291
- url?: NetworkCapture.URL;
1292
- validation?: boolean;
1293
- wait_for_requests_count?: number;
1294
- wait_for_requests_count_timeout?: number;
1295
- }
1296
- namespace NetworkCapture {
1297
- interface URL {
1298
- value: string;
1299
- type?: 'exact' | 'contains';
1300
- }
1301
- }
1302
- interface Session {
1303
- id?: string;
1304
- prefetch_userbrowser?: boolean;
1305
- renew_on_blocked?: boolean;
1306
- retry?: boolean;
1307
- timeout?: number;
1308
- }
1309
- }
1310
- }
1311
110
  export interface MapParams {
1312
111
  /**
1313
112
  * Url to map.
@@ -1411,6 +210,6 @@ export interface SearchParams {
1411
210
  time_range?: 'hour' | 'day' | 'week' | 'month' | 'year' | null;
1412
211
  }
1413
212
  export declare namespace TopLevel {
1414
- export { type ExtractResponse as ExtractResponse, type ExtractAsyncResponse as ExtractAsyncResponse, type ExtractBatchResponse as ExtractBatchResponse, type MapResponse as MapResponse, type SearchResponse as SearchResponse, type ExtractParams as ExtractParams, type ExtractAsyncParams as ExtractAsyncParams, type ExtractBatchParams as ExtractBatchParams, type MapParams as MapParams, type SearchParams as SearchParams, };
213
+ export { type MapResponse as MapResponse, type SearchResponse as SearchResponse, type MapParams as MapParams, type SearchParams as SearchParams, };
1415
214
  }
1416
215
  //# sourceMappingURL=top-level.d.ts.map