@apteva/integrations 0.15.8 → 0.15.10
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.
- package/package.json +1 -1
- package/src/apps/apify.json +705 -70
- package/src/apps/bookvault.json +309 -0
- package/src/apps/brightdata.json +22 -1
- package/src/apps/browse-ai.json +243 -5
- package/src/apps/browserbase.json +41 -11
- package/src/apps/browserless.json +101 -0
- package/src/apps/dataforseo.json +1 -0
- package/src/apps/digitalocean.json +53 -0
- package/src/apps/elevenlabs.json +283 -0
- package/src/apps/firecrawl.json +111 -0
- package/src/apps/ingram-coresource.json +119 -0
- package/src/apps/lulu-print.json +266 -0
- package/src/apps/publishdrive.json +132 -0
- package/src/apps/streetlib.json +60 -0
package/src/apps/apify.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"slug": "apify",
|
|
3
3
|
"name": "Apify",
|
|
4
|
-
"description": "Web scraping and automation platform.
|
|
4
|
+
"description": "Web scraping and automation platform. Search actors, run them with JSON input, monitor runs, and retrieve dataset results.",
|
|
5
5
|
"logo": "https://www.google.com/s2/favicons?domain=apify.com&sz=128",
|
|
6
6
|
"categories": [
|
|
7
7
|
"scraping",
|
|
@@ -28,28 +28,148 @@
|
|
|
28
28
|
},
|
|
29
29
|
"tools": [
|
|
30
30
|
{
|
|
31
|
-
"name": "
|
|
32
|
-
"description": "
|
|
33
|
-
"method": "
|
|
34
|
-
"path": "/
|
|
31
|
+
"name": "get_user",
|
|
32
|
+
"description": "Verify the Apify token and return the authenticated user's private account metadata.",
|
|
33
|
+
"method": "GET",
|
|
34
|
+
"path": "/users/me",
|
|
35
|
+
"input_schema": {
|
|
36
|
+
"type": "object",
|
|
37
|
+
"properties": {}
|
|
38
|
+
}
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
"name": "search_store_actors",
|
|
42
|
+
"description": "Search public Apify Store actors. Use this to discover real-estate, lead, social, search, scraping, or automation actors before running one. Prefer responseFormat='agent' for compact agent-readable results.",
|
|
43
|
+
"method": "GET",
|
|
44
|
+
"path": "/store",
|
|
45
|
+
"query_params": [
|
|
46
|
+
"search",
|
|
47
|
+
"limit",
|
|
48
|
+
"offset",
|
|
49
|
+
"sortBy",
|
|
50
|
+
"category",
|
|
51
|
+
"username",
|
|
52
|
+
"pricingModel",
|
|
53
|
+
"allowsAgenticUsers",
|
|
54
|
+
"responseFormat",
|
|
55
|
+
"includeUnrunnableActors"
|
|
56
|
+
],
|
|
35
57
|
"input_schema": {
|
|
36
58
|
"type": "object",
|
|
37
59
|
"properties": {
|
|
38
|
-
"
|
|
60
|
+
"search": {
|
|
39
61
|
"type": "string",
|
|
40
|
-
"description": "
|
|
62
|
+
"description": "Search text matched against actor title, name, description, username, and README, e.g. 'real estate listings'."
|
|
41
63
|
},
|
|
42
|
-
"
|
|
64
|
+
"limit": {
|
|
43
65
|
"type": "integer",
|
|
44
|
-
"description": "
|
|
66
|
+
"description": "Maximum actors to return. Default and maximum are 1000."
|
|
45
67
|
},
|
|
46
|
-
"
|
|
68
|
+
"offset": {
|
|
47
69
|
"type": "integer",
|
|
48
|
-
"description": "
|
|
70
|
+
"description": "Number of actors to skip for pagination."
|
|
49
71
|
},
|
|
50
|
-
"
|
|
72
|
+
"sortBy": {
|
|
73
|
+
"type": "string",
|
|
74
|
+
"description": "Sort field.",
|
|
75
|
+
"enum": [
|
|
76
|
+
"relevance",
|
|
77
|
+
"popularity",
|
|
78
|
+
"newest",
|
|
79
|
+
"lastUpdate"
|
|
80
|
+
]
|
|
81
|
+
},
|
|
82
|
+
"category": {
|
|
83
|
+
"type": "string",
|
|
84
|
+
"description": "Optional Apify Store category filter."
|
|
85
|
+
},
|
|
86
|
+
"username": {
|
|
87
|
+
"type": "string",
|
|
88
|
+
"description": "Only return actors from this Apify username."
|
|
89
|
+
},
|
|
90
|
+
"pricingModel": {
|
|
91
|
+
"type": "string",
|
|
92
|
+
"description": "Only return actors with this pricing model.",
|
|
93
|
+
"enum": [
|
|
94
|
+
"FREE",
|
|
95
|
+
"FLAT_PRICE_PER_MONTH",
|
|
96
|
+
"PRICE_PER_DATASET_ITEM",
|
|
97
|
+
"PAY_PER_EVENT"
|
|
98
|
+
]
|
|
99
|
+
},
|
|
100
|
+
"allowsAgenticUsers": {
|
|
101
|
+
"type": "boolean",
|
|
102
|
+
"description": "When true, only return actors marked as allowing agentic users."
|
|
103
|
+
},
|
|
104
|
+
"responseFormat": {
|
|
105
|
+
"type": "string",
|
|
106
|
+
"description": "Use 'agent' for a reduced field set optimized for LLM consumers; default is 'full'.",
|
|
107
|
+
"enum": [
|
|
108
|
+
"full",
|
|
109
|
+
"agent"
|
|
110
|
+
],
|
|
111
|
+
"default": "agent"
|
|
112
|
+
},
|
|
113
|
+
"includeUnrunnableActors": {
|
|
114
|
+
"type": "boolean",
|
|
115
|
+
"description": "By default unrunnable actors are excluded. Set true only when you intentionally need the full store search."
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
"name": "list_actors",
|
|
122
|
+
"description": "List actors the authenticated user created or used. Use my=true to list only actors owned by the user.",
|
|
123
|
+
"method": "GET",
|
|
124
|
+
"path": "/actors",
|
|
125
|
+
"query_params": [
|
|
126
|
+
"my",
|
|
127
|
+
"offset",
|
|
128
|
+
"limit",
|
|
129
|
+
"desc",
|
|
130
|
+
"sortBy"
|
|
131
|
+
],
|
|
132
|
+
"input_schema": {
|
|
133
|
+
"type": "object",
|
|
134
|
+
"properties": {
|
|
135
|
+
"my": {
|
|
136
|
+
"type": "boolean",
|
|
137
|
+
"description": "If true, only return actors owned by the authenticated user."
|
|
138
|
+
},
|
|
139
|
+
"offset": {
|
|
140
|
+
"type": "integer",
|
|
141
|
+
"description": "Number of actors to skip."
|
|
142
|
+
},
|
|
143
|
+
"limit": {
|
|
144
|
+
"type": "integer",
|
|
145
|
+
"description": "Maximum actors to return. Default and maximum are 1000."
|
|
146
|
+
},
|
|
147
|
+
"desc": {
|
|
148
|
+
"type": "boolean",
|
|
149
|
+
"description": "Sort descending when true."
|
|
150
|
+
},
|
|
151
|
+
"sortBy": {
|
|
152
|
+
"type": "string",
|
|
153
|
+
"description": "Sort field.",
|
|
154
|
+
"enum": [
|
|
155
|
+
"createdAt",
|
|
156
|
+
"stats.lastRunStartedAt"
|
|
157
|
+
]
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
"name": "get_actor",
|
|
164
|
+
"description": "Get details for a specific actor. actorId must be an Apify actor ID or a tilde-separated name like 'apify~web-scraper' or 'compass~crawler-google-places'. Do not use slash form in this API path.",
|
|
165
|
+
"method": "GET",
|
|
166
|
+
"path": "/actors/{actorId}",
|
|
167
|
+
"input_schema": {
|
|
168
|
+
"type": "object",
|
|
169
|
+
"properties": {
|
|
170
|
+
"actorId": {
|
|
51
171
|
"type": "string",
|
|
52
|
-
"description": "
|
|
172
|
+
"description": "Actor ID or tilde-separated owner/name, e.g. 'apify~web-scraper'."
|
|
53
173
|
}
|
|
54
174
|
},
|
|
55
175
|
"required": [
|
|
@@ -58,113 +178,476 @@
|
|
|
58
178
|
}
|
|
59
179
|
},
|
|
60
180
|
{
|
|
61
|
-
"name": "
|
|
62
|
-
"description": "Get
|
|
181
|
+
"name": "get_actor_openapi",
|
|
182
|
+
"description": "Get an actor build's OpenAPI definition, including the actor input schema when the actor exposes one. Use buildId='default' for the actor's default build. actorId must be an Apify actor ID or tilde-separated owner/name.",
|
|
63
183
|
"method": "GET",
|
|
64
|
-
"path": "/
|
|
184
|
+
"path": "/actors/{actorId}/builds/{buildId}/openapi.json",
|
|
65
185
|
"input_schema": {
|
|
66
186
|
"type": "object",
|
|
67
187
|
"properties": {
|
|
68
188
|
"actorId": {
|
|
69
189
|
"type": "string",
|
|
70
|
-
"description": "Actor ID or name
|
|
190
|
+
"description": "Actor ID or tilde-separated owner/name, e.g. 'apify~web-scraper'."
|
|
71
191
|
},
|
|
72
|
-
"
|
|
192
|
+
"buildId": {
|
|
73
193
|
"type": "string",
|
|
74
|
-
"description": "
|
|
75
|
-
|
|
76
|
-
"waitForFinish": {
|
|
77
|
-
"type": "integer",
|
|
78
|
-
"description": "Maximum time in seconds to wait for the run to finish. If provided, the endpoint will wait synchronously."
|
|
194
|
+
"description": "Actor build ID, or 'default' to fetch the default build OpenAPI schema.",
|
|
195
|
+
"default": "default"
|
|
79
196
|
}
|
|
80
197
|
},
|
|
81
198
|
"required": [
|
|
82
199
|
"actorId",
|
|
83
|
-
"
|
|
200
|
+
"buildId"
|
|
84
201
|
]
|
|
85
202
|
}
|
|
86
203
|
},
|
|
87
204
|
{
|
|
88
|
-
"name": "
|
|
89
|
-
"description": "
|
|
90
|
-
"method": "
|
|
91
|
-
"path": "/
|
|
205
|
+
"name": "run_actor",
|
|
206
|
+
"description": "Run an Apify actor asynchronously with a JSON input object. The response contains the run ID, status, defaultDatasetId, and defaultKeyValueStoreId. Poll get_run or fetch results from get_dataset_items after the run succeeds. actorId must be an Apify actor ID or tilde-separated owner/name, e.g. 'apify~web-scraper'.",
|
|
207
|
+
"method": "POST",
|
|
208
|
+
"path": "/actors/{actorId}/runs",
|
|
209
|
+
"query_params": [
|
|
210
|
+
"timeout",
|
|
211
|
+
"memory",
|
|
212
|
+
"maxItems",
|
|
213
|
+
"maxTotalChargeUsd",
|
|
214
|
+
"restartOnError",
|
|
215
|
+
"build",
|
|
216
|
+
"waitForFinish",
|
|
217
|
+
"webhooks",
|
|
218
|
+
"forcePermissionLevel"
|
|
219
|
+
],
|
|
220
|
+
"body_root_param": "input",
|
|
221
|
+
"timeout_ms": 65000,
|
|
92
222
|
"input_schema": {
|
|
93
223
|
"type": "object",
|
|
94
224
|
"properties": {
|
|
95
225
|
"actorId": {
|
|
96
226
|
"type": "string",
|
|
97
|
-
"description": "Actor ID or name
|
|
227
|
+
"description": "Actor ID or tilde-separated owner/name, e.g. 'apify~web-scraper'."
|
|
98
228
|
},
|
|
99
|
-
"
|
|
100
|
-
"type": "
|
|
101
|
-
"description": "
|
|
229
|
+
"input": {
|
|
230
|
+
"type": "object",
|
|
231
|
+
"description": "JSON input passed directly to the actor. Use get_actor_openapi or the actor's Apify Input tab to discover expected fields. Pass {} for actors with no input."
|
|
102
232
|
},
|
|
103
|
-
"
|
|
104
|
-
"type": "
|
|
105
|
-
"description": "
|
|
233
|
+
"timeout": {
|
|
234
|
+
"type": "number",
|
|
235
|
+
"description": "Optional actor run timeout in seconds."
|
|
106
236
|
},
|
|
107
|
-
"
|
|
108
|
-
"type": "
|
|
109
|
-
"description": "
|
|
237
|
+
"memory": {
|
|
238
|
+
"type": "number",
|
|
239
|
+
"description": "Optional memory limit in MB, usually a power of 2 such as 256, 512, 1024, 2048, or 4096."
|
|
240
|
+
},
|
|
241
|
+
"maxItems": {
|
|
242
|
+
"type": "number",
|
|
243
|
+
"description": "Maximum charged dataset items for pay-per-result actors. This is a billing cap, not a guaranteed result limit."
|
|
244
|
+
},
|
|
245
|
+
"maxTotalChargeUsd": {
|
|
246
|
+
"type": "number",
|
|
247
|
+
"description": "Maximum total charge in USD for pay-per-event actors."
|
|
248
|
+
},
|
|
249
|
+
"restartOnError": {
|
|
250
|
+
"type": "boolean",
|
|
251
|
+
"description": "Restart the actor run automatically if it fails."
|
|
252
|
+
},
|
|
253
|
+
"build": {
|
|
254
|
+
"type": "string",
|
|
255
|
+
"description": "Actor build tag or build number, e.g. 'latest' or '0.1.234'."
|
|
256
|
+
},
|
|
257
|
+
"waitForFinish": {
|
|
258
|
+
"type": "number",
|
|
259
|
+
"description": "Wait up to this many seconds for the async run to finish before returning. Maximum is 60."
|
|
260
|
+
},
|
|
261
|
+
"webhooks": {
|
|
262
|
+
"type": "string",
|
|
263
|
+
"description": "Base64-encoded JSON array of Apify webhook definitions for this run."
|
|
264
|
+
},
|
|
265
|
+
"forcePermissionLevel": {
|
|
266
|
+
"type": "string",
|
|
267
|
+
"description": "Optional per-run permission override.",
|
|
110
268
|
"enum": [
|
|
111
|
-
|
|
112
|
-
|
|
269
|
+
"LIMITED_PERMISSIONS",
|
|
270
|
+
"FULL_PERMISSIONS"
|
|
113
271
|
]
|
|
114
272
|
}
|
|
115
273
|
},
|
|
116
274
|
"required": [
|
|
117
|
-
"actorId"
|
|
275
|
+
"actorId",
|
|
276
|
+
"input"
|
|
118
277
|
]
|
|
119
278
|
}
|
|
120
279
|
},
|
|
121
280
|
{
|
|
122
|
-
"name": "
|
|
123
|
-
"description": "
|
|
124
|
-
"method": "
|
|
125
|
-
"path": "/get-dataset-items",
|
|
281
|
+
"name": "run_actor_sync_get_dataset_items",
|
|
282
|
+
"description": "Run an Apify actor and wait for dataset items in the response. This is the most convenient one-call path for agents when the actor finishes within roughly 5 minutes. For longer jobs, use run_actor then get_run and get_dataset_items.",
|
|
283
|
+
"method": "POST",
|
|
284
|
+
"path": "/actors/{actorId}/run-sync-get-dataset-items",
|
|
285
|
+
"query_params": [
|
|
286
|
+
"timeout",
|
|
287
|
+
"memory",
|
|
288
|
+
"maxItems",
|
|
289
|
+
"maxTotalChargeUsd",
|
|
290
|
+
"restartOnError",
|
|
291
|
+
"build",
|
|
292
|
+
"webhooks",
|
|
293
|
+
"format",
|
|
294
|
+
"clean",
|
|
295
|
+
"offset",
|
|
296
|
+
"limit",
|
|
297
|
+
"fields",
|
|
298
|
+
"outputFields",
|
|
299
|
+
"omit",
|
|
300
|
+
"unwind",
|
|
301
|
+
"flatten",
|
|
302
|
+
"desc"
|
|
303
|
+
],
|
|
304
|
+
"body_root_param": "input",
|
|
305
|
+
"timeout_ms": 305000,
|
|
126
306
|
"input_schema": {
|
|
127
307
|
"type": "object",
|
|
128
308
|
"properties": {
|
|
129
|
-
"
|
|
309
|
+
"actorId": {
|
|
310
|
+
"type": "string",
|
|
311
|
+
"description": "Actor ID or tilde-separated owner/name, e.g. 'apify~web-scraper'."
|
|
312
|
+
},
|
|
313
|
+
"input": {
|
|
314
|
+
"type": "object",
|
|
315
|
+
"description": "JSON input passed directly to the actor. Use get_actor_openapi or the actor's Apify Input tab to discover expected fields. Pass {} for actors with no input."
|
|
316
|
+
},
|
|
317
|
+
"timeout": {
|
|
318
|
+
"type": "number",
|
|
319
|
+
"description": "Optional actor run timeout in seconds."
|
|
320
|
+
},
|
|
321
|
+
"memory": {
|
|
322
|
+
"type": "number",
|
|
323
|
+
"description": "Optional memory limit in MB."
|
|
324
|
+
},
|
|
325
|
+
"maxItems": {
|
|
326
|
+
"type": "number",
|
|
327
|
+
"description": "Maximum charged dataset items for pay-per-result actors."
|
|
328
|
+
},
|
|
329
|
+
"maxTotalChargeUsd": {
|
|
330
|
+
"type": "number",
|
|
331
|
+
"description": "Maximum total charge in USD for pay-per-event actors."
|
|
332
|
+
},
|
|
333
|
+
"restartOnError": {
|
|
334
|
+
"type": "boolean",
|
|
335
|
+
"description": "Restart the actor run automatically if it fails."
|
|
336
|
+
},
|
|
337
|
+
"build": {
|
|
130
338
|
"type": "string",
|
|
131
|
-
"description": "
|
|
339
|
+
"description": "Actor build tag or build number."
|
|
340
|
+
},
|
|
341
|
+
"webhooks": {
|
|
342
|
+
"type": "string",
|
|
343
|
+
"description": "Base64-encoded JSON array of Apify webhook definitions for this run."
|
|
132
344
|
},
|
|
133
345
|
"format": {
|
|
134
346
|
"type": "string",
|
|
135
|
-
"description": "
|
|
347
|
+
"description": "Dataset result format.",
|
|
136
348
|
"enum": [
|
|
137
349
|
"json",
|
|
350
|
+
"jsonl",
|
|
138
351
|
"csv",
|
|
352
|
+
"html",
|
|
139
353
|
"xlsx",
|
|
140
354
|
"xml",
|
|
141
355
|
"rss"
|
|
142
356
|
],
|
|
143
357
|
"default": "json"
|
|
144
358
|
},
|
|
359
|
+
"clean": {
|
|
360
|
+
"type": "boolean",
|
|
361
|
+
"description": "Return only non-empty items and omit hidden fields."
|
|
362
|
+
},
|
|
145
363
|
"offset": {
|
|
146
364
|
"type": "integer",
|
|
147
|
-
"description": "Number of items to skip
|
|
365
|
+
"description": "Number of result items to skip."
|
|
148
366
|
},
|
|
149
367
|
"limit": {
|
|
150
368
|
"type": "integer",
|
|
151
|
-
"description": "Maximum
|
|
369
|
+
"description": "Maximum result items to return."
|
|
152
370
|
},
|
|
153
371
|
"fields": {
|
|
154
372
|
"type": "string",
|
|
155
|
-
"description": "Comma-separated
|
|
373
|
+
"description": "Comma-separated fields to include."
|
|
374
|
+
},
|
|
375
|
+
"outputFields": {
|
|
376
|
+
"type": "string",
|
|
377
|
+
"description": "Comma-separated output names that rename fields positionally."
|
|
156
378
|
},
|
|
157
379
|
"omit": {
|
|
158
380
|
"type": "string",
|
|
159
|
-
"description": "Comma-separated
|
|
381
|
+
"description": "Comma-separated fields to omit."
|
|
382
|
+
},
|
|
383
|
+
"unwind": {
|
|
384
|
+
"type": "string",
|
|
385
|
+
"description": "Comma-separated fields to unwind."
|
|
386
|
+
},
|
|
387
|
+
"flatten": {
|
|
388
|
+
"type": "string",
|
|
389
|
+
"description": "Comma-separated fields to flatten."
|
|
390
|
+
},
|
|
391
|
+
"desc": {
|
|
392
|
+
"type": "boolean",
|
|
393
|
+
"description": "Return dataset items newest first."
|
|
394
|
+
}
|
|
395
|
+
},
|
|
396
|
+
"required": [
|
|
397
|
+
"actorId",
|
|
398
|
+
"input"
|
|
399
|
+
]
|
|
400
|
+
}
|
|
401
|
+
},
|
|
402
|
+
{
|
|
403
|
+
"name": "run_actor_sync",
|
|
404
|
+
"description": "Run an Apify actor synchronously and return the actor's OUTPUT record from its default key-value store. Use this when the actor writes its final result to OUTPUT instead of a dataset.",
|
|
405
|
+
"method": "POST",
|
|
406
|
+
"path": "/actors/{actorId}/run-sync",
|
|
407
|
+
"query_params": [
|
|
408
|
+
"timeout",
|
|
409
|
+
"memory",
|
|
410
|
+
"maxItems",
|
|
411
|
+
"maxTotalChargeUsd",
|
|
412
|
+
"restartOnError",
|
|
413
|
+
"build",
|
|
414
|
+
"webhooks"
|
|
415
|
+
],
|
|
416
|
+
"body_root_param": "input",
|
|
417
|
+
"timeout_ms": 305000,
|
|
418
|
+
"input_schema": {
|
|
419
|
+
"type": "object",
|
|
420
|
+
"properties": {
|
|
421
|
+
"actorId": {
|
|
422
|
+
"type": "string",
|
|
423
|
+
"description": "Actor ID or tilde-separated owner/name, e.g. 'apify~web-scraper'."
|
|
424
|
+
},
|
|
425
|
+
"input": {
|
|
426
|
+
"type": "object",
|
|
427
|
+
"description": "JSON input passed directly to the actor. Pass {} for actors with no input."
|
|
428
|
+
},
|
|
429
|
+
"timeout": {
|
|
430
|
+
"type": "number",
|
|
431
|
+
"description": "Optional actor run timeout in seconds."
|
|
432
|
+
},
|
|
433
|
+
"memory": {
|
|
434
|
+
"type": "number",
|
|
435
|
+
"description": "Optional memory limit in MB."
|
|
436
|
+
},
|
|
437
|
+
"maxItems": {
|
|
438
|
+
"type": "number",
|
|
439
|
+
"description": "Maximum charged dataset items for pay-per-result actors."
|
|
440
|
+
},
|
|
441
|
+
"maxTotalChargeUsd": {
|
|
442
|
+
"type": "number",
|
|
443
|
+
"description": "Maximum total charge in USD for pay-per-event actors."
|
|
444
|
+
},
|
|
445
|
+
"restartOnError": {
|
|
446
|
+
"type": "boolean",
|
|
447
|
+
"description": "Restart the actor run automatically if it fails."
|
|
448
|
+
},
|
|
449
|
+
"build": {
|
|
450
|
+
"type": "string",
|
|
451
|
+
"description": "Actor build tag or build number."
|
|
452
|
+
},
|
|
453
|
+
"webhooks": {
|
|
454
|
+
"type": "string",
|
|
455
|
+
"description": "Base64-encoded JSON array of Apify webhook definitions for this run."
|
|
456
|
+
}
|
|
457
|
+
},
|
|
458
|
+
"required": [
|
|
459
|
+
"actorId",
|
|
460
|
+
"input"
|
|
461
|
+
]
|
|
462
|
+
}
|
|
463
|
+
},
|
|
464
|
+
{
|
|
465
|
+
"name": "get_run",
|
|
466
|
+
"description": "Get one actor run by runId. Use waitForFinish up to 60 seconds to poll until a terminal status is reached. The response includes defaultDatasetId for get_dataset_items.",
|
|
467
|
+
"method": "GET",
|
|
468
|
+
"path": "/actor-runs/{runId}",
|
|
469
|
+
"query_params": [
|
|
470
|
+
"waitForFinish"
|
|
471
|
+
],
|
|
472
|
+
"input_schema": {
|
|
473
|
+
"type": "object",
|
|
474
|
+
"properties": {
|
|
475
|
+
"runId": {
|
|
476
|
+
"type": "string",
|
|
477
|
+
"description": "Actor run ID returned by run_actor."
|
|
478
|
+
},
|
|
479
|
+
"waitForFinish": {
|
|
480
|
+
"type": "number",
|
|
481
|
+
"description": "Maximum seconds to wait for completion. Maximum is 60."
|
|
482
|
+
}
|
|
483
|
+
},
|
|
484
|
+
"required": [
|
|
485
|
+
"runId"
|
|
486
|
+
]
|
|
487
|
+
}
|
|
488
|
+
},
|
|
489
|
+
{
|
|
490
|
+
"name": "abort_run",
|
|
491
|
+
"description": "Abort a starting or running Apify actor run. Set gracefully=true to give the actor a short window to persist state before aborting.",
|
|
492
|
+
"method": "POST",
|
|
493
|
+
"path": "/actor-runs/{runId}/abort",
|
|
494
|
+
"query_params": [
|
|
495
|
+
"gracefully"
|
|
496
|
+
],
|
|
497
|
+
"input_schema": {
|
|
498
|
+
"type": "object",
|
|
499
|
+
"properties": {
|
|
500
|
+
"runId": {
|
|
501
|
+
"type": "string",
|
|
502
|
+
"description": "Actor run ID."
|
|
503
|
+
},
|
|
504
|
+
"gracefully": {
|
|
505
|
+
"type": "boolean",
|
|
506
|
+
"description": "Abort gracefully instead of killing immediately."
|
|
507
|
+
}
|
|
508
|
+
},
|
|
509
|
+
"required": [
|
|
510
|
+
"runId"
|
|
511
|
+
]
|
|
512
|
+
}
|
|
513
|
+
},
|
|
514
|
+
{
|
|
515
|
+
"name": "list_runs",
|
|
516
|
+
"description": "List runs for a specific actor. actorId must be an Apify actor ID or tilde-separated owner/name.",
|
|
517
|
+
"method": "GET",
|
|
518
|
+
"path": "/actors/{actorId}/runs",
|
|
519
|
+
"query_params": [
|
|
520
|
+
"offset",
|
|
521
|
+
"limit",
|
|
522
|
+
"desc",
|
|
523
|
+
"status",
|
|
524
|
+
"startedAfter",
|
|
525
|
+
"startedBefore"
|
|
526
|
+
],
|
|
527
|
+
"input_schema": {
|
|
528
|
+
"type": "object",
|
|
529
|
+
"properties": {
|
|
530
|
+
"actorId": {
|
|
531
|
+
"type": "string",
|
|
532
|
+
"description": "Actor ID or tilde-separated owner/name, e.g. 'apify~web-scraper'."
|
|
533
|
+
},
|
|
534
|
+
"offset": {
|
|
535
|
+
"type": "integer",
|
|
536
|
+
"description": "Number of runs to skip."
|
|
537
|
+
},
|
|
538
|
+
"limit": {
|
|
539
|
+
"type": "integer",
|
|
540
|
+
"description": "Maximum runs to return. Default and maximum are 1000."
|
|
541
|
+
},
|
|
542
|
+
"desc": {
|
|
543
|
+
"type": "boolean",
|
|
544
|
+
"description": "Sort newest first when true."
|
|
545
|
+
},
|
|
546
|
+
"status": {
|
|
547
|
+
"type": "string",
|
|
548
|
+
"description": "Single status or comma-separated statuses, e.g. 'SUCCEEDED' or 'RUNNING,READY'."
|
|
549
|
+
},
|
|
550
|
+
"startedAfter": {
|
|
551
|
+
"type": "string",
|
|
552
|
+
"description": "Only runs started after this ISO 8601 timestamp."
|
|
553
|
+
},
|
|
554
|
+
"startedBefore": {
|
|
555
|
+
"type": "string",
|
|
556
|
+
"description": "Only runs started before this ISO 8601 timestamp."
|
|
557
|
+
}
|
|
558
|
+
},
|
|
559
|
+
"required": [
|
|
560
|
+
"actorId"
|
|
561
|
+
]
|
|
562
|
+
}
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
"name": "list_user_runs",
|
|
566
|
+
"description": "List all actor runs for the authenticated user, optionally filtered by status or start time.",
|
|
567
|
+
"method": "GET",
|
|
568
|
+
"path": "/actor-runs",
|
|
569
|
+
"query_params": [
|
|
570
|
+
"offset",
|
|
571
|
+
"limit",
|
|
572
|
+
"desc",
|
|
573
|
+
"status",
|
|
574
|
+
"startedAfter",
|
|
575
|
+
"startedBefore"
|
|
576
|
+
],
|
|
577
|
+
"input_schema": {
|
|
578
|
+
"type": "object",
|
|
579
|
+
"properties": {
|
|
580
|
+
"offset": {
|
|
581
|
+
"type": "integer",
|
|
582
|
+
"description": "Number of runs to skip."
|
|
583
|
+
},
|
|
584
|
+
"limit": {
|
|
585
|
+
"type": "integer",
|
|
586
|
+
"description": "Maximum runs to return. Default and maximum are 1000."
|
|
160
587
|
},
|
|
161
588
|
"desc": {
|
|
589
|
+
"type": "boolean",
|
|
590
|
+
"description": "Sort newest first when true."
|
|
591
|
+
},
|
|
592
|
+
"status": {
|
|
593
|
+
"type": "string",
|
|
594
|
+
"description": "Single status or comma-separated statuses, e.g. 'SUCCEEDED' or 'RUNNING,READY'."
|
|
595
|
+
},
|
|
596
|
+
"startedAfter": {
|
|
597
|
+
"type": "string",
|
|
598
|
+
"description": "Only runs started after this ISO 8601 timestamp."
|
|
599
|
+
},
|
|
600
|
+
"startedBefore": {
|
|
601
|
+
"type": "string",
|
|
602
|
+
"description": "Only runs started before this ISO 8601 timestamp."
|
|
603
|
+
}
|
|
604
|
+
}
|
|
605
|
+
}
|
|
606
|
+
},
|
|
607
|
+
{
|
|
608
|
+
"name": "list_datasets",
|
|
609
|
+
"description": "List datasets owned by the authenticated user.",
|
|
610
|
+
"method": "GET",
|
|
611
|
+
"path": "/datasets",
|
|
612
|
+
"query_params": [
|
|
613
|
+
"unnamed",
|
|
614
|
+
"offset",
|
|
615
|
+
"limit",
|
|
616
|
+
"desc"
|
|
617
|
+
],
|
|
618
|
+
"input_schema": {
|
|
619
|
+
"type": "object",
|
|
620
|
+
"properties": {
|
|
621
|
+
"unnamed": {
|
|
622
|
+
"type": "boolean",
|
|
623
|
+
"description": "When true, include unnamed datasets."
|
|
624
|
+
},
|
|
625
|
+
"offset": {
|
|
162
626
|
"type": "integer",
|
|
163
|
-
"description": "
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
627
|
+
"description": "Number of datasets to skip."
|
|
628
|
+
},
|
|
629
|
+
"limit": {
|
|
630
|
+
"type": "integer",
|
|
631
|
+
"description": "Maximum datasets to return."
|
|
632
|
+
},
|
|
633
|
+
"desc": {
|
|
634
|
+
"type": "boolean",
|
|
635
|
+
"description": "Sort newest first when true."
|
|
636
|
+
}
|
|
637
|
+
}
|
|
638
|
+
}
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
"name": "get_dataset",
|
|
642
|
+
"description": "Get metadata for a dataset. This does not return items; use get_dataset_items for records.",
|
|
643
|
+
"method": "GET",
|
|
644
|
+
"path": "/datasets/{datasetId}",
|
|
645
|
+
"input_schema": {
|
|
646
|
+
"type": "object",
|
|
647
|
+
"properties": {
|
|
648
|
+
"datasetId": {
|
|
649
|
+
"type": "string",
|
|
650
|
+
"description": "Dataset ID or tilde-separated username/dataset name."
|
|
168
651
|
}
|
|
169
652
|
},
|
|
170
653
|
"required": [
|
|
@@ -173,31 +656,183 @@
|
|
|
173
656
|
}
|
|
174
657
|
},
|
|
175
658
|
{
|
|
176
|
-
"name": "
|
|
177
|
-
"description": "
|
|
659
|
+
"name": "list_key_value_stores",
|
|
660
|
+
"description": "List key-value stores owned by the authenticated user. Useful for finding actor OUTPUT records and files stored outside datasets.",
|
|
178
661
|
"method": "GET",
|
|
179
|
-
"path": "/
|
|
662
|
+
"path": "/key-value-stores",
|
|
663
|
+
"query_params": [
|
|
664
|
+
"offset",
|
|
665
|
+
"limit",
|
|
666
|
+
"desc",
|
|
667
|
+
"unnamed"
|
|
668
|
+
],
|
|
180
669
|
"input_schema": {
|
|
181
670
|
"type": "object",
|
|
182
671
|
"properties": {
|
|
183
|
-
"
|
|
672
|
+
"offset": {
|
|
184
673
|
"type": "integer",
|
|
185
|
-
"description": "
|
|
674
|
+
"description": "Number of stores to skip."
|
|
675
|
+
},
|
|
676
|
+
"limit": {
|
|
677
|
+
"type": "integer",
|
|
678
|
+
"description": "Maximum stores to return. Default and maximum are 1000."
|
|
679
|
+
},
|
|
680
|
+
"desc": {
|
|
681
|
+
"type": "boolean",
|
|
682
|
+
"description": "Sort newest first when true."
|
|
683
|
+
},
|
|
684
|
+
"unnamed": {
|
|
685
|
+
"type": "boolean",
|
|
686
|
+
"description": "Include unnamed stores."
|
|
687
|
+
}
|
|
688
|
+
}
|
|
689
|
+
}
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
"name": "get_key_value_store",
|
|
693
|
+
"description": "Get metadata for an Apify key-value store.",
|
|
694
|
+
"method": "GET",
|
|
695
|
+
"path": "/key-value-stores/{storeId}",
|
|
696
|
+
"input_schema": {
|
|
697
|
+
"type": "object",
|
|
698
|
+
"properties": {
|
|
699
|
+
"storeId": {
|
|
700
|
+
"type": "string",
|
|
701
|
+
"description": "Key-value store ID or name."
|
|
702
|
+
}
|
|
703
|
+
},
|
|
704
|
+
"required": [
|
|
705
|
+
"storeId"
|
|
706
|
+
]
|
|
707
|
+
}
|
|
708
|
+
},
|
|
709
|
+
{
|
|
710
|
+
"name": "get_key_value_store_record",
|
|
711
|
+
"description": "Get a record value from an Apify key-value store. Use defaultKeyValueStoreId from a run and key='OUTPUT' for actors that store final output outside datasets.",
|
|
712
|
+
"method": "GET",
|
|
713
|
+
"path": "/key-value-stores/{storeId}/records/{recordKey}",
|
|
714
|
+
"query_params": [
|
|
715
|
+
"disableRedirect"
|
|
716
|
+
],
|
|
717
|
+
"input_schema": {
|
|
718
|
+
"type": "object",
|
|
719
|
+
"properties": {
|
|
720
|
+
"storeId": {
|
|
721
|
+
"type": "string",
|
|
722
|
+
"description": "Key-value store ID or name."
|
|
723
|
+
},
|
|
724
|
+
"recordKey": {
|
|
725
|
+
"type": "string",
|
|
726
|
+
"description": "Record key, e.g. OUTPUT."
|
|
727
|
+
},
|
|
728
|
+
"disableRedirect": {
|
|
729
|
+
"type": "boolean",
|
|
730
|
+
"description": "When true, return metadata instead of redirecting to large binary values where supported."
|
|
731
|
+
}
|
|
732
|
+
},
|
|
733
|
+
"required": [
|
|
734
|
+
"storeId",
|
|
735
|
+
"recordKey"
|
|
736
|
+
]
|
|
737
|
+
}
|
|
738
|
+
},
|
|
739
|
+
{
|
|
740
|
+
"name": "get_dataset_items",
|
|
741
|
+
"description": "Retrieve items from an Apify dataset. Use defaultDatasetId from run_actor/get_run, or use run_actor_sync_get_dataset_items for one-call execution and results.",
|
|
742
|
+
"method": "GET",
|
|
743
|
+
"path": "/datasets/{datasetId}/items",
|
|
744
|
+
"query_params": [
|
|
745
|
+
"format",
|
|
746
|
+
"clean",
|
|
747
|
+
"offset",
|
|
748
|
+
"limit",
|
|
749
|
+
"fields",
|
|
750
|
+
"outputFields",
|
|
751
|
+
"omit",
|
|
752
|
+
"unwind",
|
|
753
|
+
"flatten",
|
|
754
|
+
"desc",
|
|
755
|
+
"attachment",
|
|
756
|
+
"delimiter",
|
|
757
|
+
"bom"
|
|
758
|
+
],
|
|
759
|
+
"input_schema": {
|
|
760
|
+
"type": "object",
|
|
761
|
+
"properties": {
|
|
762
|
+
"datasetId": {
|
|
763
|
+
"type": "string",
|
|
764
|
+
"description": "Dataset ID or tilde-separated username/dataset name."
|
|
765
|
+
},
|
|
766
|
+
"format": {
|
|
767
|
+
"type": "string",
|
|
768
|
+
"description": "Output format for the data.",
|
|
186
769
|
"enum": [
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
770
|
+
"json",
|
|
771
|
+
"jsonl",
|
|
772
|
+
"csv",
|
|
773
|
+
"html",
|
|
774
|
+
"xlsx",
|
|
775
|
+
"xml",
|
|
776
|
+
"rss"
|
|
777
|
+
],
|
|
778
|
+
"default": "json"
|
|
779
|
+
},
|
|
780
|
+
"clean": {
|
|
781
|
+
"type": "boolean",
|
|
782
|
+
"description": "Return only non-empty items and omit hidden fields."
|
|
190
783
|
},
|
|
191
784
|
"offset": {
|
|
192
785
|
"type": "integer",
|
|
193
|
-
"description": "Number of
|
|
786
|
+
"description": "Number of items to skip."
|
|
194
787
|
},
|
|
195
788
|
"limit": {
|
|
196
789
|
"type": "integer",
|
|
197
|
-
"description": "Maximum
|
|
790
|
+
"description": "Maximum items to return."
|
|
791
|
+
},
|
|
792
|
+
"fields": {
|
|
793
|
+
"type": "string",
|
|
794
|
+
"description": "Comma-separated fields to include."
|
|
795
|
+
},
|
|
796
|
+
"outputFields": {
|
|
797
|
+
"type": "string",
|
|
798
|
+
"description": "Comma-separated output names that rename fields positionally."
|
|
799
|
+
},
|
|
800
|
+
"omit": {
|
|
801
|
+
"type": "string",
|
|
802
|
+
"description": "Comma-separated fields to omit."
|
|
803
|
+
},
|
|
804
|
+
"unwind": {
|
|
805
|
+
"type": "string",
|
|
806
|
+
"description": "Comma-separated fields to unwind."
|
|
807
|
+
},
|
|
808
|
+
"flatten": {
|
|
809
|
+
"type": "string",
|
|
810
|
+
"description": "Comma-separated fields to flatten."
|
|
811
|
+
},
|
|
812
|
+
"desc": {
|
|
813
|
+
"type": "boolean",
|
|
814
|
+
"description": "Return items newest first."
|
|
815
|
+
},
|
|
816
|
+
"attachment": {
|
|
817
|
+
"type": "boolean",
|
|
818
|
+
"description": "Force file download style response for browser clients."
|
|
819
|
+
},
|
|
820
|
+
"delimiter": {
|
|
821
|
+
"type": "string",
|
|
822
|
+
"description": "Delimiter for CSV output."
|
|
823
|
+
},
|
|
824
|
+
"bom": {
|
|
825
|
+
"type": "boolean",
|
|
826
|
+
"description": "Include a byte-order mark for CSV output."
|
|
198
827
|
}
|
|
199
|
-
}
|
|
828
|
+
},
|
|
829
|
+
"required": [
|
|
830
|
+
"datasetId"
|
|
831
|
+
]
|
|
200
832
|
}
|
|
201
833
|
}
|
|
202
|
-
]
|
|
203
|
-
|
|
834
|
+
],
|
|
835
|
+
"health_check": {
|
|
836
|
+
"tool": "get_user"
|
|
837
|
+
}
|
|
838
|
+
}
|