apify-client 3.0.0-beta.72 → 3.0.0-beta.74
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/dist/bundle.js +3 -3
- package/dist/bundle.js.map +1 -1
- package/dist/generated/api.d.ts +280 -276
- package/dist/generated/schemas.d.ts +45 -29
- package/dist/generated/schemas.js +6 -8
- package/dist/http_clients/base.d.ts +2 -1
- package/dist/http_clients/base.js +8 -5
- package/dist/invalid_response_body_error.d.ts +3 -3
- package/dist/invalid_response_body_error.js +3 -3
- package/package.json +2 -2
package/dist/generated/api.d.ts
CHANGED
|
@@ -148,7 +148,7 @@ export interface paths {
|
|
|
148
148
|
cookie?: never;
|
|
149
149
|
};
|
|
150
150
|
/**
|
|
151
|
-
* Get list of versions
|
|
151
|
+
* Get list of Actor versions
|
|
152
152
|
* @description Gets the list of versions of a specific Actor. The response is a JSON object
|
|
153
153
|
* with the list of [Version objects](#/reference/actors/version-object), where each
|
|
154
154
|
* contains basic information about a single version.
|
|
@@ -156,7 +156,7 @@ export interface paths {
|
|
|
156
156
|
get: operations["actor_versions_get"];
|
|
157
157
|
put?: never;
|
|
158
158
|
/**
|
|
159
|
-
* Create version
|
|
159
|
+
* Create Actor version
|
|
160
160
|
* @description Creates a version of an Actor using values specified in a [Version
|
|
161
161
|
* object](#/reference/actors/version-object) passed as JSON in the POST
|
|
162
162
|
* payload.
|
|
@@ -202,12 +202,12 @@ export interface paths {
|
|
|
202
202
|
cookie?: never;
|
|
203
203
|
};
|
|
204
204
|
/**
|
|
205
|
-
* Get version
|
|
205
|
+
* Get Actor version
|
|
206
206
|
* @description Gets a [Version object](#/reference/actors/version-object) that contains all the details about a specific version of an Actor.
|
|
207
207
|
*/
|
|
208
208
|
get: operations["actor_version_get"];
|
|
209
209
|
/**
|
|
210
|
-
* Update version
|
|
210
|
+
* Update Actor version
|
|
211
211
|
* @description Updates Actor version using values specified by a [Version object](#/reference/actors/version-object) passed as JSON in the POST payload.
|
|
212
212
|
*
|
|
213
213
|
* If the object does not define a specific property, its value will not be
|
|
@@ -225,13 +225,13 @@ export interface paths {
|
|
|
225
225
|
*/
|
|
226
226
|
put: operations["actor_version_put"];
|
|
227
227
|
/**
|
|
228
|
-
* Update version (POST)
|
|
228
|
+
* Update Actor version (POST)
|
|
229
229
|
* @description Updates Actor version using values specified by a [Version object](#/reference/actors/version-object) passed as JSON in the POST payload.
|
|
230
230
|
* This endpoint is an alias for the [`PUT` update version](#tag/ActorsVersion-object/operation/act_version_put) method and behaves identically.
|
|
231
231
|
*/
|
|
232
232
|
post: operations["actor_version_post"];
|
|
233
233
|
/**
|
|
234
|
-
* Delete version
|
|
234
|
+
* Delete Actor version
|
|
235
235
|
* @description Deletes a specific version of Actor's source code.
|
|
236
236
|
*/
|
|
237
237
|
delete: operations["actor_version_delete"];
|
|
@@ -248,14 +248,14 @@ export interface paths {
|
|
|
248
248
|
cookie?: never;
|
|
249
249
|
};
|
|
250
250
|
/**
|
|
251
|
-
* Get list of environment variables
|
|
251
|
+
* Get list of environment variables of Actor version
|
|
252
252
|
* @description Gets the list of environment variables for a specific version of an Actor.
|
|
253
253
|
* The response is a JSON object with the list of [EnvVar objects](#/reference/actors/environment-variable-object), where each contains basic information about a single environment variable.
|
|
254
254
|
*/
|
|
255
255
|
get: operations["actor_version_envVars_get"];
|
|
256
256
|
put?: never;
|
|
257
257
|
/**
|
|
258
|
-
* Create environment variable
|
|
258
|
+
* Create environment variable in Actor version
|
|
259
259
|
* @description Creates an environment variable of an Actor using values specified in a
|
|
260
260
|
* [EnvVar object](#/reference/actors/environment-variable-object) passed as
|
|
261
261
|
* JSON in the POST payload.
|
|
@@ -290,7 +290,7 @@ export interface paths {
|
|
|
290
290
|
cookie?: never;
|
|
291
291
|
};
|
|
292
292
|
/**
|
|
293
|
-
* Get environment variable
|
|
293
|
+
* Get environment variable of Actor version
|
|
294
294
|
* @description Gets a [EnvVar object](#/reference/actors/environment-variable-object) that
|
|
295
295
|
* contains all the details about a specific environment variable of an Actor.
|
|
296
296
|
*
|
|
@@ -298,7 +298,7 @@ export interface paths {
|
|
|
298
298
|
*/
|
|
299
299
|
get: operations["actor_version_envVar_get"];
|
|
300
300
|
/**
|
|
301
|
-
* Update environment variable
|
|
301
|
+
* Update environment variable in Actor version
|
|
302
302
|
* @description Updates Actor environment variable using values specified by a [EnvVar
|
|
303
303
|
* object](#/reference/actors/environment-variable-object)
|
|
304
304
|
* passed as JSON in the POST payload.
|
|
@@ -318,7 +318,7 @@ export interface paths {
|
|
|
318
318
|
*/
|
|
319
319
|
put: operations["actor_version_envVar_put"];
|
|
320
320
|
/**
|
|
321
|
-
* Update environment variable (POST)
|
|
321
|
+
* Update environment variable in Actor version (POST)
|
|
322
322
|
* @description Updates Actor environment variable using values specified by a [EnvVar
|
|
323
323
|
* object](#/reference/actors/environment-variable-object)
|
|
324
324
|
* passed as JSON in the POST payload.
|
|
@@ -326,7 +326,7 @@ export interface paths {
|
|
|
326
326
|
*/
|
|
327
327
|
post: operations["actor_version_envVar_post"];
|
|
328
328
|
/**
|
|
329
|
-
* Delete environment variable
|
|
329
|
+
* Delete environment variable from Actor version
|
|
330
330
|
* @description Deletes a specific environment variable.
|
|
331
331
|
*/
|
|
332
332
|
delete: operations["actor_version_envVar_delete"];
|
|
@@ -343,7 +343,7 @@ export interface paths {
|
|
|
343
343
|
cookie?: never;
|
|
344
344
|
};
|
|
345
345
|
/**
|
|
346
|
-
* Get list of webhooks
|
|
346
|
+
* Get list of Actor's webhooks
|
|
347
347
|
* @description Gets the list of webhooks of a specific Actor. The response is a JSON with
|
|
348
348
|
* the list of objects, where each object contains basic information about a single webhook.
|
|
349
349
|
*
|
|
@@ -370,7 +370,7 @@ export interface paths {
|
|
|
370
370
|
cookie?: never;
|
|
371
371
|
};
|
|
372
372
|
/**
|
|
373
|
-
* Get list of builds
|
|
373
|
+
* Get list of Actor's builds
|
|
374
374
|
* @description Gets the list of builds of a specific Actor. The response is a JSON with the
|
|
375
375
|
* list of objects, where each object contains basic information about a single build.
|
|
376
376
|
*
|
|
@@ -405,7 +405,7 @@ export interface paths {
|
|
|
405
405
|
cookie?: never;
|
|
406
406
|
};
|
|
407
407
|
/**
|
|
408
|
-
* Get default build
|
|
408
|
+
* Get default Actor build
|
|
409
409
|
* @description Get the default build for an Actor.
|
|
410
410
|
*
|
|
411
411
|
* Use the optional `waitForFinish` parameter to synchronously wait for the build to finish.
|
|
@@ -431,7 +431,7 @@ export interface paths {
|
|
|
431
431
|
cookie?: never;
|
|
432
432
|
};
|
|
433
433
|
/**
|
|
434
|
-
* Get OpenAPI definition
|
|
434
|
+
* Get OpenAPI definition of Actor build
|
|
435
435
|
* @description Get the OpenAPI definition for Actor builds. Two similar endpoints are available:
|
|
436
436
|
*
|
|
437
437
|
* - [First endpoint](https://docs.apify.com/api/v2/actor-openapi-json-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.
|
|
@@ -466,7 +466,7 @@ export interface paths {
|
|
|
466
466
|
cookie?: never;
|
|
467
467
|
};
|
|
468
468
|
/**
|
|
469
|
-
* Get build
|
|
469
|
+
* Get Actor build
|
|
470
470
|
* @deprecated
|
|
471
471
|
* @description By passing the optional `waitForFinish` parameter the API endpoint will
|
|
472
472
|
* synchronously wait for the build to finish.
|
|
@@ -495,7 +495,7 @@ export interface paths {
|
|
|
495
495
|
get?: never;
|
|
496
496
|
put?: never;
|
|
497
497
|
/**
|
|
498
|
-
* Abort build
|
|
498
|
+
* Abort Actor build
|
|
499
499
|
* @deprecated
|
|
500
500
|
* @description **[DEPRECATED]** API endpoints related to build of the Actor were moved
|
|
501
501
|
* under new namespace [`actor-builds`](#/reference/actor-builds). Aborts an
|
|
@@ -520,7 +520,7 @@ export interface paths {
|
|
|
520
520
|
cookie?: never;
|
|
521
521
|
};
|
|
522
522
|
/**
|
|
523
|
-
* Get list of runs
|
|
523
|
+
* Get list of Actor's runs
|
|
524
524
|
* @description Gets the list of runs of a specific Actor. The response is a list of
|
|
525
525
|
* objects, where each object contains basic information about a single Actor run.
|
|
526
526
|
*
|
|
@@ -574,7 +574,7 @@ export interface paths {
|
|
|
574
574
|
cookie?: never;
|
|
575
575
|
};
|
|
576
576
|
/**
|
|
577
|
-
* Run Actor synchronously
|
|
577
|
+
* Run Actor synchronously and get key-value store record (GET)
|
|
578
578
|
* @description Runs a specific Actor and returns a key-value store record. The response contains the
|
|
579
579
|
* record stored under the `OUTPUT` key in the run's default key-value store.
|
|
580
580
|
* This is a legacy approach that has been replaced by the Actor
|
|
@@ -598,7 +598,7 @@ export interface paths {
|
|
|
598
598
|
get: operations["actor_runSync_get"];
|
|
599
599
|
put?: never;
|
|
600
600
|
/**
|
|
601
|
-
* Run Actor synchronously and
|
|
601
|
+
* Run Actor synchronously and get key-value store record
|
|
602
602
|
* @description Runs a specific Actor and returns a key-value store record.
|
|
603
603
|
*
|
|
604
604
|
* The POST payload including its `Content-Type` header is passed as `INPUT` to
|
|
@@ -640,7 +640,7 @@ export interface paths {
|
|
|
640
640
|
cookie?: never;
|
|
641
641
|
};
|
|
642
642
|
/**
|
|
643
|
-
* Run Actor synchronously
|
|
643
|
+
* Run Actor synchronously and get dataset items (GET)
|
|
644
644
|
* @description Runs a specific Actor and returns its dataset items.
|
|
645
645
|
* The run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> seconds
|
|
646
646
|
* otherwise the API endpoint returns a timeout error.
|
|
@@ -729,7 +729,7 @@ export interface paths {
|
|
|
729
729
|
get?: never;
|
|
730
730
|
put?: never;
|
|
731
731
|
/**
|
|
732
|
-
* Resurrect run
|
|
732
|
+
* Resurrect Actor run
|
|
733
733
|
* @description **[DEPRECATED]** API endpoints related to run of the Actor were moved under
|
|
734
734
|
* new namespace [`actor-runs`](#/reference/actor-runs).Resurrects a finished
|
|
735
735
|
* Actor run and returns an object that contains all the details about the
|
|
@@ -759,7 +759,7 @@ export interface paths {
|
|
|
759
759
|
cookie?: never;
|
|
760
760
|
};
|
|
761
761
|
/**
|
|
762
|
-
* Get last run
|
|
762
|
+
* Get Actor's last run
|
|
763
763
|
* @description This is not a single endpoint, but an entire group of endpoints that lets you to
|
|
764
764
|
* retrieve and manage the last run of given Actor or any of its default storages.
|
|
765
765
|
* All the endpoints require an authentication token.
|
|
@@ -800,7 +800,7 @@ export interface paths {
|
|
|
800
800
|
cookie?: never;
|
|
801
801
|
};
|
|
802
802
|
/**
|
|
803
|
-
* Get
|
|
803
|
+
* Get the default dataset of an Actor's last run
|
|
804
804
|
* @description Returns the default dataset associated with the last Actor run.
|
|
805
805
|
*
|
|
806
806
|
* This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
|
|
@@ -808,7 +808,7 @@ export interface paths {
|
|
|
808
808
|
*/
|
|
809
809
|
get: operations["actor_runs_last_dataset_get"];
|
|
810
810
|
/**
|
|
811
|
-
* Update
|
|
811
|
+
* Update the default dataset of an Actor's last run
|
|
812
812
|
* @description Updates the default dataset associated with the last Actor run.
|
|
813
813
|
*
|
|
814
814
|
* This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
|
|
@@ -817,7 +817,7 @@ export interface paths {
|
|
|
817
817
|
put: operations["actor_runs_last_dataset_put"];
|
|
818
818
|
post?: never;
|
|
819
819
|
/**
|
|
820
|
-
* Delete
|
|
820
|
+
* Delete the default dataset of an Actor's last run
|
|
821
821
|
* @description Deletes the default dataset associated with the last Actor run.
|
|
822
822
|
*
|
|
823
823
|
* This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
|
|
@@ -837,7 +837,7 @@ export interface paths {
|
|
|
837
837
|
cookie?: never;
|
|
838
838
|
};
|
|
839
839
|
/**
|
|
840
|
-
* Get
|
|
840
|
+
* Get the default dataset items from an Actor's last run
|
|
841
841
|
* @description Returns data stored in the default dataset of the last Actor run in the desired format.
|
|
842
842
|
*
|
|
843
843
|
* This endpoint is a shortcut that resolves the last run's `defaultDatasetId` and proxies to the
|
|
@@ -846,11 +846,11 @@ export interface paths {
|
|
|
846
846
|
get: operations["actor_runs_last_dataset_items_get"];
|
|
847
847
|
put?: never;
|
|
848
848
|
/**
|
|
849
|
-
* Store items in
|
|
849
|
+
* Store items in the default dataset of an Actor's last run
|
|
850
850
|
* @description Appends an item or an array of items to the end of the last Actor run's default dataset.
|
|
851
851
|
*
|
|
852
852
|
* This endpoint is a shortcut that resolves the last run's `defaultDatasetId` and proxies to the
|
|
853
|
-
* [Store items](https://docs.apify.com/api/v2/dataset-items-post) endpoint.
|
|
853
|
+
* [Store items in dataset](https://docs.apify.com/api/v2/dataset-items-post) endpoint.
|
|
854
854
|
*
|
|
855
855
|
* To save bandwidth and speed up your upload, you can send the request payload compressed and set the `Content-Encoding` header accordingly.
|
|
856
856
|
*
|
|
@@ -875,7 +875,7 @@ export interface paths {
|
|
|
875
875
|
cookie?: never;
|
|
876
876
|
};
|
|
877
877
|
/**
|
|
878
|
-
* Get
|
|
878
|
+
* Get the default dataset statistics for an Actor's last run
|
|
879
879
|
* @description Returns statistics for the last Actor run's default dataset.
|
|
880
880
|
*
|
|
881
881
|
* This endpoint is a shortcut that resolves the last run's `defaultDatasetId` and proxies to the
|
|
@@ -898,29 +898,29 @@ export interface paths {
|
|
|
898
898
|
cookie?: never;
|
|
899
899
|
};
|
|
900
900
|
/**
|
|
901
|
-
* Get
|
|
901
|
+
* Get the default key-value store of an Actor's last run
|
|
902
902
|
* @description Gets an object that contains all the details about the default key-value store associated with the last Actor run.
|
|
903
903
|
*
|
|
904
904
|
* This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
|
|
905
|
-
* [Get store](https://docs.apify.com/api/v2/key-value-store-get) endpoint.
|
|
905
|
+
* [Get key-value store](https://docs.apify.com/api/v2/key-value-store-get) endpoint.
|
|
906
906
|
*/
|
|
907
907
|
get: operations["actor_runs_last_keyValueStore_get"];
|
|
908
908
|
/**
|
|
909
|
-
* Update
|
|
909
|
+
* Update the default key-value store of an Actor's last run
|
|
910
910
|
* @description Updates the last Actor run key-value store's name and general resource access level using a value specified by a JSON object
|
|
911
911
|
* passed in the PUT payload.
|
|
912
912
|
*
|
|
913
913
|
* This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
|
|
914
|
-
* [Update store](https://docs.apify.com/api/v2/key-value-store-put) endpoint.
|
|
914
|
+
* [Update key-value store](https://docs.apify.com/api/v2/key-value-store-put) endpoint.
|
|
915
915
|
*/
|
|
916
916
|
put: operations["actor_runs_last_keyValueStore_put"];
|
|
917
917
|
post?: never;
|
|
918
918
|
/**
|
|
919
|
-
* Delete
|
|
919
|
+
* Delete the default key-value store of an Actor's last run
|
|
920
920
|
* @description Deletes the last Actor run key-value store.
|
|
921
921
|
*
|
|
922
922
|
* This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
|
|
923
|
-
* [Delete store](https://docs.apify.com/api/v2/key-value-store-delete) endpoint.
|
|
923
|
+
* [Delete key-value store](https://docs.apify.com/api/v2/key-value-store-delete) endpoint.
|
|
924
924
|
*/
|
|
925
925
|
delete: operations["actor_runs_last_keyValueStore_delete"];
|
|
926
926
|
options?: never;
|
|
@@ -936,11 +936,11 @@ export interface paths {
|
|
|
936
936
|
cookie?: never;
|
|
937
937
|
};
|
|
938
938
|
/**
|
|
939
|
-
* Get
|
|
939
|
+
* Get list of keys in the default key-value store of an Actor's last run
|
|
940
940
|
* @description Returns a list of keys for the default key-value store of the last Actor run.
|
|
941
941
|
*
|
|
942
942
|
* This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the
|
|
943
|
-
* [Get list of keys](https://docs.apify.com/api/v2/key-value-store-keys-get) endpoint.
|
|
943
|
+
* [Get list of key-value store keys](https://docs.apify.com/api/v2/key-value-store-keys-get) endpoint.
|
|
944
944
|
*/
|
|
945
945
|
get: operations["actor_runs_last_keyValueStore_keys_get"];
|
|
946
946
|
put?: never;
|
|
@@ -959,11 +959,11 @@ export interface paths {
|
|
|
959
959
|
cookie?: never;
|
|
960
960
|
};
|
|
961
961
|
/**
|
|
962
|
-
* Download
|
|
962
|
+
* Download records from the default key-value store of an Actor's last run
|
|
963
963
|
* @description Downloads all records from the default key-value store of the last Actor run as a ZIP archive.
|
|
964
964
|
*
|
|
965
965
|
* This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the
|
|
966
|
-
* [Download records](https://docs.apify.com/api/v2/key-value-store-records-get) endpoint.
|
|
966
|
+
* [Download key-value store records](https://docs.apify.com/api/v2/key-value-store-records-get) endpoint.
|
|
967
967
|
*/
|
|
968
968
|
get: operations["actor_runs_last_keyValueStore_records_get"];
|
|
969
969
|
put?: never;
|
|
@@ -982,35 +982,35 @@ export interface paths {
|
|
|
982
982
|
cookie?: never;
|
|
983
983
|
};
|
|
984
984
|
/**
|
|
985
|
-
* Get
|
|
985
|
+
* Get record from the default key-value store of an Actor's last run
|
|
986
986
|
* @description Gets a value stored under a specific key in the default key-value store of the last Actor run.
|
|
987
987
|
*
|
|
988
988
|
* This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the
|
|
989
|
-
* [Get record](https://docs.apify.com/api/v2/key-value-store-record-get) endpoint.
|
|
989
|
+
* [Get key-value store record](https://docs.apify.com/api/v2/key-value-store-record-get) endpoint.
|
|
990
990
|
*/
|
|
991
991
|
get: operations["actor_runs_last_keyValueStore_record_get"];
|
|
992
992
|
/**
|
|
993
|
-
*
|
|
993
|
+
* Set record in the default key-value store of an Actor's last run
|
|
994
994
|
* @description Stores a value under a specific key in the default key-value store of the last Actor run.
|
|
995
995
|
*
|
|
996
996
|
* This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the
|
|
997
|
-
* [
|
|
997
|
+
* [Set key-value store record](https://docs.apify.com/api/v2/key-value-store-record-put) endpoint.
|
|
998
998
|
*/
|
|
999
999
|
put: operations["actor_runs_last_keyValueStore_record_put"];
|
|
1000
1000
|
/**
|
|
1001
|
-
*
|
|
1001
|
+
* Set record in the default key-value store of an Actor's last run (POST)
|
|
1002
1002
|
* @description Stores a value under a specific key in the default key-value store of the last Actor run.
|
|
1003
1003
|
*
|
|
1004
1004
|
* This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the
|
|
1005
|
-
* [
|
|
1005
|
+
* [Set key-value store record (POST)](https://docs.apify.com/api/v2/key-value-store-record-post) endpoint.
|
|
1006
1006
|
*/
|
|
1007
1007
|
post: operations["actor_runs_last_keyValueStore_record_post"];
|
|
1008
1008
|
/**
|
|
1009
|
-
* Delete
|
|
1009
|
+
* Delete record from the default key-value store of an Actor's last run
|
|
1010
1010
|
* @description Removes a record specified by a key from the default key-value store of the last Actor run.
|
|
1011
1011
|
*
|
|
1012
1012
|
* This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the
|
|
1013
|
-
* [Delete record](https://docs.apify.com/api/v2/key-value-store-record-delete) endpoint.
|
|
1013
|
+
* [Delete key-value store record](https://docs.apify.com/api/v2/key-value-store-record-delete) endpoint.
|
|
1014
1014
|
*/
|
|
1015
1015
|
delete: operations["actor_runs_last_keyValueStore_record_delete"];
|
|
1016
1016
|
options?: never;
|
|
@@ -1026,7 +1026,7 @@ export interface paths {
|
|
|
1026
1026
|
cookie?: never;
|
|
1027
1027
|
};
|
|
1028
1028
|
/**
|
|
1029
|
-
* Get
|
|
1029
|
+
* Get the default request queue of an Actor's last run
|
|
1030
1030
|
* @description Returns the default request queue associated with the last Actor run.
|
|
1031
1031
|
*
|
|
1032
1032
|
* This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
|
|
@@ -1034,7 +1034,7 @@ export interface paths {
|
|
|
1034
1034
|
*/
|
|
1035
1035
|
get: operations["actor_runs_last_requestQueue_get"];
|
|
1036
1036
|
/**
|
|
1037
|
-
* Update
|
|
1037
|
+
* Update the default request queue of an Actor's last run
|
|
1038
1038
|
* @description Updates the default request queue associated with the last Actor run.
|
|
1039
1039
|
*
|
|
1040
1040
|
* This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
|
|
@@ -1043,7 +1043,7 @@ export interface paths {
|
|
|
1043
1043
|
put: operations["actor_runs_last_requestQueue_put"];
|
|
1044
1044
|
post?: never;
|
|
1045
1045
|
/**
|
|
1046
|
-
* Delete
|
|
1046
|
+
* Delete the default request queue of an Actor's last run
|
|
1047
1047
|
* @description Deletes the default request queue associated with the last Actor run.
|
|
1048
1048
|
*
|
|
1049
1049
|
* This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
|
|
@@ -1063,20 +1063,20 @@ export interface paths {
|
|
|
1063
1063
|
cookie?: never;
|
|
1064
1064
|
};
|
|
1065
1065
|
/**
|
|
1066
|
-
* List
|
|
1066
|
+
* List requests in the default request queue of an Actor's last run
|
|
1067
1067
|
* @description Returns a list of requests from the default request queue of the last Actor run.
|
|
1068
1068
|
*
|
|
1069
1069
|
* This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
|
|
1070
|
-
* [List requests](https://docs.apify.com/api/v2/request-queue-requests-get) endpoint.
|
|
1070
|
+
* [List requests in request queue](https://docs.apify.com/api/v2/request-queue-requests-get) endpoint.
|
|
1071
1071
|
*/
|
|
1072
1072
|
get: operations["actor_runs_last_requestQueue_requests_get"];
|
|
1073
1073
|
put?: never;
|
|
1074
1074
|
/**
|
|
1075
|
-
* Add request to
|
|
1075
|
+
* Add request to the default request queue of an Actor's last run
|
|
1076
1076
|
* @description Adds a request to the default request queue of the last Actor run.
|
|
1077
1077
|
*
|
|
1078
1078
|
* This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
|
|
1079
|
-
* [Add request](https://docs.apify.com/api/v2/request-queue-requests-post) endpoint.
|
|
1079
|
+
* [Add request to request queue](https://docs.apify.com/api/v2/request-queue-requests-post) endpoint.
|
|
1080
1080
|
*/
|
|
1081
1081
|
post: operations["actor_runs_last_requestQueue_requests_post"];
|
|
1082
1082
|
delete?: never;
|
|
@@ -1095,19 +1095,19 @@ export interface paths {
|
|
|
1095
1095
|
get?: never;
|
|
1096
1096
|
put?: never;
|
|
1097
1097
|
/**
|
|
1098
|
-
* Batch add requests to
|
|
1098
|
+
* Batch add requests to the default request queue of an Actor's last run
|
|
1099
1099
|
* @description Adds requests to the default request queue of the last Actor run in batch.
|
|
1100
1100
|
*
|
|
1101
1101
|
* This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
|
|
1102
|
-
* [
|
|
1102
|
+
* [Batch add requests to request queue](https://docs.apify.com/api/v2/request-queue-requests-batch-post) endpoint.
|
|
1103
1103
|
*/
|
|
1104
1104
|
post: operations["actor_runs_last_requestQueue_requests_batch_post"];
|
|
1105
1105
|
/**
|
|
1106
|
-
* Batch delete requests from
|
|
1106
|
+
* Batch delete requests from the default request queue of an Actor's last run
|
|
1107
1107
|
* @description Batch-deletes requests from the default request queue of the last Actor run.
|
|
1108
1108
|
*
|
|
1109
1109
|
* This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
|
|
1110
|
-
* [
|
|
1110
|
+
* [Batch delete requests from request queue](https://docs.apify.com/api/v2/request-queue-requests-batch-delete) endpoint.
|
|
1111
1111
|
*/
|
|
1112
1112
|
delete: operations["actor_runs_last_requestQueue_requests_batch_delete"];
|
|
1113
1113
|
options?: never;
|
|
@@ -1125,11 +1125,11 @@ export interface paths {
|
|
|
1125
1125
|
get?: never;
|
|
1126
1126
|
put?: never;
|
|
1127
1127
|
/**
|
|
1128
|
-
* Unlock requests in
|
|
1128
|
+
* Unlock requests in the default request queue of an Actor's last run
|
|
1129
1129
|
* @description Unlocks requests in the default request queue of the last Actor run that are currently locked by the client.
|
|
1130
1130
|
*
|
|
1131
1131
|
* This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
|
|
1132
|
-
* [Unlock requests](https://docs.apify.com/api/v2/request-queue-requests-unlock-post) endpoint.
|
|
1132
|
+
* [Unlock requests in request queue](https://docs.apify.com/api/v2/request-queue-requests-unlock-post) endpoint.
|
|
1133
1133
|
*/
|
|
1134
1134
|
post: operations["actor_runs_last_requestQueue_requests_unlock_post"];
|
|
1135
1135
|
delete?: never;
|
|
@@ -1146,28 +1146,28 @@ export interface paths {
|
|
|
1146
1146
|
cookie?: never;
|
|
1147
1147
|
};
|
|
1148
1148
|
/**
|
|
1149
|
-
* Get request from
|
|
1149
|
+
* Get request from the default request queue of an Actor's last run
|
|
1150
1150
|
* @description Returns a request from the default request queue of the last Actor run.
|
|
1151
1151
|
*
|
|
1152
1152
|
* This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
|
|
1153
|
-
* [Get request](https://docs.apify.com/api/v2/request-queue-request-get) endpoint.
|
|
1153
|
+
* [Get request from request queue](https://docs.apify.com/api/v2/request-queue-request-get) endpoint.
|
|
1154
1154
|
*/
|
|
1155
1155
|
get: operations["actor_runs_last_requestQueue_request_get"];
|
|
1156
1156
|
/**
|
|
1157
|
-
* Update request in
|
|
1157
|
+
* Update request in the default request queue of an Actor's last run
|
|
1158
1158
|
* @description Updates a request in the default request queue of the last Actor run.
|
|
1159
1159
|
*
|
|
1160
1160
|
* This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
|
|
1161
|
-
* [Update request](https://docs.apify.com/api/v2/request-queue-request-put) endpoint.
|
|
1161
|
+
* [Update request in request queue](https://docs.apify.com/api/v2/request-queue-request-put) endpoint.
|
|
1162
1162
|
*/
|
|
1163
1163
|
put: operations["actor_runs_last_requestQueue_request_put"];
|
|
1164
1164
|
post?: never;
|
|
1165
1165
|
/**
|
|
1166
|
-
* Delete request from
|
|
1166
|
+
* Delete request from the default request queue of an Actor's last run
|
|
1167
1167
|
* @description Deletes a request from the default request queue of the last Actor run.
|
|
1168
1168
|
*
|
|
1169
1169
|
* This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
|
|
1170
|
-
* [Delete request](https://docs.apify.com/api/v2/request-queue-request-delete) endpoint.
|
|
1170
|
+
* [Delete request from request queue](https://docs.apify.com/api/v2/request-queue-request-delete) endpoint.
|
|
1171
1171
|
*/
|
|
1172
1172
|
delete: operations["actor_runs_last_requestQueue_request_delete"];
|
|
1173
1173
|
options?: never;
|
|
@@ -1184,20 +1184,20 @@ export interface paths {
|
|
|
1184
1184
|
};
|
|
1185
1185
|
get?: never;
|
|
1186
1186
|
/**
|
|
1187
|
-
* Prolong lock on request in
|
|
1187
|
+
* Prolong lock on request in the default request queue of an Actor's last run
|
|
1188
1188
|
* @description Prolongs a request lock in the default request queue of the last Actor run.
|
|
1189
1189
|
*
|
|
1190
1190
|
* This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
|
|
1191
|
-
* [Prolong request
|
|
1191
|
+
* [Prolong lock on request in request queue](https://docs.apify.com/api/v2/request-queue-request-lock-put) endpoint.
|
|
1192
1192
|
*/
|
|
1193
1193
|
put: operations["actor_runs_last_requestQueue_request_lock_put"];
|
|
1194
1194
|
post?: never;
|
|
1195
1195
|
/**
|
|
1196
|
-
* Delete lock on request in
|
|
1196
|
+
* Delete lock on request in the default request queue of an Actor's last run
|
|
1197
1197
|
* @description Deletes a request lock in the default request queue of the last Actor run.
|
|
1198
1198
|
*
|
|
1199
1199
|
* This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
|
|
1200
|
-
* [Delete request
|
|
1200
|
+
* [Delete lock on request in request queue](https://docs.apify.com/api/v2/request-queue-request-lock-delete) endpoint.
|
|
1201
1201
|
*/
|
|
1202
1202
|
delete: operations["actor_runs_last_requestQueue_request_lock_delete"];
|
|
1203
1203
|
options?: never;
|
|
@@ -1213,11 +1213,11 @@ export interface paths {
|
|
|
1213
1213
|
cookie?: never;
|
|
1214
1214
|
};
|
|
1215
1215
|
/**
|
|
1216
|
-
* Get
|
|
1216
|
+
* Get the default request queue head for an Actor's last run
|
|
1217
1217
|
* @description Returns the given number of first requests from the default request queue of the last Actor run.
|
|
1218
1218
|
*
|
|
1219
1219
|
* This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
|
|
1220
|
-
* [Get head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
1220
|
+
* [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
1221
1221
|
*/
|
|
1222
1222
|
get: operations["actor_runs_last_requestQueue_head_get"];
|
|
1223
1223
|
put?: never;
|
|
@@ -1238,12 +1238,12 @@ export interface paths {
|
|
|
1238
1238
|
get?: never;
|
|
1239
1239
|
put?: never;
|
|
1240
1240
|
/**
|
|
1241
|
-
* Get and lock
|
|
1241
|
+
* Get and lock the default request queue head for an Actor's last run
|
|
1242
1242
|
* @description Returns the given number of first requests from the default request queue of the last Actor run
|
|
1243
1243
|
* and locks them for the given time.
|
|
1244
1244
|
*
|
|
1245
1245
|
* This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
|
|
1246
|
-
* [Get
|
|
1246
|
+
* [Get and lock request queue head](https://docs.apify.com/api/v2/request-queue-head-lock-post) endpoint.
|
|
1247
1247
|
*/
|
|
1248
1248
|
post: operations["actor_runs_last_requestQueue_head_lock_post"];
|
|
1249
1249
|
delete?: never;
|
|
@@ -1260,10 +1260,10 @@ export interface paths {
|
|
|
1260
1260
|
cookie?: never;
|
|
1261
1261
|
};
|
|
1262
1262
|
/**
|
|
1263
|
-
* Get
|
|
1263
|
+
* Get log of an Actor's last run
|
|
1264
1264
|
* @description Retrieves last Actor run's logs.
|
|
1265
1265
|
*
|
|
1266
|
-
* This endpoint is a shortcut for getting last Actor run's log. Same as [Get log](https://docs.apify.com/api/v2/log-get) endpoint.
|
|
1266
|
+
* This endpoint is a shortcut for getting last Actor run's log. Same as [Get Actor build or run log](https://docs.apify.com/api/v2/log-get) endpoint.
|
|
1267
1267
|
*/
|
|
1268
1268
|
get: operations["actor_runs_last_log_get"];
|
|
1269
1269
|
put?: never;
|
|
@@ -1358,7 +1358,7 @@ export interface paths {
|
|
|
1358
1358
|
cookie?: never;
|
|
1359
1359
|
};
|
|
1360
1360
|
/**
|
|
1361
|
-
* Get run
|
|
1361
|
+
* Get Actor run
|
|
1362
1362
|
* @deprecated
|
|
1363
1363
|
* @description **[DEPRECATED]** API endpoints related to run of the Actor were moved under
|
|
1364
1364
|
* new namespace [`actor-runs`](#/reference/actor-runs).
|
|
@@ -1392,7 +1392,7 @@ export interface paths {
|
|
|
1392
1392
|
get?: never;
|
|
1393
1393
|
put?: never;
|
|
1394
1394
|
/**
|
|
1395
|
-
* Abort run
|
|
1395
|
+
* Abort Actor run
|
|
1396
1396
|
* @deprecated
|
|
1397
1397
|
* @description **[DEPRECATED]** API endpoints related to run of the Actor were moved under
|
|
1398
1398
|
* new namespace [`actor-runs`](#/reference/actor-runs). Aborts an Actor run and
|
|
@@ -1418,7 +1418,7 @@ export interface paths {
|
|
|
1418
1418
|
get?: never;
|
|
1419
1419
|
put?: never;
|
|
1420
1420
|
/**
|
|
1421
|
-
* Metamorph run
|
|
1421
|
+
* Metamorph Actor run
|
|
1422
1422
|
* @deprecated
|
|
1423
1423
|
* @description **[DEPRECATED]** API endpoints related to run of the Actor were moved under
|
|
1424
1424
|
* new namespace [`actor-runs`](#/reference/actor-runs). Transforms an Actor run
|
|
@@ -1455,7 +1455,7 @@ export interface paths {
|
|
|
1455
1455
|
cookie?: never;
|
|
1456
1456
|
};
|
|
1457
1457
|
/**
|
|
1458
|
-
* Get list of tasks
|
|
1458
|
+
* Get list of Actor tasks
|
|
1459
1459
|
* @description Gets the complete list of tasks that a user has created or used.
|
|
1460
1460
|
*
|
|
1461
1461
|
* The response is a list of objects in which each object contains essential
|
|
@@ -1472,12 +1472,12 @@ export interface paths {
|
|
|
1472
1472
|
get: operations["actorTasks_get"];
|
|
1473
1473
|
put?: never;
|
|
1474
1474
|
/**
|
|
1475
|
-
* Create task
|
|
1475
|
+
* Create Actor task
|
|
1476
1476
|
* @description Create a new task with settings specified by the object passed as JSON in
|
|
1477
1477
|
* the POST payload.
|
|
1478
1478
|
*
|
|
1479
1479
|
* The response is the full task object as returned by the
|
|
1480
|
-
* [Get task](https://docs.apify.com/api/v2/actor-task-get) endpoint.
|
|
1480
|
+
* [Get Actor task](https://docs.apify.com/api/v2/actor-task-get) endpoint.
|
|
1481
1481
|
*
|
|
1482
1482
|
* The request needs to specify the `Content-Type: application/json` HTTP header!
|
|
1483
1483
|
*
|
|
@@ -1499,12 +1499,12 @@ export interface paths {
|
|
|
1499
1499
|
cookie?: never;
|
|
1500
1500
|
};
|
|
1501
1501
|
/**
|
|
1502
|
-
* Get task
|
|
1502
|
+
* Get Actor task
|
|
1503
1503
|
* @description Get an object that contains all the details about a task.
|
|
1504
1504
|
*/
|
|
1505
1505
|
get: operations["actorTask_get"];
|
|
1506
1506
|
/**
|
|
1507
|
-
* Update task
|
|
1507
|
+
* Update Actor task
|
|
1508
1508
|
* @description Update settings of a task using values specified by an object passed as JSON
|
|
1509
1509
|
* in the POST payload.
|
|
1510
1510
|
*
|
|
@@ -1526,7 +1526,7 @@ export interface paths {
|
|
|
1526
1526
|
* offered while the task stays published and copyable.
|
|
1527
1527
|
*
|
|
1528
1528
|
* The response is the full task object as returned by the
|
|
1529
|
-
* [Get task](https://docs.apify.com/api/v2/actor-task-get) endpoint.
|
|
1529
|
+
* [Get Actor task](https://docs.apify.com/api/v2/actor-task-get) endpoint.
|
|
1530
1530
|
*
|
|
1531
1531
|
* The request needs to specify the `Content-Type: application/json` HTTP
|
|
1532
1532
|
* header!
|
|
@@ -1537,7 +1537,7 @@ export interface paths {
|
|
|
1537
1537
|
put: operations["actorTask_put"];
|
|
1538
1538
|
post?: never;
|
|
1539
1539
|
/**
|
|
1540
|
-
* Delete task
|
|
1540
|
+
* Delete Actor task
|
|
1541
1541
|
* @description Delete the task specified through the `actorTaskId` parameter.
|
|
1542
1542
|
*/
|
|
1543
1543
|
delete: operations["actorTask_delete"];
|
|
@@ -1554,12 +1554,12 @@ export interface paths {
|
|
|
1554
1554
|
cookie?: never;
|
|
1555
1555
|
};
|
|
1556
1556
|
/**
|
|
1557
|
-
* Get task input
|
|
1557
|
+
* Get Actor task input
|
|
1558
1558
|
* @description Returns the input of a given task.
|
|
1559
1559
|
*/
|
|
1560
1560
|
get: operations["actorTask_input_get"];
|
|
1561
1561
|
/**
|
|
1562
|
-
* Update task input
|
|
1562
|
+
* Update Actor task input
|
|
1563
1563
|
* @description Updates the input of a task using values specified by an object passed as
|
|
1564
1564
|
* JSON in the PUT payload.
|
|
1565
1565
|
*
|
|
@@ -1591,7 +1591,7 @@ export interface paths {
|
|
|
1591
1591
|
cookie?: never;
|
|
1592
1592
|
};
|
|
1593
1593
|
/**
|
|
1594
|
-
* Get list of webhooks
|
|
1594
|
+
* Get list of Actor task's webhooks
|
|
1595
1595
|
* @description Gets the list of webhooks of a specific Actor task. The response is a JSON
|
|
1596
1596
|
* with the list of objects, where each object contains basic information about a single webhook.
|
|
1597
1597
|
*
|
|
@@ -1618,7 +1618,7 @@ export interface paths {
|
|
|
1618
1618
|
cookie?: never;
|
|
1619
1619
|
};
|
|
1620
1620
|
/**
|
|
1621
|
-
* Get list of task runs
|
|
1621
|
+
* Get list of Actor task's runs
|
|
1622
1622
|
* @description Get a list of runs of a specific task. The response is a list of objects,
|
|
1623
1623
|
* where each object contains essential information about a single task run.
|
|
1624
1624
|
*
|
|
@@ -1634,7 +1634,7 @@ export interface paths {
|
|
|
1634
1634
|
get: operations["actorTask_runs_get"];
|
|
1635
1635
|
put?: never;
|
|
1636
1636
|
/**
|
|
1637
|
-
* Run task
|
|
1637
|
+
* Run Actor task
|
|
1638
1638
|
* @description Runs an Actor task and immediately returns without waiting for the run to
|
|
1639
1639
|
* finish.
|
|
1640
1640
|
*
|
|
@@ -1673,7 +1673,7 @@ export interface paths {
|
|
|
1673
1673
|
cookie?: never;
|
|
1674
1674
|
};
|
|
1675
1675
|
/**
|
|
1676
|
-
* Run task synchronously
|
|
1676
|
+
* Run Actor task synchronously and get key-value store record (GET)
|
|
1677
1677
|
* @description Runs an Actor task and synchronously returns a key-value store record.
|
|
1678
1678
|
*
|
|
1679
1679
|
* The response contains the record stored under the `OUTPUT` key in the run's
|
|
@@ -1701,7 +1701,7 @@ export interface paths {
|
|
|
1701
1701
|
get: operations["actorTask_runSync_get"];
|
|
1702
1702
|
put?: never;
|
|
1703
1703
|
/**
|
|
1704
|
-
* Run task synchronously
|
|
1704
|
+
* Run Actor task synchronously and get key-value store record
|
|
1705
1705
|
* @description Runs an Actor task and synchronously returns a key-value store record.
|
|
1706
1706
|
*
|
|
1707
1707
|
* The response contains the record stored under the `OUTPUT` key in the run's
|
|
@@ -1753,7 +1753,7 @@ export interface paths {
|
|
|
1753
1753
|
cookie?: never;
|
|
1754
1754
|
};
|
|
1755
1755
|
/**
|
|
1756
|
-
* Run task synchronously and get dataset items
|
|
1756
|
+
* Run Actor task synchronously and get dataset items (GET)
|
|
1757
1757
|
* @description Run a specific task and return its dataset items.
|
|
1758
1758
|
*
|
|
1759
1759
|
* The run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> seconds
|
|
@@ -1777,7 +1777,7 @@ export interface paths {
|
|
|
1777
1777
|
get: operations["actorTask_runSyncGetDatasetItems_get"];
|
|
1778
1778
|
put?: never;
|
|
1779
1779
|
/**
|
|
1780
|
-
* Run task synchronously and get dataset items
|
|
1780
|
+
* Run Actor task synchronously and get dataset items
|
|
1781
1781
|
* @description Runs an Actor task and synchronously returns its dataset items.
|
|
1782
1782
|
*
|
|
1783
1783
|
* The run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> seconds
|
|
@@ -1825,7 +1825,7 @@ export interface paths {
|
|
|
1825
1825
|
cookie?: never;
|
|
1826
1826
|
};
|
|
1827
1827
|
/**
|
|
1828
|
-
* Get last run
|
|
1828
|
+
* Get last run of an Actor task
|
|
1829
1829
|
* @description This is not a single endpoint, but an entire group of endpoints that lets you to
|
|
1830
1830
|
* retrieve and manage the last run of given actor task or any of its default storages.
|
|
1831
1831
|
* All the endpoints require an authentication token.
|
|
@@ -1866,10 +1866,10 @@ export interface paths {
|
|
|
1866
1866
|
cookie?: never;
|
|
1867
1867
|
};
|
|
1868
1868
|
/**
|
|
1869
|
-
* Get
|
|
1869
|
+
* Get log of an Actor task's last run
|
|
1870
1870
|
* @description Retrieves last Actor task run's logs.
|
|
1871
1871
|
*
|
|
1872
|
-
* This endpoint is a shortcut for getting last Actor task run's log. Same as [Get log](https://docs.apify.com/api/v2/log-get) endpoint.
|
|
1872
|
+
* This endpoint is a shortcut for getting last Actor task run's log. Same as [Get Actor build or run log](https://docs.apify.com/api/v2/log-get) endpoint.
|
|
1873
1873
|
*/
|
|
1874
1874
|
get: operations["actorTask_last_log_get"];
|
|
1875
1875
|
put?: never;
|
|
@@ -1890,7 +1890,7 @@ export interface paths {
|
|
|
1890
1890
|
get?: never;
|
|
1891
1891
|
put?: never;
|
|
1892
1892
|
/**
|
|
1893
|
-
* Abort Actor task
|
|
1893
|
+
* Abort last run of an Actor task
|
|
1894
1894
|
* @description Aborts the last run of the specified Actor task and returns an object that
|
|
1895
1895
|
* contains all the details about the run.
|
|
1896
1896
|
*
|
|
@@ -1916,7 +1916,7 @@ export interface paths {
|
|
|
1916
1916
|
get?: never;
|
|
1917
1917
|
put?: never;
|
|
1918
1918
|
/**
|
|
1919
|
-
* Metamorph Actor task
|
|
1919
|
+
* Metamorph last run of an Actor task
|
|
1920
1920
|
* @description Transforms the last run of the specified Actor task into a run of another Actor with
|
|
1921
1921
|
* a new input.
|
|
1922
1922
|
*
|
|
@@ -1940,7 +1940,7 @@ export interface paths {
|
|
|
1940
1940
|
get?: never;
|
|
1941
1941
|
put?: never;
|
|
1942
1942
|
/**
|
|
1943
|
-
* Reboot Actor task
|
|
1943
|
+
* Reboot last run of an Actor task
|
|
1944
1944
|
* @description Reboots the last run of the specified Actor task and returns an object that
|
|
1945
1945
|
* contains all the details about the rebooted run.
|
|
1946
1946
|
*
|
|
@@ -1964,7 +1964,7 @@ export interface paths {
|
|
|
1964
1964
|
cookie?: never;
|
|
1965
1965
|
};
|
|
1966
1966
|
/**
|
|
1967
|
-
* Get
|
|
1967
|
+
* Get the default dataset of an Actor task's last run
|
|
1968
1968
|
* @description Returns the default dataset associated with the last Actor task run.
|
|
1969
1969
|
*
|
|
1970
1970
|
* This endpoint is a shortcut for getting the last task run's `defaultDatasetId` and then using the
|
|
@@ -1972,7 +1972,7 @@ export interface paths {
|
|
|
1972
1972
|
*/
|
|
1973
1973
|
get: operations["actorTask_runs_last_dataset_get"];
|
|
1974
1974
|
/**
|
|
1975
|
-
* Update
|
|
1975
|
+
* Update the default dataset of an Actor task's last run
|
|
1976
1976
|
* @description Updates the default dataset associated with the last Actor task run.
|
|
1977
1977
|
*
|
|
1978
1978
|
* This endpoint is a shortcut for getting the last task run's `defaultDatasetId` and then using the
|
|
@@ -1981,7 +1981,7 @@ export interface paths {
|
|
|
1981
1981
|
put: operations["actorTask_runs_last_dataset_put"];
|
|
1982
1982
|
post?: never;
|
|
1983
1983
|
/**
|
|
1984
|
-
* Delete
|
|
1984
|
+
* Delete the default dataset of an Actor task's last run
|
|
1985
1985
|
* @description Deletes the default dataset associated with the last Actor task run.
|
|
1986
1986
|
*
|
|
1987
1987
|
* This endpoint is a shortcut for getting the last task run's `defaultDatasetId` and then using the
|
|
@@ -2001,7 +2001,7 @@ export interface paths {
|
|
|
2001
2001
|
cookie?: never;
|
|
2002
2002
|
};
|
|
2003
2003
|
/**
|
|
2004
|
-
* Get
|
|
2004
|
+
* Get the default dataset items from an Actor task's last run
|
|
2005
2005
|
* @description Returns data stored in the default dataset of the last Actor task run in the desired format.
|
|
2006
2006
|
*
|
|
2007
2007
|
* This endpoint is a shortcut that resolves the last task run's `defaultDatasetId` and proxies to the
|
|
@@ -2010,11 +2010,11 @@ export interface paths {
|
|
|
2010
2010
|
get: operations["actorTask_runs_last_dataset_items_get"];
|
|
2011
2011
|
put?: never;
|
|
2012
2012
|
/**
|
|
2013
|
-
* Store items in
|
|
2013
|
+
* Store items in the default dataset of an Actor task's last run
|
|
2014
2014
|
* @description Appends an item or an array of items to the end of the last Actor task run's default dataset.
|
|
2015
2015
|
*
|
|
2016
2016
|
* This endpoint is a shortcut that resolves the last task run's `defaultDatasetId` and proxies to the
|
|
2017
|
-
* [Store items](https://docs.apify.com/api/v2/dataset-items-post) endpoint.
|
|
2017
|
+
* [Store items in dataset](https://docs.apify.com/api/v2/dataset-items-post) endpoint.
|
|
2018
2018
|
*
|
|
2019
2019
|
* To save bandwidth and speed up your upload, you can send the request payload compressed and set the `Content-Encoding` header accordingly.
|
|
2020
2020
|
*
|
|
@@ -2039,7 +2039,7 @@ export interface paths {
|
|
|
2039
2039
|
cookie?: never;
|
|
2040
2040
|
};
|
|
2041
2041
|
/**
|
|
2042
|
-
* Get
|
|
2042
|
+
* Get the default dataset statistics for an Actor task's last run
|
|
2043
2043
|
* @description Returns statistics for the last Actor task run's default dataset.
|
|
2044
2044
|
*
|
|
2045
2045
|
* This endpoint is a shortcut that resolves the last task run's `defaultDatasetId` and proxies to the
|
|
@@ -2062,28 +2062,28 @@ export interface paths {
|
|
|
2062
2062
|
cookie?: never;
|
|
2063
2063
|
};
|
|
2064
2064
|
/**
|
|
2065
|
-
* Get
|
|
2065
|
+
* Get the default key-value store of an Actor task's last run
|
|
2066
2066
|
* @description Gets an object that contains all the details about the default key-value store of the last Actor task run.
|
|
2067
2067
|
*
|
|
2068
2068
|
* This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
|
|
2069
|
-
* [Get store](https://docs.apify.com/api/v2/key-value-store-get) endpoint.
|
|
2069
|
+
* [Get key-value store](https://docs.apify.com/api/v2/key-value-store-get) endpoint.
|
|
2070
2070
|
*/
|
|
2071
2071
|
get: operations["actorTask_runs_last_keyValueStore_get"];
|
|
2072
2072
|
/**
|
|
2073
|
-
* Update
|
|
2073
|
+
* Update the default key-value store of an Actor task's last run
|
|
2074
2074
|
* @description Updates the default key-value store associated with the last Actor task run.
|
|
2075
2075
|
*
|
|
2076
2076
|
* This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
|
|
2077
|
-
* [Update store](https://docs.apify.com/api/v2/key-value-store-put) endpoint.
|
|
2077
|
+
* [Update key-value store](https://docs.apify.com/api/v2/key-value-store-put) endpoint.
|
|
2078
2078
|
*/
|
|
2079
2079
|
put: operations["actorTask_runs_last_keyValueStore_put"];
|
|
2080
2080
|
post?: never;
|
|
2081
2081
|
/**
|
|
2082
|
-
* Delete
|
|
2082
|
+
* Delete the default key-value store of an Actor task's last run
|
|
2083
2083
|
* @description Deletes the default key-value store of the last Actor task run.
|
|
2084
2084
|
*
|
|
2085
2085
|
* This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
|
|
2086
|
-
* [Delete store](https://docs.apify.com/api/v2/key-value-store-delete) endpoint.
|
|
2086
|
+
* [Delete key-value store](https://docs.apify.com/api/v2/key-value-store-delete) endpoint.
|
|
2087
2087
|
*/
|
|
2088
2088
|
delete: operations["actorTask_runs_last_keyValueStore_delete"];
|
|
2089
2089
|
options?: never;
|
|
@@ -2099,11 +2099,11 @@ export interface paths {
|
|
|
2099
2099
|
cookie?: never;
|
|
2100
2100
|
};
|
|
2101
2101
|
/**
|
|
2102
|
-
* Get
|
|
2102
|
+
* Get list of keys in the default key-value store of an Actor task's last run
|
|
2103
2103
|
* @description Returns a list of keys for the default key-value store of the last Actor task run.
|
|
2104
2104
|
*
|
|
2105
2105
|
* This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
|
|
2106
|
-
* [Get list of keys](https://docs.apify.com/api/v2/key-value-store-keys-get) endpoint.
|
|
2106
|
+
* [Get list of key-value store keys](https://docs.apify.com/api/v2/key-value-store-keys-get) endpoint.
|
|
2107
2107
|
*/
|
|
2108
2108
|
get: operations["actorTask_runs_last_keyValueStore_keys_get"];
|
|
2109
2109
|
put?: never;
|
|
@@ -2122,11 +2122,11 @@ export interface paths {
|
|
|
2122
2122
|
cookie?: never;
|
|
2123
2123
|
};
|
|
2124
2124
|
/**
|
|
2125
|
-
* Download
|
|
2125
|
+
* Download records from the default key-value store of an Actor task's last run
|
|
2126
2126
|
* @description Downloads all records from the default key-value store of the last Actor task run as a ZIP archive.
|
|
2127
2127
|
*
|
|
2128
2128
|
* This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
|
|
2129
|
-
* [Download records](https://docs.apify.com/api/v2/key-value-store-records-get) endpoint.
|
|
2129
|
+
* [Download key-value store records](https://docs.apify.com/api/v2/key-value-store-records-get) endpoint.
|
|
2130
2130
|
*/
|
|
2131
2131
|
get: operations["actorTask_runs_last_keyValueStore_records_get"];
|
|
2132
2132
|
put?: never;
|
|
@@ -2145,35 +2145,35 @@ export interface paths {
|
|
|
2145
2145
|
cookie?: never;
|
|
2146
2146
|
};
|
|
2147
2147
|
/**
|
|
2148
|
-
* Get
|
|
2148
|
+
* Get record from the default key-value store of an Actor task's last run
|
|
2149
2149
|
* @description Gets a value stored under a specific key in the default key-value store of the last Actor task run.
|
|
2150
2150
|
*
|
|
2151
2151
|
* This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
|
|
2152
|
-
* [Get record](https://docs.apify.com/api/v2/key-value-store-record-get) endpoint.
|
|
2152
|
+
* [Get key-value store record](https://docs.apify.com/api/v2/key-value-store-record-get) endpoint.
|
|
2153
2153
|
*/
|
|
2154
2154
|
get: operations["actorTask_runs_last_keyValueStore_record_get"];
|
|
2155
2155
|
/**
|
|
2156
|
-
*
|
|
2156
|
+
* Set record in the default key-value store of an Actor task's last run
|
|
2157
2157
|
* @description Stores a value under a specific key in the default key-value store of the last Actor task run.
|
|
2158
2158
|
*
|
|
2159
2159
|
* This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
|
|
2160
|
-
* [
|
|
2160
|
+
* [Set key-value store record](https://docs.apify.com/api/v2/key-value-store-record-put) endpoint.
|
|
2161
2161
|
*/
|
|
2162
2162
|
put: operations["actorTask_runs_last_keyValueStore_record_put"];
|
|
2163
2163
|
/**
|
|
2164
|
-
*
|
|
2164
|
+
* Set record in the default key-value store of an Actor task's last run (POST)
|
|
2165
2165
|
* @description Stores a value under a specific key in the default key-value store of the last Actor task run.
|
|
2166
2166
|
*
|
|
2167
2167
|
* This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
|
|
2168
|
-
* [
|
|
2168
|
+
* [Set key-value store record (POST)](https://docs.apify.com/api/v2/key-value-store-record-post) endpoint.
|
|
2169
2169
|
*/
|
|
2170
2170
|
post: operations["actorTask_runs_last_keyValueStore_record_post"];
|
|
2171
2171
|
/**
|
|
2172
|
-
* Delete
|
|
2172
|
+
* Delete record from the default key-value store of an Actor task's last run
|
|
2173
2173
|
* @description Removes a record specified by a key from the default key-value store of the last Actor task run.
|
|
2174
2174
|
*
|
|
2175
2175
|
* This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
|
|
2176
|
-
* [Delete record](https://docs.apify.com/api/v2/key-value-store-record-delete) endpoint.
|
|
2176
|
+
* [Delete key-value store record](https://docs.apify.com/api/v2/key-value-store-record-delete) endpoint.
|
|
2177
2177
|
*/
|
|
2178
2178
|
delete: operations["actorTask_runs_last_keyValueStore_record_delete"];
|
|
2179
2179
|
options?: never;
|
|
@@ -2189,7 +2189,7 @@ export interface paths {
|
|
|
2189
2189
|
cookie?: never;
|
|
2190
2190
|
};
|
|
2191
2191
|
/**
|
|
2192
|
-
* Get
|
|
2192
|
+
* Get the default request queue of an Actor task's last run
|
|
2193
2193
|
* @description Returns the default request queue associated with the last Actor task run.
|
|
2194
2194
|
*
|
|
2195
2195
|
* This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
|
|
@@ -2197,7 +2197,7 @@ export interface paths {
|
|
|
2197
2197
|
*/
|
|
2198
2198
|
get: operations["actorTask_runs_last_requestQueue_get"];
|
|
2199
2199
|
/**
|
|
2200
|
-
* Update
|
|
2200
|
+
* Update the default request queue of an Actor task's last run
|
|
2201
2201
|
* @description Updates the default request queue associated with the last Actor task run.
|
|
2202
2202
|
*
|
|
2203
2203
|
* This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
|
|
@@ -2206,7 +2206,7 @@ export interface paths {
|
|
|
2206
2206
|
put: operations["actorTask_runs_last_requestQueue_put"];
|
|
2207
2207
|
post?: never;
|
|
2208
2208
|
/**
|
|
2209
|
-
* Delete
|
|
2209
|
+
* Delete the default request queue of an Actor task's last run
|
|
2210
2210
|
* @description Deletes the default request queue associated with the last Actor task run.
|
|
2211
2211
|
*
|
|
2212
2212
|
* This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
|
|
@@ -2226,11 +2226,11 @@ export interface paths {
|
|
|
2226
2226
|
cookie?: never;
|
|
2227
2227
|
};
|
|
2228
2228
|
/**
|
|
2229
|
-
* Get
|
|
2229
|
+
* Get the default request queue head for an Actor task's last run
|
|
2230
2230
|
* @description Returns the given number of first requests from the default request queue of the last Actor task run.
|
|
2231
2231
|
*
|
|
2232
2232
|
* This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
|
|
2233
|
-
* [Get head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
2233
|
+
* [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
2234
2234
|
*/
|
|
2235
2235
|
get: operations["actorTask_runs_last_requestQueue_head_get"];
|
|
2236
2236
|
put?: never;
|
|
@@ -2251,12 +2251,12 @@ export interface paths {
|
|
|
2251
2251
|
get?: never;
|
|
2252
2252
|
put?: never;
|
|
2253
2253
|
/**
|
|
2254
|
-
* Get and lock
|
|
2254
|
+
* Get and lock the default request queue head for an Actor task's last run
|
|
2255
2255
|
* @description Returns the given number of first requests from the default request queue of the last Actor task run
|
|
2256
2256
|
* and locks them for the given time.
|
|
2257
2257
|
*
|
|
2258
2258
|
* This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
|
|
2259
|
-
* [Get
|
|
2259
|
+
* [Get and lock request queue head](https://docs.apify.com/api/v2/request-queue-head-lock-post) endpoint.
|
|
2260
2260
|
*/
|
|
2261
2261
|
post: operations["actorTask_runs_last_requestQueue_head_lock_post"];
|
|
2262
2262
|
delete?: never;
|
|
@@ -2273,20 +2273,20 @@ export interface paths {
|
|
|
2273
2273
|
cookie?: never;
|
|
2274
2274
|
};
|
|
2275
2275
|
/**
|
|
2276
|
-
* List
|
|
2276
|
+
* List requests in the default request queue of an Actor task's last run
|
|
2277
2277
|
* @description Returns a list of requests from the default request queue of the last Actor task run.
|
|
2278
2278
|
*
|
|
2279
2279
|
* This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
|
|
2280
|
-
* [List requests](https://docs.apify.com/api/v2/request-queue-requests-get) endpoint.
|
|
2280
|
+
* [List requests in request queue](https://docs.apify.com/api/v2/request-queue-requests-get) endpoint.
|
|
2281
2281
|
*/
|
|
2282
2282
|
get: operations["actorTask_runs_last_requestQueue_requests_get"];
|
|
2283
2283
|
put?: never;
|
|
2284
2284
|
/**
|
|
2285
|
-
* Add request to
|
|
2285
|
+
* Add request to the default request queue of an Actor task's last run
|
|
2286
2286
|
* @description Adds a request to the default request queue of the last Actor task run.
|
|
2287
2287
|
*
|
|
2288
2288
|
* This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
|
|
2289
|
-
* [Add request](https://docs.apify.com/api/v2/request-queue-requests-post) endpoint.
|
|
2289
|
+
* [Add request to request queue](https://docs.apify.com/api/v2/request-queue-requests-post) endpoint.
|
|
2290
2290
|
*/
|
|
2291
2291
|
post: operations["actorTask_runs_last_requestQueue_requests_post"];
|
|
2292
2292
|
delete?: never;
|
|
@@ -2305,19 +2305,19 @@ export interface paths {
|
|
|
2305
2305
|
get?: never;
|
|
2306
2306
|
put?: never;
|
|
2307
2307
|
/**
|
|
2308
|
-
* Batch add requests to
|
|
2308
|
+
* Batch add requests to the default request queue of an Actor task's last run
|
|
2309
2309
|
* @description Adds requests to the default request queue of the last Actor task run in batch.
|
|
2310
2310
|
*
|
|
2311
2311
|
* This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
|
|
2312
|
-
* [
|
|
2312
|
+
* [Batch add requests to request queue](https://docs.apify.com/api/v2/request-queue-requests-batch-post) endpoint.
|
|
2313
2313
|
*/
|
|
2314
2314
|
post: operations["actorTask_runs_last_requestQueue_requests_batch_post"];
|
|
2315
2315
|
/**
|
|
2316
|
-
* Batch delete requests from
|
|
2316
|
+
* Batch delete requests from the default request queue of an Actor task's last run
|
|
2317
2317
|
* @description Batch-deletes requests from the default request queue of the last Actor task run.
|
|
2318
2318
|
*
|
|
2319
2319
|
* This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
|
|
2320
|
-
* [
|
|
2320
|
+
* [Batch delete requests from request queue](https://docs.apify.com/api/v2/request-queue-requests-batch-delete) endpoint.
|
|
2321
2321
|
*/
|
|
2322
2322
|
delete: operations["actorTask_runs_last_requestQueue_requests_batch_delete"];
|
|
2323
2323
|
options?: never;
|
|
@@ -2335,11 +2335,11 @@ export interface paths {
|
|
|
2335
2335
|
get?: never;
|
|
2336
2336
|
put?: never;
|
|
2337
2337
|
/**
|
|
2338
|
-
* Unlock requests in
|
|
2338
|
+
* Unlock requests in the default request queue of an Actor task's last run
|
|
2339
2339
|
* @description Unlocks requests in the default request queue of the last Actor task run that are currently locked by the client.
|
|
2340
2340
|
*
|
|
2341
2341
|
* This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
|
|
2342
|
-
* [Unlock requests](https://docs.apify.com/api/v2/request-queue-requests-unlock-post) endpoint.
|
|
2342
|
+
* [Unlock requests in request queue](https://docs.apify.com/api/v2/request-queue-requests-unlock-post) endpoint.
|
|
2343
2343
|
*/
|
|
2344
2344
|
post: operations["actorTask_runs_last_requestQueue_requests_unlock_post"];
|
|
2345
2345
|
delete?: never;
|
|
@@ -2356,28 +2356,28 @@ export interface paths {
|
|
|
2356
2356
|
cookie?: never;
|
|
2357
2357
|
};
|
|
2358
2358
|
/**
|
|
2359
|
-
* Get request from
|
|
2359
|
+
* Get request from the default request queue of an Actor task's last run
|
|
2360
2360
|
* @description Returns a request from the default request queue of the last Actor task run.
|
|
2361
2361
|
*
|
|
2362
2362
|
* This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
|
|
2363
|
-
* [Get request](https://docs.apify.com/api/v2/request-queue-request-get) endpoint.
|
|
2363
|
+
* [Get request from request queue](https://docs.apify.com/api/v2/request-queue-request-get) endpoint.
|
|
2364
2364
|
*/
|
|
2365
2365
|
get: operations["actorTask_runs_last_requestQueue_request_get"];
|
|
2366
2366
|
/**
|
|
2367
|
-
* Update request in
|
|
2367
|
+
* Update request in the default request queue of an Actor task's last run
|
|
2368
2368
|
* @description Updates a request in the default request queue of the last Actor task run.
|
|
2369
2369
|
*
|
|
2370
2370
|
* This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
|
|
2371
|
-
* [Update request](https://docs.apify.com/api/v2/request-queue-request-put) endpoint.
|
|
2371
|
+
* [Update request in request queue](https://docs.apify.com/api/v2/request-queue-request-put) endpoint.
|
|
2372
2372
|
*/
|
|
2373
2373
|
put: operations["actorTask_runs_last_requestQueue_request_put"];
|
|
2374
2374
|
post?: never;
|
|
2375
2375
|
/**
|
|
2376
|
-
* Delete request from
|
|
2376
|
+
* Delete request from the default request queue of an Actor task's last run
|
|
2377
2377
|
* @description Deletes a request from the default request queue of the last Actor task run.
|
|
2378
2378
|
*
|
|
2379
2379
|
* This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
|
|
2380
|
-
* [Delete request](https://docs.apify.com/api/v2/request-queue-request-delete) endpoint.
|
|
2380
|
+
* [Delete request from request queue](https://docs.apify.com/api/v2/request-queue-request-delete) endpoint.
|
|
2381
2381
|
*/
|
|
2382
2382
|
delete: operations["actorTask_runs_last_requestQueue_request_delete"];
|
|
2383
2383
|
options?: never;
|
|
@@ -2394,20 +2394,20 @@ export interface paths {
|
|
|
2394
2394
|
};
|
|
2395
2395
|
get?: never;
|
|
2396
2396
|
/**
|
|
2397
|
-
* Prolong lock on request in
|
|
2397
|
+
* Prolong lock on request in the default request queue of an Actor task's last run
|
|
2398
2398
|
* @description Prolongs a request lock in the default request queue of the last Actor task run.
|
|
2399
2399
|
*
|
|
2400
2400
|
* This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
|
|
2401
|
-
* [Prolong request
|
|
2401
|
+
* [Prolong lock on request in request queue](https://docs.apify.com/api/v2/request-queue-request-lock-put) endpoint.
|
|
2402
2402
|
*/
|
|
2403
2403
|
put: operations["actorTask_runs_last_requestQueue_request_lock_put"];
|
|
2404
2404
|
post?: never;
|
|
2405
2405
|
/**
|
|
2406
|
-
* Delete lock on request in
|
|
2406
|
+
* Delete lock on request in the default request queue of an Actor task's last run
|
|
2407
2407
|
* @description Deletes a request lock in the default request queue of the last Actor task run.
|
|
2408
2408
|
*
|
|
2409
2409
|
* This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
|
|
2410
|
-
* [Delete request
|
|
2410
|
+
* [Delete lock on request in request queue](https://docs.apify.com/api/v2/request-queue-request-lock-delete) endpoint.
|
|
2411
2411
|
*/
|
|
2412
2412
|
delete: operations["actorTask_runs_last_requestQueue_request_lock_delete"];
|
|
2413
2413
|
options?: never;
|
|
@@ -2423,7 +2423,7 @@ export interface paths {
|
|
|
2423
2423
|
cookie?: never;
|
|
2424
2424
|
};
|
|
2425
2425
|
/**
|
|
2426
|
-
* Get user runs
|
|
2426
|
+
* Get list of user's Actor runs
|
|
2427
2427
|
* @description Gets a list of all runs for a user. The response is a list of objects, where
|
|
2428
2428
|
* each object contains basic information about a single Actor run.
|
|
2429
2429
|
*
|
|
@@ -2453,7 +2453,7 @@ export interface paths {
|
|
|
2453
2453
|
cookie?: never;
|
|
2454
2454
|
};
|
|
2455
2455
|
/**
|
|
2456
|
-
* Get run
|
|
2456
|
+
* Get Actor run
|
|
2457
2457
|
* @description This is not a single endpoint, but an entire group of endpoints that lets
|
|
2458
2458
|
* you retrieve the run or any of its default storages.
|
|
2459
2459
|
*
|
|
@@ -2478,7 +2478,7 @@ export interface paths {
|
|
|
2478
2478
|
*/
|
|
2479
2479
|
get: operations["actorRun_get"];
|
|
2480
2480
|
/**
|
|
2481
|
-
* Update run
|
|
2481
|
+
* Update Actor run
|
|
2482
2482
|
* @description This endpoint can be used to update both the run's status message and to configure its general resource access level.
|
|
2483
2483
|
*
|
|
2484
2484
|
* **Status message:**
|
|
@@ -2507,7 +2507,7 @@ export interface paths {
|
|
|
2507
2507
|
put: operations["actorRun_put"];
|
|
2508
2508
|
post?: never;
|
|
2509
2509
|
/**
|
|
2510
|
-
* Delete run
|
|
2510
|
+
* Delete Actor run
|
|
2511
2511
|
* @description Delete the run. Only finished runs can be deleted. Only the person or
|
|
2512
2512
|
* organization that initiated the run can delete it.
|
|
2513
2513
|
*/
|
|
@@ -2527,7 +2527,7 @@ export interface paths {
|
|
|
2527
2527
|
get?: never;
|
|
2528
2528
|
put?: never;
|
|
2529
2529
|
/**
|
|
2530
|
-
* Abort run
|
|
2530
|
+
* Abort Actor run
|
|
2531
2531
|
* @description Aborts an Actor run and returns an object that contains all the details
|
|
2532
2532
|
* about the run.
|
|
2533
2533
|
*
|
|
@@ -2551,7 +2551,7 @@ export interface paths {
|
|
|
2551
2551
|
get?: never;
|
|
2552
2552
|
put?: never;
|
|
2553
2553
|
/**
|
|
2554
|
-
* Metamorph run
|
|
2554
|
+
* Metamorph Actor run
|
|
2555
2555
|
* @description Transforms an Actor run into a run of another Actor with a new input.
|
|
2556
2556
|
*
|
|
2557
2557
|
* This is useful if you want to use another Actor to finish the work
|
|
@@ -2586,7 +2586,7 @@ export interface paths {
|
|
|
2586
2586
|
get?: never;
|
|
2587
2587
|
put?: never;
|
|
2588
2588
|
/**
|
|
2589
|
-
* Reboot run
|
|
2589
|
+
* Reboot Actor run
|
|
2590
2590
|
* @description Reboots an Actor run and returns an object that contains all the details
|
|
2591
2591
|
* about the rebooted run.
|
|
2592
2592
|
*
|
|
@@ -2612,7 +2612,7 @@ export interface paths {
|
|
|
2612
2612
|
get?: never;
|
|
2613
2613
|
put?: never;
|
|
2614
2614
|
/**
|
|
2615
|
-
* Resurrect run
|
|
2615
|
+
* Resurrect Actor run
|
|
2616
2616
|
* @description Resurrects a finished Actor run and returns an object that contains all the details about the resurrected run.
|
|
2617
2617
|
* Only finished runs, i.e. runs with status `FINISHED`, `FAILED`, `ABORTED` and `TIMED-OUT` can be resurrected.
|
|
2618
2618
|
* Run status will be updated to RUNNING and its container will be restarted with the same storages
|
|
@@ -2637,7 +2637,7 @@ export interface paths {
|
|
|
2637
2637
|
get?: never;
|
|
2638
2638
|
put?: never;
|
|
2639
2639
|
/**
|
|
2640
|
-
* Charge events in run
|
|
2640
|
+
* Charge events in Actor run
|
|
2641
2641
|
* @description Charge for events in the run of your [pay per event Actor](https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event).
|
|
2642
2642
|
* The event you are charging for must be one of the configured events in your Actor. If the Actor is not set up as pay per event, or if the event is not configured,
|
|
2643
2643
|
* the endpoint will return an error. The endpoint must be called from the Actor run itself, with the same API token that the run was started with.
|
|
@@ -2663,7 +2663,7 @@ export interface paths {
|
|
|
2663
2663
|
cookie?: never;
|
|
2664
2664
|
};
|
|
2665
2665
|
/**
|
|
2666
|
-
* Get default dataset
|
|
2666
|
+
* Get the default dataset of an Actor run
|
|
2667
2667
|
* @description Returns the default dataset associated with an Actor run.
|
|
2668
2668
|
*
|
|
2669
2669
|
* This endpoint is a shortcut for getting the run's `defaultDatasetId` and then using the
|
|
@@ -2671,7 +2671,7 @@ export interface paths {
|
|
|
2671
2671
|
*/
|
|
2672
2672
|
get: operations["actorRun_dataset_get"];
|
|
2673
2673
|
/**
|
|
2674
|
-
* Update default dataset
|
|
2674
|
+
* Update the default dataset of an Actor run
|
|
2675
2675
|
* @description Updates the default dataset associated with an Actor run.
|
|
2676
2676
|
*
|
|
2677
2677
|
* This endpoint is a shortcut for getting the run's `defaultDatasetId` and then using the
|
|
@@ -2680,7 +2680,7 @@ export interface paths {
|
|
|
2680
2680
|
put: operations["actorRun_dataset_put"];
|
|
2681
2681
|
post?: never;
|
|
2682
2682
|
/**
|
|
2683
|
-
* Delete default dataset
|
|
2683
|
+
* Delete the default dataset of an Actor run
|
|
2684
2684
|
* @description Deletes default dataset associated with an Actor run.
|
|
2685
2685
|
*
|
|
2686
2686
|
* This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
|
|
@@ -2700,7 +2700,7 @@ export interface paths {
|
|
|
2700
2700
|
cookie?: never;
|
|
2701
2701
|
};
|
|
2702
2702
|
/**
|
|
2703
|
-
* Get default dataset items
|
|
2703
|
+
* Get the default dataset items from an Actor run
|
|
2704
2704
|
* @description Returns data stored in the default dataset of the Actor run in the desired format.
|
|
2705
2705
|
*
|
|
2706
2706
|
* This endpoint is a shortcut that resolves the run's `defaultDatasetId` and proxies to the
|
|
@@ -2709,11 +2709,11 @@ export interface paths {
|
|
|
2709
2709
|
get: operations["actorRun_dataset_items_get"];
|
|
2710
2710
|
put?: never;
|
|
2711
2711
|
/**
|
|
2712
|
-
* Store items
|
|
2712
|
+
* Store items in the default dataset of an Actor run
|
|
2713
2713
|
* @description Appends an item or an array of items to the end of the Actor run's default dataset.
|
|
2714
2714
|
*
|
|
2715
2715
|
* This endpoint is a shortcut that resolves the run's `defaultDatasetId` and proxies to the
|
|
2716
|
-
* [Store items](https://docs.apify.com/api/v2/dataset-items-post) endpoint.
|
|
2716
|
+
* [Store items in dataset](https://docs.apify.com/api/v2/dataset-items-post) endpoint.
|
|
2717
2717
|
*
|
|
2718
2718
|
* To save bandwidth and speed up your upload, you can send the request payload compressed and set the `Content-Encoding` header accordingly.
|
|
2719
2719
|
*
|
|
@@ -2738,7 +2738,7 @@ export interface paths {
|
|
|
2738
2738
|
cookie?: never;
|
|
2739
2739
|
};
|
|
2740
2740
|
/**
|
|
2741
|
-
* Get default dataset statistics
|
|
2741
|
+
* Get the default dataset statistics for an Actor run
|
|
2742
2742
|
* @description Returns statistics for the Actor run's default dataset.
|
|
2743
2743
|
*
|
|
2744
2744
|
* This endpoint is a shortcut that resolves the run's `defaultDatasetId` and proxies to the
|
|
@@ -2761,30 +2761,30 @@ export interface paths {
|
|
|
2761
2761
|
cookie?: never;
|
|
2762
2762
|
};
|
|
2763
2763
|
/**
|
|
2764
|
-
* Get default store
|
|
2764
|
+
* Get the default key-value store of an Actor run
|
|
2765
2765
|
* @description Gets an object that contains all the details about the default key-value
|
|
2766
2766
|
* store.
|
|
2767
2767
|
*
|
|
2768
2768
|
* This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
|
|
2769
|
-
* [Get store](https://docs.apify.com/api/v2/key-value-store-get) endpoint.
|
|
2769
|
+
* [Get key-value store](https://docs.apify.com/api/v2/key-value-store-get) endpoint.
|
|
2770
2770
|
*/
|
|
2771
2771
|
get: operations["actorRun_keyValueStore_get"];
|
|
2772
2772
|
/**
|
|
2773
|
-
* Update default store
|
|
2773
|
+
* Update the default key-value store of an Actor run
|
|
2774
2774
|
* @description Updates the default key-value store's name and general resource access level using a value specified by a JSON object
|
|
2775
2775
|
* passed in the PUT payload.
|
|
2776
2776
|
*
|
|
2777
2777
|
* This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
|
|
2778
|
-
* [Update store](https://docs.apify.com/api/v2/key-value-store-put) endpoint.
|
|
2778
|
+
* [Update key-value store](https://docs.apify.com/api/v2/key-value-store-put) endpoint.
|
|
2779
2779
|
*/
|
|
2780
2780
|
put: operations["actorRun_keyValueStore_put"];
|
|
2781
2781
|
post?: never;
|
|
2782
2782
|
/**
|
|
2783
|
-
* Delete default store
|
|
2783
|
+
* Delete the default key-value store of an Actor run
|
|
2784
2784
|
* @description Delete the default key-value store.
|
|
2785
2785
|
*
|
|
2786
2786
|
* This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
|
|
2787
|
-
* [Delete store](https://docs.apify.com/api/v2/key-value-store-delete) endpoint.
|
|
2787
|
+
* [Delete key-value store](https://docs.apify.com/api/v2/key-value-store-delete) endpoint.
|
|
2788
2788
|
*/
|
|
2789
2789
|
delete: operations["actorRun_keyValueStore_delete"];
|
|
2790
2790
|
options?: never;
|
|
@@ -2800,11 +2800,11 @@ export interface paths {
|
|
|
2800
2800
|
cookie?: never;
|
|
2801
2801
|
};
|
|
2802
2802
|
/**
|
|
2803
|
-
* Get default store
|
|
2803
|
+
* Get list of keys in the default key-value store of an Actor run
|
|
2804
2804
|
* @description Returns a list of keys for the default key-value store of the Actor run.
|
|
2805
2805
|
*
|
|
2806
2806
|
* This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
|
|
2807
|
-
* [Get list of keys](https://docs.apify.com/api/v2/key-value-store-keys-get) endpoint.
|
|
2807
|
+
* [Get list of key-value store keys](https://docs.apify.com/api/v2/key-value-store-keys-get) endpoint.
|
|
2808
2808
|
*/
|
|
2809
2809
|
get: operations["actorRun_keyValueStore_keys_get"];
|
|
2810
2810
|
put?: never;
|
|
@@ -2823,11 +2823,11 @@ export interface paths {
|
|
|
2823
2823
|
cookie?: never;
|
|
2824
2824
|
};
|
|
2825
2825
|
/**
|
|
2826
|
-
* Download default store
|
|
2826
|
+
* Download records from the default key-value store of an Actor run
|
|
2827
2827
|
* @description Downloads all records from the default key-value store of the Actor run as a ZIP archive.
|
|
2828
2828
|
*
|
|
2829
2829
|
* This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
|
|
2830
|
-
* [Download records](https://docs.apify.com/api/v2/key-value-store-records-get) endpoint.
|
|
2830
|
+
* [Download key-value store records](https://docs.apify.com/api/v2/key-value-store-records-get) endpoint.
|
|
2831
2831
|
*/
|
|
2832
2832
|
get: operations["actorRun_keyValueStore_records_get"];
|
|
2833
2833
|
put?: never;
|
|
@@ -2846,35 +2846,35 @@ export interface paths {
|
|
|
2846
2846
|
cookie?: never;
|
|
2847
2847
|
};
|
|
2848
2848
|
/**
|
|
2849
|
-
* Get default store
|
|
2849
|
+
* Get record from the default key-value store of an Actor run
|
|
2850
2850
|
* @description Gets a value stored under a specific key in the default key-value store of the Actor run.
|
|
2851
2851
|
*
|
|
2852
2852
|
* This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
|
|
2853
|
-
* [Get record](https://docs.apify.com/api/v2/key-value-store-record-get) endpoint.
|
|
2853
|
+
* [Get key-value store record](https://docs.apify.com/api/v2/key-value-store-record-get) endpoint.
|
|
2854
2854
|
*/
|
|
2855
2855
|
get: operations["actorRun_keyValueStore_record_get"];
|
|
2856
2856
|
/**
|
|
2857
|
-
*
|
|
2857
|
+
* Set record in the default key-value store of an Actor run
|
|
2858
2858
|
* @description Stores a value under a specific key in the default key-value store of the Actor run.
|
|
2859
2859
|
*
|
|
2860
2860
|
* This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
|
|
2861
|
-
* [
|
|
2861
|
+
* [Set key-value store record](https://docs.apify.com/api/v2/key-value-store-record-put) endpoint.
|
|
2862
2862
|
*/
|
|
2863
2863
|
put: operations["actorRun_keyValueStore_record_put"];
|
|
2864
2864
|
/**
|
|
2865
|
-
*
|
|
2865
|
+
* Set record in the default key-value store of an Actor run (POST)
|
|
2866
2866
|
* @description Stores a value under a specific key in the default key-value store of the Actor run.
|
|
2867
2867
|
*
|
|
2868
2868
|
* This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
|
|
2869
|
-
* [
|
|
2869
|
+
* [Set key-value store record (POST)](https://docs.apify.com/api/v2/key-value-store-record-post) endpoint.
|
|
2870
2870
|
*/
|
|
2871
2871
|
post: operations["actorRun_keyValueStore_record_post"];
|
|
2872
2872
|
/**
|
|
2873
|
-
* Delete default store
|
|
2873
|
+
* Delete record from the default key-value store of an Actor run
|
|
2874
2874
|
* @description Removes a record specified by a key from the default key-value store of the Actor run.
|
|
2875
2875
|
*
|
|
2876
2876
|
* This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
|
|
2877
|
-
* [Delete record](https://docs.apify.com/api/v2/key-value-store-record-delete) endpoint.
|
|
2877
|
+
* [Delete key-value store record](https://docs.apify.com/api/v2/key-value-store-record-delete) endpoint.
|
|
2878
2878
|
*/
|
|
2879
2879
|
delete: operations["actorRun_keyValueStore_record_delete"];
|
|
2880
2880
|
options?: never;
|
|
@@ -2890,7 +2890,7 @@ export interface paths {
|
|
|
2890
2890
|
cookie?: never;
|
|
2891
2891
|
};
|
|
2892
2892
|
/**
|
|
2893
|
-
* Get default request queue
|
|
2893
|
+
* Get the default request queue of an Actor run
|
|
2894
2894
|
* @description Returns the default request queue associated with an Actor run.
|
|
2895
2895
|
*
|
|
2896
2896
|
* This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
|
|
@@ -2898,7 +2898,7 @@ export interface paths {
|
|
|
2898
2898
|
*/
|
|
2899
2899
|
get: operations["actorRun_requestQueue_get"];
|
|
2900
2900
|
/**
|
|
2901
|
-
* Update default request queue
|
|
2901
|
+
* Update the default request queue of an Actor run
|
|
2902
2902
|
* @description Updates the default request queue associated with an Actor run.
|
|
2903
2903
|
*
|
|
2904
2904
|
* This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
|
|
@@ -2907,7 +2907,7 @@ export interface paths {
|
|
|
2907
2907
|
put: operations["actorRun_requestQueue_put"];
|
|
2908
2908
|
post?: never;
|
|
2909
2909
|
/**
|
|
2910
|
-
* Delete default request queue
|
|
2910
|
+
* Delete the default request queue of an Actor run
|
|
2911
2911
|
* @description Deletes the default request queue associated with an Actor run.
|
|
2912
2912
|
*
|
|
2913
2913
|
* This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
|
|
@@ -2927,20 +2927,20 @@ export interface paths {
|
|
|
2927
2927
|
cookie?: never;
|
|
2928
2928
|
};
|
|
2929
2929
|
/**
|
|
2930
|
-
* List default request queue
|
|
2930
|
+
* List requests in the default request queue of an Actor run
|
|
2931
2931
|
* @description Returns a list of requests from the default request queue of the Actor run.
|
|
2932
2932
|
*
|
|
2933
2933
|
* This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
|
|
2934
|
-
* [List requests](https://docs.apify.com/api/v2/request-queue-requests-get) endpoint.
|
|
2934
|
+
* [List requests in request queue](https://docs.apify.com/api/v2/request-queue-requests-get) endpoint.
|
|
2935
2935
|
*/
|
|
2936
2936
|
get: operations["actorRun_requestQueue_requests_get"];
|
|
2937
2937
|
put?: never;
|
|
2938
2938
|
/**
|
|
2939
|
-
* Add request to default request queue
|
|
2939
|
+
* Add request to the default request queue of an Actor run
|
|
2940
2940
|
* @description Adds a request to the default request queue of the Actor run.
|
|
2941
2941
|
*
|
|
2942
2942
|
* This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
|
|
2943
|
-
* [Add request](https://docs.apify.com/api/v2/request-queue-requests-post) endpoint.
|
|
2943
|
+
* [Add request to request queue](https://docs.apify.com/api/v2/request-queue-requests-post) endpoint.
|
|
2944
2944
|
*/
|
|
2945
2945
|
post: operations["actorRun_requestQueue_requests_post"];
|
|
2946
2946
|
delete?: never;
|
|
@@ -2959,19 +2959,19 @@ export interface paths {
|
|
|
2959
2959
|
get?: never;
|
|
2960
2960
|
put?: never;
|
|
2961
2961
|
/**
|
|
2962
|
-
* Batch add requests to default request queue
|
|
2962
|
+
* Batch add requests to the default request queue of an Actor run
|
|
2963
2963
|
* @description Adds requests to the default request queue of the Actor run in batch.
|
|
2964
2964
|
*
|
|
2965
2965
|
* This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
|
|
2966
|
-
* [
|
|
2966
|
+
* [Batch add requests to request queue](https://docs.apify.com/api/v2/request-queue-requests-batch-post) endpoint.
|
|
2967
2967
|
*/
|
|
2968
2968
|
post: operations["actorRun_requestQueue_requests_batch_post"];
|
|
2969
2969
|
/**
|
|
2970
|
-
* Batch delete requests from default request queue
|
|
2970
|
+
* Batch delete requests from the default request queue of an Actor run
|
|
2971
2971
|
* @description Batch-deletes requests from the default request queue of the Actor run.
|
|
2972
2972
|
*
|
|
2973
2973
|
* This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
|
|
2974
|
-
* [
|
|
2974
|
+
* [Batch delete requests from request queue](https://docs.apify.com/api/v2/request-queue-requests-batch-delete) endpoint.
|
|
2975
2975
|
*/
|
|
2976
2976
|
delete: operations["actorRun_requestQueue_requests_batch_delete"];
|
|
2977
2977
|
options?: never;
|
|
@@ -2989,11 +2989,11 @@ export interface paths {
|
|
|
2989
2989
|
get?: never;
|
|
2990
2990
|
put?: never;
|
|
2991
2991
|
/**
|
|
2992
|
-
* Unlock requests in default request queue
|
|
2992
|
+
* Unlock requests in the default request queue of an Actor run
|
|
2993
2993
|
* @description Unlocks requests in the default request queue of the Actor run that are currently locked by the client.
|
|
2994
2994
|
*
|
|
2995
2995
|
* This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
|
|
2996
|
-
* [Unlock requests](https://docs.apify.com/api/v2/request-queue-requests-unlock-post) endpoint.
|
|
2996
|
+
* [Unlock requests in request queue](https://docs.apify.com/api/v2/request-queue-requests-unlock-post) endpoint.
|
|
2997
2997
|
*/
|
|
2998
2998
|
post: operations["actorRun_requestQueue_requests_unlock_post"];
|
|
2999
2999
|
delete?: never;
|
|
@@ -3010,28 +3010,28 @@ export interface paths {
|
|
|
3010
3010
|
cookie?: never;
|
|
3011
3011
|
};
|
|
3012
3012
|
/**
|
|
3013
|
-
* Get request from default request queue
|
|
3013
|
+
* Get request from the default request queue of an Actor run
|
|
3014
3014
|
* @description Returns a request from the default request queue of the Actor run.
|
|
3015
3015
|
*
|
|
3016
3016
|
* This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
|
|
3017
|
-
* [Get request](https://docs.apify.com/api/v2/request-queue-request-get) endpoint.
|
|
3017
|
+
* [Get request from request queue](https://docs.apify.com/api/v2/request-queue-request-get) endpoint.
|
|
3018
3018
|
*/
|
|
3019
3019
|
get: operations["actorRun_requestQueue_request_get"];
|
|
3020
3020
|
/**
|
|
3021
|
-
* Update request in default request queue
|
|
3021
|
+
* Update request in the default request queue of an Actor run
|
|
3022
3022
|
* @description Updates a request in the default request queue of the Actor run.
|
|
3023
3023
|
*
|
|
3024
3024
|
* This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
|
|
3025
|
-
* [Update request](https://docs.apify.com/api/v2/request-queue-request-put) endpoint.
|
|
3025
|
+
* [Update request in request queue](https://docs.apify.com/api/v2/request-queue-request-put) endpoint.
|
|
3026
3026
|
*/
|
|
3027
3027
|
put: operations["actorRun_requestQueue_request_put"];
|
|
3028
3028
|
post?: never;
|
|
3029
3029
|
/**
|
|
3030
|
-
* Delete request from default request queue
|
|
3030
|
+
* Delete request from the default request queue of an Actor run
|
|
3031
3031
|
* @description Deletes a request from the default request queue of the Actor run.
|
|
3032
3032
|
*
|
|
3033
3033
|
* This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
|
|
3034
|
-
* [Delete request](https://docs.apify.com/api/v2/request-queue-request-delete) endpoint.
|
|
3034
|
+
* [Delete request from request queue](https://docs.apify.com/api/v2/request-queue-request-delete) endpoint.
|
|
3035
3035
|
*/
|
|
3036
3036
|
delete: operations["actorRun_requestQueue_request_delete"];
|
|
3037
3037
|
options?: never;
|
|
@@ -3048,20 +3048,20 @@ export interface paths {
|
|
|
3048
3048
|
};
|
|
3049
3049
|
get?: never;
|
|
3050
3050
|
/**
|
|
3051
|
-
* Prolong lock on request in default request queue
|
|
3051
|
+
* Prolong lock on request in the default request queue of an Actor run
|
|
3052
3052
|
* @description Prolongs a request lock in the default request queue of the Actor run.
|
|
3053
3053
|
*
|
|
3054
3054
|
* This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
|
|
3055
|
-
* [Prolong request
|
|
3055
|
+
* [Prolong lock on request in request queue](https://docs.apify.com/api/v2/request-queue-request-lock-put) endpoint.
|
|
3056
3056
|
*/
|
|
3057
3057
|
put: operations["actorRun_requestQueue_request_lock_put"];
|
|
3058
3058
|
post?: never;
|
|
3059
3059
|
/**
|
|
3060
|
-
* Delete lock on request in default request queue
|
|
3060
|
+
* Delete lock on request in the default request queue of an Actor run
|
|
3061
3061
|
* @description Deletes a request lock in the default request queue of the Actor run.
|
|
3062
3062
|
*
|
|
3063
3063
|
* This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
|
|
3064
|
-
* [Delete request
|
|
3064
|
+
* [Delete lock on request in request queue](https://docs.apify.com/api/v2/request-queue-request-lock-delete) endpoint.
|
|
3065
3065
|
*/
|
|
3066
3066
|
delete: operations["actorRun_requestQueue_request_lock_delete"];
|
|
3067
3067
|
options?: never;
|
|
@@ -3077,11 +3077,11 @@ export interface paths {
|
|
|
3077
3077
|
cookie?: never;
|
|
3078
3078
|
};
|
|
3079
3079
|
/**
|
|
3080
|
-
* Get default request queue head
|
|
3080
|
+
* Get the default request queue head for an Actor run
|
|
3081
3081
|
* @description Returns the given number of first requests from the default request queue of the Actor run.
|
|
3082
3082
|
*
|
|
3083
3083
|
* This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
|
|
3084
|
-
* [Get head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
3084
|
+
* [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
3085
3085
|
*/
|
|
3086
3086
|
get: operations["actorRun_requestQueue_head_get"];
|
|
3087
3087
|
put?: never;
|
|
@@ -3102,12 +3102,12 @@ export interface paths {
|
|
|
3102
3102
|
get?: never;
|
|
3103
3103
|
put?: never;
|
|
3104
3104
|
/**
|
|
3105
|
-
* Get and lock default request queue head
|
|
3105
|
+
* Get and lock the default request queue head for an Actor run
|
|
3106
3106
|
* @description Returns the given number of first requests from the default request queue of the Actor run
|
|
3107
3107
|
* and locks them for the given time.
|
|
3108
3108
|
*
|
|
3109
3109
|
* This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
|
|
3110
|
-
* [Get
|
|
3110
|
+
* [Get and lock request queue head](https://docs.apify.com/api/v2/request-queue-head-lock-post) endpoint.
|
|
3111
3111
|
*/
|
|
3112
3112
|
post: operations["actorRun_requestQueue_head_lock_post"];
|
|
3113
3113
|
delete?: never;
|
|
@@ -3124,10 +3124,10 @@ export interface paths {
|
|
|
3124
3124
|
cookie?: never;
|
|
3125
3125
|
};
|
|
3126
3126
|
/**
|
|
3127
|
-
* Get run
|
|
3127
|
+
* Get log of an Actor run
|
|
3128
3128
|
* @description Retrieves Actor run's logs.
|
|
3129
3129
|
*
|
|
3130
|
-
* This endpoint is a shortcut for getting the run's log. Same as [Get log](https://docs.apify.com/api/v2/log-get) endpoint.
|
|
3130
|
+
* This endpoint is a shortcut for getting the run's log. Same as [Get Actor build or run log](https://docs.apify.com/api/v2/log-get) endpoint.
|
|
3131
3131
|
*/
|
|
3132
3132
|
get: operations["actorRun_log_get"];
|
|
3133
3133
|
put?: never;
|
|
@@ -3146,7 +3146,7 @@ export interface paths {
|
|
|
3146
3146
|
cookie?: never;
|
|
3147
3147
|
};
|
|
3148
3148
|
/**
|
|
3149
|
-
* Get user builds
|
|
3149
|
+
* Get list of user's Actor builds
|
|
3150
3150
|
* @description Gets a list of all builds for a user. The response is a JSON array of
|
|
3151
3151
|
* objects, where each object contains basic information about a single build.
|
|
3152
3152
|
*
|
|
@@ -3175,7 +3175,7 @@ export interface paths {
|
|
|
3175
3175
|
cookie?: never;
|
|
3176
3176
|
};
|
|
3177
3177
|
/**
|
|
3178
|
-
* Get build
|
|
3178
|
+
* Get Actor build
|
|
3179
3179
|
* @description Gets an object that contains all the details about a specific build of an
|
|
3180
3180
|
* Actor.
|
|
3181
3181
|
*
|
|
@@ -3190,7 +3190,7 @@ export interface paths {
|
|
|
3190
3190
|
put?: never;
|
|
3191
3191
|
post?: never;
|
|
3192
3192
|
/**
|
|
3193
|
-
* Delete build
|
|
3193
|
+
* Delete Actor build
|
|
3194
3194
|
* @description Delete the build. The build that is the current default build for the Actor
|
|
3195
3195
|
* cannot be deleted.
|
|
3196
3196
|
*
|
|
@@ -3212,7 +3212,7 @@ export interface paths {
|
|
|
3212
3212
|
get?: never;
|
|
3213
3213
|
put?: never;
|
|
3214
3214
|
/**
|
|
3215
|
-
* Abort build
|
|
3215
|
+
* Abort Actor build
|
|
3216
3216
|
* @description Aborts an Actor build and returns an object that contains all the details
|
|
3217
3217
|
* about the build.
|
|
3218
3218
|
*
|
|
@@ -3234,10 +3234,10 @@ export interface paths {
|
|
|
3234
3234
|
cookie?: never;
|
|
3235
3235
|
};
|
|
3236
3236
|
/**
|
|
3237
|
-
* Get build's
|
|
3237
|
+
* Get Actor build's log
|
|
3238
3238
|
* @description Retrieves Actor build's logs.
|
|
3239
3239
|
*
|
|
3240
|
-
* This endpoint is a shortcut for getting the build's log. Same as [Get log](https://docs.apify.com/api/v2/log-get) endpoint.
|
|
3240
|
+
* This endpoint is a shortcut for getting the build's log. Same as [Get Actor build or run log](https://docs.apify.com/api/v2/log-get) endpoint.
|
|
3241
3241
|
*/
|
|
3242
3242
|
get: operations["actorBuild_log_get"];
|
|
3243
3243
|
put?: never;
|
|
@@ -3256,7 +3256,7 @@ export interface paths {
|
|
|
3256
3256
|
cookie?: never;
|
|
3257
3257
|
};
|
|
3258
3258
|
/**
|
|
3259
|
-
* Get OpenAPI definition
|
|
3259
|
+
* Get OpenAPI definition of Actor build
|
|
3260
3260
|
* @description Get the OpenAPI definition for Actor builds. Two similar endpoints are available:
|
|
3261
3261
|
*
|
|
3262
3262
|
* - [First endpoint](https://docs.apify.com/api/v2/actor-openapi-json-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.
|
|
@@ -3307,7 +3307,7 @@ export interface paths {
|
|
|
3307
3307
|
/**
|
|
3308
3308
|
* Create key-value store
|
|
3309
3309
|
* @description Creates a key-value store and returns its object. The response is the same
|
|
3310
|
-
* object as returned by the [Get store](
|
|
3310
|
+
* object as returned by the [Get key-value store](https://docs.apify.com/api/v2/key-value-store-get)
|
|
3311
3311
|
* endpoint.
|
|
3312
3312
|
*
|
|
3313
3313
|
* Keep in mind that data stored under unnamed store follows [data retention
|
|
@@ -3332,13 +3332,13 @@ export interface paths {
|
|
|
3332
3332
|
cookie?: never;
|
|
3333
3333
|
};
|
|
3334
3334
|
/**
|
|
3335
|
-
* Get store
|
|
3335
|
+
* Get key-value store
|
|
3336
3336
|
* @description Gets an object that contains all the details about a specific key-value
|
|
3337
3337
|
* store.
|
|
3338
3338
|
*/
|
|
3339
3339
|
get: operations["keyValueStore_get"];
|
|
3340
3340
|
/**
|
|
3341
|
-
* Update store
|
|
3341
|
+
* Update key-value store
|
|
3342
3342
|
* @description Updates a key-value store's name and general resource access level using a value specified by a JSON object
|
|
3343
3343
|
* passed in the PUT payload.
|
|
3344
3344
|
*
|
|
@@ -3348,7 +3348,7 @@ export interface paths {
|
|
|
3348
3348
|
put: operations["keyValueStore_put"];
|
|
3349
3349
|
post?: never;
|
|
3350
3350
|
/**
|
|
3351
|
-
* Delete store
|
|
3351
|
+
* Delete key-value store
|
|
3352
3352
|
* @description Deletes a key-value store.
|
|
3353
3353
|
*/
|
|
3354
3354
|
delete: operations["keyValueStore_delete"];
|
|
@@ -3365,7 +3365,7 @@ export interface paths {
|
|
|
3365
3365
|
cookie?: never;
|
|
3366
3366
|
};
|
|
3367
3367
|
/**
|
|
3368
|
-
* Get list of keys
|
|
3368
|
+
* Get list of key-value store keys
|
|
3369
3369
|
* @description Returns a list of objects describing keys of a given key-value store, as
|
|
3370
3370
|
* well as some information about the values (e.g. size).
|
|
3371
3371
|
*
|
|
@@ -3389,7 +3389,7 @@ export interface paths {
|
|
|
3389
3389
|
cookie?: never;
|
|
3390
3390
|
};
|
|
3391
3391
|
/**
|
|
3392
|
-
* Download records
|
|
3392
|
+
* Download key-value store records
|
|
3393
3393
|
* @description Downloads all records from the key-value store as a ZIP archive.
|
|
3394
3394
|
* Each record is stored as a separate file in the archive, with the filename equal to the record key.
|
|
3395
3395
|
*
|
|
@@ -3412,7 +3412,7 @@ export interface paths {
|
|
|
3412
3412
|
cookie?: never;
|
|
3413
3413
|
};
|
|
3414
3414
|
/**
|
|
3415
|
-
* Get record
|
|
3415
|
+
* Get key-value store record
|
|
3416
3416
|
* @description Gets a value stored in the key-value store under a specific key.
|
|
3417
3417
|
*
|
|
3418
3418
|
* The response body has the same `Content-Encoding` header as it was set in
|
|
@@ -3431,7 +3431,7 @@ export interface paths {
|
|
|
3431
3431
|
*/
|
|
3432
3432
|
get: operations["keyValueStore_record_get"];
|
|
3433
3433
|
/**
|
|
3434
|
-
*
|
|
3434
|
+
* Set key-value store record
|
|
3435
3435
|
* @description Stores a value under a specific key to the key-value store.
|
|
3436
3436
|
*
|
|
3437
3437
|
* The value is passed as the PUT payload and it is stored with a MIME content
|
|
@@ -3451,20 +3451,20 @@ export interface paths {
|
|
|
3451
3451
|
*/
|
|
3452
3452
|
put: operations["keyValueStore_record_put"];
|
|
3453
3453
|
/**
|
|
3454
|
-
*
|
|
3454
|
+
* Set key-value store record (POST)
|
|
3455
3455
|
* @description Stores a value under a specific key to the key-value store.
|
|
3456
3456
|
*
|
|
3457
3457
|
* This endpoint is an alias for the [`PUT` record](#tag/Key-value-storesRecord/operation/keyValueStore_record_put) method and behaves identically.
|
|
3458
3458
|
*/
|
|
3459
3459
|
post: operations["keyValueStore_record_post"];
|
|
3460
3460
|
/**
|
|
3461
|
-
* Delete record
|
|
3461
|
+
* Delete key-value store record
|
|
3462
3462
|
* @description Removes a record specified by a key from the key-value store.
|
|
3463
3463
|
*/
|
|
3464
3464
|
delete: operations["keyValueStore_record_delete"];
|
|
3465
3465
|
options?: never;
|
|
3466
3466
|
/**
|
|
3467
|
-
* Check if
|
|
3467
|
+
* Check if key-value store record exists
|
|
3468
3468
|
* @description Check if a value is stored in the key-value store under a specific key.
|
|
3469
3469
|
*/
|
|
3470
3470
|
head: operations["keyValueStore_record_head"];
|
|
@@ -3709,7 +3709,7 @@ export interface paths {
|
|
|
3709
3709
|
get: operations["dataset_items_get"];
|
|
3710
3710
|
put?: never;
|
|
3711
3711
|
/**
|
|
3712
|
-
* Store items
|
|
3712
|
+
* Store items in dataset
|
|
3713
3713
|
* @description Appends an item or an array of items to the end of the dataset.
|
|
3714
3714
|
* The POST payload is a JSON object or a JSON array of objects to save into the dataset.
|
|
3715
3715
|
*
|
|
@@ -3841,7 +3841,7 @@ export interface paths {
|
|
|
3841
3841
|
get?: never;
|
|
3842
3842
|
put?: never;
|
|
3843
3843
|
/**
|
|
3844
|
-
*
|
|
3844
|
+
* Batch add requests to request queue
|
|
3845
3845
|
* @description Adds requests to the queue in batch. The maximum requests in batch is limited
|
|
3846
3846
|
* to 25. The response contains an array of unprocessed and processed requests.
|
|
3847
3847
|
* If any add operation fails because the request queue rate limit is exceeded
|
|
@@ -3855,7 +3855,7 @@ export interface paths {
|
|
|
3855
3855
|
*/
|
|
3856
3856
|
post: operations["requestQueue_requests_batch_post"];
|
|
3857
3857
|
/**
|
|
3858
|
-
*
|
|
3858
|
+
* Batch delete requests from request queue
|
|
3859
3859
|
* @description Batch-deletes given requests from the queue. The number of requests in a
|
|
3860
3860
|
* batch is limited to 25. The response contains an array of unprocessed and
|
|
3861
3861
|
* processed requests.
|
|
@@ -3884,7 +3884,7 @@ export interface paths {
|
|
|
3884
3884
|
get?: never;
|
|
3885
3885
|
put?: never;
|
|
3886
3886
|
/**
|
|
3887
|
-
* Unlock requests
|
|
3887
|
+
* Unlock requests in request queue
|
|
3888
3888
|
* @description Unlocks requests in the queue that are currently locked by the client.
|
|
3889
3889
|
*
|
|
3890
3890
|
* * If the client is within an Actor run, it unlocks all requests locked by that specific run plus all requests locked by the same clientKey.
|
|
@@ -3905,14 +3905,14 @@ export interface paths {
|
|
|
3905
3905
|
cookie?: never;
|
|
3906
3906
|
};
|
|
3907
3907
|
/**
|
|
3908
|
-
* List requests
|
|
3908
|
+
* List requests in request queue
|
|
3909
3909
|
* @description Returns a list of requests. This endpoint is paginated using
|
|
3910
3910
|
* cursor (pagination by `exclusiveStartId` is deprecated) and limit parameters.
|
|
3911
3911
|
*/
|
|
3912
3912
|
get: operations["requestQueue_requests_get"];
|
|
3913
3913
|
put?: never;
|
|
3914
3914
|
/**
|
|
3915
|
-
* Add request
|
|
3915
|
+
* Add request to request queue
|
|
3916
3916
|
* @description Adds request to the queue. Response contains ID of the request and info if
|
|
3917
3917
|
* request was already present in the queue or handled.
|
|
3918
3918
|
*
|
|
@@ -3934,12 +3934,12 @@ export interface paths {
|
|
|
3934
3934
|
cookie?: never;
|
|
3935
3935
|
};
|
|
3936
3936
|
/**
|
|
3937
|
-
* Get request
|
|
3937
|
+
* Get request from request queue
|
|
3938
3938
|
* @description Returns request from queue.
|
|
3939
3939
|
*/
|
|
3940
3940
|
get: operations["requestQueue_request_get"];
|
|
3941
3941
|
/**
|
|
3942
|
-
* Update request
|
|
3942
|
+
* Update request in request queue
|
|
3943
3943
|
* @description Updates a request in a queue. Mark request as handled by setting
|
|
3944
3944
|
* `request.handledAt = new Date()`.
|
|
3945
3945
|
* If `handledAt` is set, the request will be removed from head of the queue (and unlocked, if applicable).
|
|
@@ -3947,7 +3947,7 @@ export interface paths {
|
|
|
3947
3947
|
put: operations["requestQueue_request_put"];
|
|
3948
3948
|
post?: never;
|
|
3949
3949
|
/**
|
|
3950
|
-
* Delete request
|
|
3950
|
+
* Delete request from request queue
|
|
3951
3951
|
* @description Deletes given request from queue.
|
|
3952
3952
|
*/
|
|
3953
3953
|
delete: operations["requestQueue_request_delete"];
|
|
@@ -3964,7 +3964,7 @@ export interface paths {
|
|
|
3964
3964
|
cookie?: never;
|
|
3965
3965
|
};
|
|
3966
3966
|
/**
|
|
3967
|
-
* Get head
|
|
3967
|
+
* Get request queue head
|
|
3968
3968
|
* @description Returns given number of first requests from the queue.
|
|
3969
3969
|
*
|
|
3970
3970
|
* The response contains the `hadMultipleClients` boolean field which indicates
|
|
@@ -3993,7 +3993,7 @@ export interface paths {
|
|
|
3993
3993
|
get?: never;
|
|
3994
3994
|
put?: never;
|
|
3995
3995
|
/**
|
|
3996
|
-
* Get
|
|
3996
|
+
* Get and lock request queue head
|
|
3997
3997
|
* @description Returns the given number of first requests from the queue and locks them for
|
|
3998
3998
|
* the given time.
|
|
3999
3999
|
*
|
|
@@ -4020,7 +4020,7 @@ export interface paths {
|
|
|
4020
4020
|
};
|
|
4021
4021
|
get?: never;
|
|
4022
4022
|
/**
|
|
4023
|
-
* Prolong request
|
|
4023
|
+
* Prolong lock on request in request queue
|
|
4024
4024
|
* @description Prolongs request lock. The request lock can be prolonged only by the client
|
|
4025
4025
|
* that has locked it using [Get and lock head
|
|
4026
4026
|
* operation](#/request-queue-head-lock-post).
|
|
@@ -4031,7 +4031,7 @@ export interface paths {
|
|
|
4031
4031
|
put: operations["requestQueue_request_lock_put"];
|
|
4032
4032
|
post?: never;
|
|
4033
4033
|
/**
|
|
4034
|
-
* Delete request
|
|
4034
|
+
* Delete lock on request in request queue
|
|
4035
4035
|
* @description Deletes a request lock. The request lock can be deleted only by the client
|
|
4036
4036
|
* that has locked it using [Get and lock head
|
|
4037
4037
|
* operation](#/request-queue-head-lock-post).
|
|
@@ -4193,7 +4193,7 @@ export interface paths {
|
|
|
4193
4193
|
cookie?: never;
|
|
4194
4194
|
};
|
|
4195
4195
|
/**
|
|
4196
|
-
* Get
|
|
4196
|
+
* Get list of webhook's dispatches
|
|
4197
4197
|
* @description Gets a given webhook's list of dispatches.
|
|
4198
4198
|
*/
|
|
4199
4199
|
get: operations["webhook_webhookDispatches_get"];
|
|
@@ -4384,7 +4384,7 @@ export interface paths {
|
|
|
4384
4384
|
cookie?: never;
|
|
4385
4385
|
};
|
|
4386
4386
|
/**
|
|
4387
|
-
* Get log
|
|
4387
|
+
* Get Actor build or run log
|
|
4388
4388
|
* @description Retrieves logs for a specific Actor build or run.
|
|
4389
4389
|
*/
|
|
4390
4390
|
get: operations["log_get"];
|
|
@@ -4452,7 +4452,7 @@ export interface paths {
|
|
|
4452
4452
|
cookie?: never;
|
|
4453
4453
|
};
|
|
4454
4454
|
/**
|
|
4455
|
-
* Get monthly usage
|
|
4455
|
+
* Get user's monthly usage
|
|
4456
4456
|
* @description Returns a complete summary of your usage for the current monthly usage cycle,
|
|
4457
4457
|
* an overall sum, as well as a daily breakdown of usage. It is the same
|
|
4458
4458
|
* information you will see on your account's [Billing > Historical usage page](https://console.apify.com/billing/historical-usage). The information
|
|
@@ -4478,14 +4478,14 @@ export interface paths {
|
|
|
4478
4478
|
cookie?: never;
|
|
4479
4479
|
};
|
|
4480
4480
|
/**
|
|
4481
|
-
* Get limits
|
|
4481
|
+
* Get user's limits
|
|
4482
4482
|
* @description Returns a complete summary of your account's limits. It is the same
|
|
4483
4483
|
* information you will see on your account's [Limits page](https://console.apify.com/billing#/limits). The returned data
|
|
4484
4484
|
* includes the current usage cycle, a summary of your limits, and your current usage.
|
|
4485
4485
|
*/
|
|
4486
4486
|
get: operations["users_me_limits_get"];
|
|
4487
4487
|
/**
|
|
4488
|
-
* Update limits
|
|
4488
|
+
* Update user's limits
|
|
4489
4489
|
* @description Updates the account's limits manageable on your account's [Limits page](https://console.apify.com/billing#/limits).
|
|
4490
4490
|
* Specifically the: `maxMonthlyUsageUsd` and `dataRetentionDays` limits (see request body schema for more details).
|
|
4491
4491
|
*/
|
|
@@ -4515,7 +4515,7 @@ export interface paths {
|
|
|
4515
4515
|
*/
|
|
4516
4516
|
get: operations["tools_browser_info_get"];
|
|
4517
4517
|
/**
|
|
4518
|
-
* Get browser info
|
|
4518
|
+
* Get browser info (PUT)
|
|
4519
4519
|
* @description Returns information about the HTTP request, including the client IP address,
|
|
4520
4520
|
* country code, request headers, and body length.
|
|
4521
4521
|
*
|
|
@@ -4525,7 +4525,7 @@ export interface paths {
|
|
|
4525
4525
|
*/
|
|
4526
4526
|
put: operations["tools_browser_info_put"];
|
|
4527
4527
|
/**
|
|
4528
|
-
* Get browser info
|
|
4528
|
+
* Get browser info (POST)
|
|
4529
4529
|
* @description Returns information about the HTTP request, including the client IP address,
|
|
4530
4530
|
* country code, request headers, and body length.
|
|
4531
4531
|
*
|
|
@@ -4535,7 +4535,7 @@ export interface paths {
|
|
|
4535
4535
|
*/
|
|
4536
4536
|
post: operations["tools_browser_info_post"];
|
|
4537
4537
|
/**
|
|
4538
|
-
* Get browser info
|
|
4538
|
+
* Get browser info (DELETE)
|
|
4539
4539
|
* @description Returns information about the HTTP request, including the client IP address,
|
|
4540
4540
|
* country code, request headers, and body length.
|
|
4541
4541
|
*
|
|
@@ -4762,7 +4762,7 @@ export interface components {
|
|
|
4762
4762
|
* @description Machine-processable error type identifier.
|
|
4763
4763
|
* @enum {string}
|
|
4764
4764
|
*/
|
|
4765
|
-
ErrorType: "3d-secure-auth-failed" | "access-right-already-exists" | "action-not-found" | "actor-already-rented" | "actor-can-not-be-rented" | "actor-disabled" | "actor-is-not-rented" | "actor-memory-limit-exceeded" | "actor-name-exists-new-owner" | "actor-name-not-unique" | "actor-not-found" | "actor-not-github-actor" | "actor-not-public" | "actor-permission-level-not-supported-for-agentic-payments" | "actor-review-already-exists" | "actor-run-failed" | "actor-standby-not-supported-for-agentic-payments" | "actor-task-name-not-unique" | "agentic-payment-info-retrieval-error" | "agentic-payment-information-missing" | "agentic-payment-insufficient-amount" | "agentic-payment-provider-internal-error" | "agentic-payment-provider-unauthorized" | "airtable-webhook-deprecated" | "already-subscribed-to-paid-actor" | "apify-plan-required-to-use-paid-actor" | "apify-signup-not-allowed" | "auth-method-not-supported" | "authorization-server-not-found" | "auto-issue-date-invalid" | "background-check-required" | "billing-system-error" | "black-friday-plan-expired" | "braintree-error" | "braintree-not-linked" | "braintree-operation-timed-out" | "braintree-unsupported-currency" | "build-not-found" | "build-outdated" | "cannot-add-apify-events-to-ppe-actor" | "cannot-add-multiple-pricing-infos" | "cannot-add-pricing-info-that-alters-past" | "cannot-add-second-future-pricing-info" | "cannot-build-actor-from-webhook" | "cannot-change-billing-interval" | "cannot-change-owner" | "cannot-charge-apify-event" | "cannot-charge-non-pay-per-event-actor" | "cannot-comment-as-other-user" | "cannot-copy-actor-task" | "cannot-create-payout" | "cannot-create-public-actor" | "cannot-create-tax-transaction" | "cannot-delete-critical-actor" | "cannot-delete-invoice" | "cannot-delete-paid-actor" | "cannot-disable-one-time-event-for-apify-start-event" | "cannot-disable-organization-with-enabled-members" | "cannot-disable-user-with-subscription" | "cannot-link-oauth-to-unverified-email" | "cannot-metamorph-to-pay-per-result-actor" | "cannot-modify-actor-pricing-too-frequently" | "cannot-modify-actor-pricing-with-immediate-effect" | "cannot-monetize-without-payout-billing-info" | "cannot-override-paid-actor-trial" | "cannot-permanently-delete-subscription" | "cannot-publish-actor" | "cannot-publish-actor-task" | "cannot-reduce-last-full-token" | "cannot-reimburse-more-than-original-charge" | "cannot-reimburse-non-rental-charge" | "cannot-remove-own-actor-from-recently-used" | "cannot-remove-payment-method" | "cannot-remove-pricing-info" | "cannot-remove-running-run" | "cannot-remove-user-with-public-actors" | "cannot-remove-user-with-subscription" | "cannot-remove-user-with-unpaid-invoice" | "cannot-rename-env-var" | "cannot-rent-paid-actor" | "cannot-review-own-actor" | "cannot-set-access-rights-for-owner" | "cannot-set-is-status-message-terminal" | "cannot-unpublish-critical-actor" | "cannot-unpublish-paid-actor" | "cannot-unpublish-profile" | "cannot-update-invoice-field" | "concurrent-runs-limit-exceeded" | "concurrent-update-detected" | "conference-token-not-found" | "content-encoding-forbidden-for-html" | "coupon-already-redeemed" | "coupon-expired" | "coupon-for-new-customers" | "coupon-for-subscribed-users" | "coupon-limits-are-in-conflict-with-current-limits" | "coupon-max-number-of-redemptions-reached" | "coupon-not-found" | "coupon-not-unique" | "coupons-disabled" | "create-github-issue-not-allowed" | "creator-plan-not-available" | "cron-expression-invalid" | "daily-ai-token-limit-exceeded" | "daily-publication-limit-exceeded" | "dataset-does-not-have-fields-schema" | "dataset-does-not-have-schema" | "dataset-locked" | "dataset-schema-invalid" | "dcr-not-supported" | "default-dataset-not-found" | "deleting-default-build" | "deleting-unfinished-build" | "email-already-taken" | "email-already-taken-removed-user" | "email-domain-not-allowed-for-coupon" | "email-invalid" | "email-not-allowed" | "email-not-valid" | "email-update-too-soon" | "elevated-permissions-needed" | "env-var-already-exists" | "exchange-rate-fetch-failed" | "expired-conference-token" | "failed-to-charge-user" | "final-invoice-negative" | "full-permission-actor-blocked-for-admin" | "full-permission-actor-not-approved" | "github-branch-empty" | "github-issue-already-exists" | "github-public-key-not-found" | "github-repository-not-found" | "github-signature-does-not-match-payload" | "github-user-not-authorized-for-issues" | "gmail-not-allowed" | "id-does-not-match" | "incompatible-billing-interval" | "incomplete-payout-billing-info" | "inconsistent-currencies" | "incorrect-pricing-modifier-prefix" | "input-json-invalid-characters" | "input-json-not-object" | "input-json-too-long" | "input-update-collision" | "insufficient-permissions" | "insufficient-permissions-to-change-field" | "insufficient-security-measures" | "insufficient-tax-country-evidence" | "integration-auth-error" | "internal-server-error" | "invalid-billing-info" | "invalid-billing-period-for-payout" | "invalid-build" | "invalid-client-key" | "invalid-collection" | "invalid-conference-login-password" | "invalid-content-type-header" | "invalid-credentials" | "invalid-git-auth-token" | "invalid-github-issue-url" | "invalid-header" | "invalid-id" | "invalid-idempotency-key" | "invalid-input" | "invalid-input-schema" | "invalid-invoice" | "invalid-invoice-type" | "invalid-issue-date" | "invalid-label-params" | "invalid-main-account-user-id" | "invalid-oauth-app" | "invalid-oauth-scope" | "invalid-one-time-invoice" | "invalid-parameter" | "invalid-payout-status" | "invalid-picture-url" | "invalid-record-key" | "invalid-request" | "invalid-resource-type" | "invalid-signature" | "invalid-subscription-plan" | "invalid-tax-number" | "invalid-tax-number-format" | "invalid-token" | "invalid-token-type" | "invalid-two-factor-code" | "invalid-two-factor-code-or-recovery-code" | "invalid-two-factor-recovery-code" | "invalid-username" | "invalid-value" | "invitation-invalid-resource-type" | "invitation-no-longer-valid" | "invoice-canceled" | "invoice-cannot-be-refunded-due-to-too-high-amount" | "invoice-incomplete" | "invoice-is-draft" | "invoice-locked" | "invoice-must-be-buffer" | "invoice-not-canceled" | "invoice-not-draft" | "invoice-not-found" | "invoice-outdated" | "invoice-paid-already" | "issue-already-connected-to-github" | "issue-not-found" | "issues-bad-request" | "issuer-not-registered" | "job-finished" | "label-already-linked" | "last-api-token" | "limit-reached" | "max-items-must-be-greater-than-zero" | "max-metamorphs-exceeded" | "max-total-charge-usd-below-minimum" | "max-total-charge-usd-must-be-greater-than-zero" | "method-not-allowed" | "migration-disabled" | "missing-actor-rights" | "missing-api-token" | "missing-billing-info" | "missing-line-items" | "missing-payment-date" | "missing-payout-billing-info" | "missing-proxy-password" | "missing-reporting-fields" | "missing-resource-name" | "missing-settings" | "missing-username" | "monthly-usage-limit-too-low" | "more-than-one-update-not-allowed" | "multiple-records-found" | "must-be-admin" | "name-not-unique" | "next-runtime-computation-failed" | "no-columns-in-exported-dataset" | "no-payment-attempt-for-refund-found" | "no-payment-method-available" | "no-team-account-seats-available" | "non-temporary-email" | "not-enough-usage-to-run-paid-actor" | "not-implemented" | "not-supported-currencies" | "o-auth-service-already-connected" | "o-auth-service-not-connected" | "oauth-resource-access-failed" | "one-time-invoice-already-marked-paid" | "only-drafts-can-be-deleted" | "operation-canceled" | "operation-not-allowed" | "operation-timed-out" | "organization-cannot-own-itself" | "organization-role-not-found" | "overlapping-payout-billing-periods" | "own-token-required" | "page-not-found" | "param-not-one-of" | "parameter-required" | "parameters-mismatched" | "password-reset-email-already-sent" | "password-reset-token-expired" | "pay-as-you-go-without-monthly-interval" | "payment-attempt-status-message-required" | "payout-already-paid" | "payout-canceled" | "payout-invalid-state" | "payout-must-be-approved-to-be-marked-paid" | "payout-not-found" | "payout-number-already-exists" | "phone-number-invalid" | "phone-number-landline" | "phone-number-opted-out" | "phone-verification-disabled" | "platform-feature-disabled" | "price-overrides-validation-failed" | "pricing-model-not-supported" | "promotional-plan-not-available" | "proxy-auth-ip-not-unique" | "public-actor-disabled" | "query-timeout" | "quoted-price-outdated" | "rate-limit-exceeded" | "recaptcha-invalid" | "recaptcha-required" | "record-not-found" | "record-not-public" | "record-or-token-not-found" | "record-too-large" | "redirect-uri-mismatch" | "reduced-plan-not-available" | "rental-charge-already-reimbursed" | "rental-not-allowed" | "request-aborted-prematurely" | "request-handled-or-locked" | "request-id-invalid" | "request-queue-duplicate-requests" | "request-too-large" | "requested-dataset-view-does-not-exist" | "resume-token-expired" | "run-failed" | "run-input-body-not-valid-json" | "run-timeout-exceeded" | "russia-is-evil" | "same-user" | "schedule-actor-not-found" | "schedule-actor-task-not-found" | "schedule-name-not-unique" | "schema-validation" | "schema-validation-error" | "schema-validation-failed" | "service-worker-registration-not-allowed" | "sign-up-method-not-allowed" | "slack-integration-not-custom" | "socket-closed" | "socket-destroyed" | "store-schema-invalid" | "store-terms-not-accepted" | "stripe-enabled" | "stripe-generic-decline" | "stripe-not-enabled" | "stripe-not-enabled-for-user" | "tagged-build-required" | "tax-country-invalid" | "tax-number-invalid" | "tax-number-validation-failed" | "taxamo-call-failed" | "taxamo-request-failed" | "testing-error" | "token-not-provided" | "too-few-versions" | "too-many-actor-tasks" | "too-many-actors" | "too-many-labels-on-resource" | "too-many-mcp-connectors" | "too-many-o-auth-apps" | "too-many-organizations" | "too-many-requests" | "too-many-schedules" | "too-many-ui-access-keys" | "too-many-user-labels" | "too-many-values" | "too-many-versions" | "too-many-webhooks" | "unexpected-route" | "unknown-build-tag" | "unknown-payment-provider" | "unsubscribe-token-invalid" | "unsupported-actor-pricing-model-for-agentic-payments" | "unsupported-content-encoding" | "unsupported-file-type-for-issue" | "unsupported-file-type-image-expected" | "unsupported-file-type-text-or-json-expected" | "unsupported-permission" | "upcoming-subscription-bill-not-up-to-date" | "user-already-exists" | "user-already-verified" | "user-creates-organizations-too-fast" | "user-disabled" | "user-email-is-disposable" | "user-email-not-set" | "user-email-not-verified" | "user-has-no-subscription" | "user-integration-not-found" | "user-is-already-invited" | "user-is-already-organization-member" | "user-is-not-member-of-organization" | "user-is-not-organization" | "user-is-organization" | "user-is-organization-owner" | "user-is-removed" | "user-not-found" | "user-not-logged-in" | "user-not-verified" | "user-or-token-not-found" | "user-plan-not-allowed-for-coupon" | "user-problem-with-card" | "user-record-not-found" | "username-already-taken" | "username-missing" | "username-not-allowed" | "username-removal-forbidden" | "username-required" | "verification-email-already-sent" | "verification-token-expired" | "version-already-exists" | "versions-size-exceeded" | "weak-password" | "x402-agentic-payment-already-finalized" | "x402-agentic-payment-insufficient-amount" | "x402-agentic-payment-malformed-token" | "x402-agentic-payment-settlement-failed" | "x402-agentic-payment-settlement-in-progress" | "x402-agentic-payment-settlement-stuck" | "x402-agentic-payment-unauthorized" | "x402-payment-required" | "zero-invoice";
|
|
4765
|
+
ErrorType: "3d-secure-auth-failed" | "access-right-already-exists" | "action-not-found" | "actor-already-rented" | "actor-can-not-be-rented" | "actor-disabled" | "actor-is-not-rented" | "actor-memory-limit-exceeded" | "actor-name-exists-new-owner" | "actor-name-not-unique" | "actor-not-found" | "actor-not-github-actor" | "actor-not-public" | "actor-permission-level-not-supported-for-agentic-payments" | "actor-review-already-exists" | "actor-run-failed" | "actor-standby-not-supported-for-agentic-payments" | "actor-task-name-not-unique" | "agentic-payment-info-retrieval-error" | "agentic-payment-information-missing" | "agentic-payment-insufficient-amount" | "agentic-payment-provider-internal-error" | "agentic-payment-provider-unauthorized" | "airtable-webhook-deprecated" | "already-subscribed-to-paid-actor" | "apify-plan-required-to-use-paid-actor" | "apify-signup-not-allowed" | "auth-method-not-supported" | "authorization-server-not-found" | "auto-issue-date-invalid" | "background-check-required" | "billing-system-error" | "black-friday-plan-expired" | "braintree-error" | "braintree-not-linked" | "braintree-operation-timed-out" | "braintree-unsupported-currency" | "build-not-found" | "build-outdated" | "cannot-add-apify-events-to-ppe-actor" | "cannot-add-multiple-pricing-infos" | "cannot-add-pricing-info-that-alters-past" | "cannot-add-second-future-pricing-info" | "cannot-build-actor-from-webhook" | "cannot-change-billing-interval" | "cannot-change-owner" | "cannot-charge-apify-event" | "cannot-charge-non-pay-per-event-actor" | "cannot-comment-as-other-user" | "cannot-copy-actor-task" | "cannot-create-payout" | "cannot-create-public-actor" | "cannot-create-tax-transaction" | "cannot-delete-critical-actor" | "cannot-delete-invoice" | "cannot-delete-paid-actor" | "cannot-disable-one-time-event-for-apify-start-event" | "cannot-disable-organization-with-enabled-members" | "cannot-disable-user-with-subscription" | "cannot-link-oauth-to-unverified-email" | "cannot-metamorph-to-pay-per-result-actor" | "cannot-modify-actor-pricing-too-frequently" | "cannot-modify-actor-pricing-with-immediate-effect" | "cannot-monetize-without-payout-billing-info" | "cannot-override-paid-actor-trial" | "cannot-permanently-delete-subscription" | "cannot-publish-actor" | "cannot-publish-actor-task" | "cannot-reduce-last-full-token" | "cannot-reimburse-more-than-original-charge" | "cannot-reimburse-non-rental-charge" | "cannot-remove-own-actor-from-recently-used" | "cannot-remove-payment-method" | "cannot-remove-pricing-info" | "cannot-remove-running-run" | "cannot-remove-user-with-public-actors" | "cannot-remove-user-with-subscription" | "cannot-remove-user-with-unpaid-invoice" | "cannot-rename-env-var" | "cannot-rent-paid-actor" | "cannot-review-own-actor" | "cannot-set-access-rights-for-owner" | "cannot-set-is-status-message-terminal" | "cannot-unpublish-critical-actor" | "cannot-unpublish-paid-actor" | "cannot-unpublish-profile" | "cannot-update-invoice-field" | "concurrent-runs-limit-exceeded" | "concurrent-update-detected" | "conference-token-not-found" | "content-encoding-forbidden-for-html" | "coupon-already-redeemed" | "coupon-expired" | "coupon-for-new-customers" | "coupon-for-subscribed-users" | "coupon-limits-are-in-conflict-with-current-limits" | "coupon-max-number-of-redemptions-reached" | "coupon-not-found" | "coupon-not-unique" | "coupons-disabled" | "create-github-issue-not-allowed" | "creator-plan-not-available" | "cron-expression-invalid" | "daily-ai-token-limit-exceeded" | "daily-publication-limit-exceeded" | "dataset-does-not-have-fields-schema" | "dataset-does-not-have-schema" | "dataset-locked" | "dataset-schema-invalid" | "dcr-not-supported" | "default-dataset-not-found" | "deleting-default-build" | "deleting-unfinished-build" | "email-already-taken" | "email-already-taken-removed-user" | "email-domain-not-allowed-for-coupon" | "email-invalid" | "email-not-allowed" | "email-not-valid" | "email-update-too-soon" | "elevated-permissions-needed" | "env-var-already-exists" | "exchange-rate-fetch-failed" | "expired-conference-token" | "failed-to-charge-user" | "final-invoice-negative" | "full-permission-actor-blocked-for-admin" | "full-permission-actor-not-approved" | "full-permissions-require-verified-owner" | "github-branch-empty" | "github-issue-already-exists" | "github-public-key-not-found" | "github-repository-not-found" | "github-signature-does-not-match-payload" | "github-user-not-authorized-for-issues" | "gmail-not-allowed" | "id-does-not-match" | "incompatible-billing-interval" | "incomplete-payout-billing-info" | "inconsistent-currencies" | "incorrect-pricing-modifier-prefix" | "input-json-invalid-characters" | "input-json-not-object" | "input-json-too-long" | "input-update-collision" | "input-validation-timed-out" | "insufficient-permissions" | "insufficient-permissions-to-change-field" | "insufficient-security-measures" | "insufficient-tax-country-evidence" | "integration-auth-error" | "internal-server-error" | "invalid-billing-info" | "invalid-billing-period-for-payout" | "invalid-build" | "invalid-client-key" | "invalid-collection" | "invalid-conference-login-password" | "invalid-content-type-header" | "invalid-credentials" | "invalid-git-auth-token" | "invalid-github-issue-url" | "invalid-header" | "invalid-id" | "invalid-idempotency-key" | "invalid-input" | "invalid-input-schema" | "invalid-invoice" | "invalid-invoice-type" | "invalid-issue-date" | "invalid-label-params" | "invalid-main-account-user-id" | "invalid-oauth-app" | "invalid-oauth-scope" | "invalid-one-time-invoice" | "invalid-parameter" | "invalid-payout-status" | "invalid-picture-url" | "invalid-record-key" | "invalid-request" | "invalid-resource-type" | "invalid-signature" | "invalid-subscription-plan" | "invalid-tax-number" | "invalid-tax-number-format" | "invalid-token" | "invalid-token-type" | "invalid-two-factor-code" | "invalid-two-factor-code-or-recovery-code" | "invalid-two-factor-recovery-code" | "invalid-username" | "invalid-value" | "invitation-invalid-resource-type" | "invitation-no-longer-valid" | "invoice-canceled" | "invoice-cannot-be-refunded-due-to-too-high-amount" | "invoice-incomplete" | "invoice-is-draft" | "invoice-locked" | "invoice-must-be-buffer" | "invoice-not-canceled" | "invoice-not-draft" | "invoice-not-found" | "invoice-outdated" | "invoice-paid-already" | "issue-already-connected-to-github" | "issue-not-found" | "issues-bad-request" | "issuer-not-registered" | "job-finished" | "label-already-linked" | "last-api-token" | "limit-reached" | "max-items-must-be-greater-than-zero" | "max-metamorphs-exceeded" | "max-total-charge-usd-below-minimum" | "max-total-charge-usd-must-be-greater-than-zero" | "mcp-connector-actor-not-allowed" | "method-not-allowed" | "migration-disabled" | "missing-actor-rights" | "missing-api-token" | "missing-billing-info" | "missing-line-items" | "missing-payment-date" | "missing-payout-billing-info" | "missing-proxy-password" | "missing-reporting-fields" | "missing-resource-name" | "missing-settings" | "missing-username" | "monthly-usage-limit-too-low" | "more-public-actors-require-verified-owner" | "more-than-one-update-not-allowed" | "multiple-records-found" | "must-be-admin" | "name-not-unique" | "next-runtime-computation-failed" | "no-columns-in-exported-dataset" | "no-payment-attempt-for-refund-found" | "no-payment-method-available" | "no-team-account-seats-available" | "non-temporary-email" | "not-enough-usage-to-run-paid-actor" | "not-implemented" | "not-supported-currencies" | "o-auth-service-already-connected" | "o-auth-service-not-connected" | "oauth-resource-access-failed" | "one-time-invoice-already-marked-paid" | "only-drafts-can-be-deleted" | "operation-canceled" | "operation-not-allowed" | "operation-timed-out" | "organization-cannot-own-itself" | "organization-role-not-found" | "overlapping-payout-billing-periods" | "own-token-required" | "page-not-found" | "param-not-one-of" | "parameter-required" | "parameters-mismatched" | "password-reset-email-already-sent" | "password-reset-token-expired" | "pay-as-you-go-without-monthly-interval" | "payment-attempt-status-message-required" | "payout-already-paid" | "payout-canceled" | "payout-invalid-state" | "payout-must-be-approved-to-be-marked-paid" | "payout-not-found" | "payout-number-already-exists" | "phone-number-invalid" | "phone-number-landline" | "phone-number-opted-out" | "phone-verification-disabled" | "platform-feature-disabled" | "price-overrides-validation-failed" | "pricing-model-not-supported" | "promotional-plan-not-available" | "proxy-auth-ip-not-unique" | "public-actor-disabled" | "query-timeout" | "quoted-price-outdated" | "rate-limit-exceeded" | "readme-required" | "recaptcha-invalid" | "recaptcha-required" | "record-not-found" | "record-not-public" | "record-or-token-not-found" | "record-too-large" | "redirect-uri-mismatch" | "reduced-plan-not-available" | "rental-charge-already-reimbursed" | "rental-not-allowed" | "request-aborted-prematurely" | "request-handled-or-locked" | "request-id-invalid" | "request-queue-duplicate-requests" | "request-too-large" | "requested-dataset-view-does-not-exist" | "resume-token-expired" | "run-failed" | "run-input-body-not-valid-json" | "run-timeout-exceeded" | "russia-is-evil" | "same-user" | "schedule-actor-not-found" | "schedule-actor-task-not-found" | "schedule-name-not-unique" | "schema-validation" | "schema-validation-error" | "schema-validation-failed" | "schemas-required" | "service-worker-registration-not-allowed" | "sign-up-method-not-allowed" | "slack-integration-not-custom" | "socket-closed" | "socket-destroyed" | "standby-deployment-invalid" | "store-schema-invalid" | "store-terms-not-accepted" | "stripe-enabled" | "stripe-generic-decline" | "stripe-not-enabled" | "stripe-not-enabled-for-user" | "tagged-build-required" | "tax-country-invalid" | "tax-number-invalid" | "tax-number-validation-failed" | "taxamo-call-failed" | "taxamo-request-failed" | "testing-error" | "token-not-provided" | "too-few-versions" | "too-many-actor-tasks" | "too-many-actors" | "too-many-labels-on-resource" | "too-many-mcp-connectors" | "too-many-o-auth-apps" | "too-many-organizations" | "too-many-public-actor-tasks-per-account" | "too-many-public-actor-tasks-per-actor" | "too-many-requests" | "too-many-schedules" | "too-many-ui-access-keys" | "too-many-user-labels" | "too-many-values" | "too-many-versions" | "too-many-webhooks" | "unexpected-route" | "unknown-build-tag" | "unknown-payment-provider" | "unsubscribe-token-invalid" | "unsupported-actor-pricing-model-for-agentic-payments" | "unsupported-content-encoding" | "unsupported-file-type-for-issue" | "unsupported-file-type-image-expected" | "unsupported-file-type-text-or-json-expected" | "unsupported-permission" | "upcoming-subscription-bill-not-up-to-date" | "user-already-exists" | "user-already-verified" | "user-creates-organizations-too-fast" | "user-disabled" | "user-email-is-disposable" | "user-email-not-set" | "user-email-not-verified" | "user-has-no-subscription" | "user-integration-not-found" | "user-is-already-invited" | "user-is-already-organization-member" | "user-is-not-member-of-organization" | "user-is-not-organization" | "user-is-organization" | "user-is-organization-owner" | "user-is-removed" | "user-not-found" | "user-not-logged-in" | "user-not-verified" | "user-or-token-not-found" | "user-plan-not-allowed-for-coupon" | "user-problem-with-card" | "user-record-not-found" | "username-already-taken" | "username-missing" | "username-not-allowed" | "username-removal-forbidden" | "username-required" | "verification-email-already-sent" | "verification-token-expired" | "version-already-exists" | "versions-size-exceeded" | "weak-password" | "x402-agentic-payment-already-finalized" | "x402-agentic-payment-insufficient-amount" | "x402-agentic-payment-malformed-token" | "x402-agentic-payment-settlement-failed" | "x402-agentic-payment-settlement-in-progress" | "x402-agentic-payment-settlement-stuck" | "x402-agentic-payment-unauthorized" | "x402-payment-required" | "zero-invoice";
|
|
4766
4766
|
/** ErrorDetail */
|
|
4767
4767
|
ErrorDetail: {
|
|
4768
4768
|
type?: components["schemas"]["ErrorType"];
|
|
@@ -4899,7 +4899,7 @@ export interface components {
|
|
|
4899
4899
|
* @description Whether to automatically restart the run if it fails.
|
|
4900
4900
|
* @example false
|
|
4901
4901
|
*/
|
|
4902
|
-
restartOnError?: boolean;
|
|
4902
|
+
restartOnError?: boolean | null;
|
|
4903
4903
|
/** @description Maximum number of items the run might produce. */
|
|
4904
4904
|
maxItems?: number | null;
|
|
4905
4905
|
forcePermissionLevel?: components["schemas"]["ActorPermissionLevel"] | null;
|
|
@@ -5101,7 +5101,7 @@ export interface components {
|
|
|
5101
5101
|
/** @description Whether this event is the Actor's primary chargeable event. */
|
|
5102
5102
|
isPrimaryEvent?: boolean;
|
|
5103
5103
|
/** @description Whether this event can only be charged once per Actor run. */
|
|
5104
|
-
isOneTimeEvent?: boolean;
|
|
5104
|
+
isOneTimeEvent?: boolean | null;
|
|
5105
5105
|
};
|
|
5106
5106
|
/** PayPerEventActorPricingInfo */
|
|
5107
5107
|
PayPerEventActorPricingInfo: components["schemas"]["CommonActorPricingInfo"] & {
|
|
@@ -5155,13 +5155,17 @@ export interface components {
|
|
|
5155
5155
|
*/
|
|
5156
5156
|
pricingModel: "PRICE_PER_DATASET_ITEM";
|
|
5157
5157
|
};
|
|
5158
|
-
/**
|
|
5158
|
+
/**
|
|
5159
|
+
* FlatPricePerMonthActorPricingInfo
|
|
5160
|
+
* @deprecated
|
|
5161
|
+
* @description Rental pricing model, which is no longer supported.
|
|
5162
|
+
*/
|
|
5159
5163
|
FlatPricePerMonthActorPricingInfo: components["schemas"]["CommonActorPricingInfo"] & {
|
|
5160
5164
|
/** @constant */
|
|
5161
5165
|
pricingModel: "FLAT_PRICE_PER_MONTH";
|
|
5162
|
-
/** @description
|
|
5166
|
+
/** @description Number of minutes a user could run the Actor for free before having to rent it. Apify no longer offers rental pricing, so you can see this field only in pricing history and in runs started before rented Actors moved to other pricing models. */
|
|
5163
5167
|
trialMinutes: number;
|
|
5164
|
-
/** @description Monthly flat price in USD */
|
|
5168
|
+
/** @description Monthly flat price in USD. Apify no longer offers rental pricing, so you can see this field only in pricing history and in runs started before rented Actors moved to other pricing models. */
|
|
5165
5169
|
pricePerUnitUsd: number;
|
|
5166
5170
|
} & {
|
|
5167
5171
|
/**
|
|
@@ -5267,7 +5271,7 @@ export interface components {
|
|
|
5267
5271
|
* @deprecated
|
|
5268
5272
|
* @example false
|
|
5269
5273
|
*/
|
|
5270
|
-
restartOnError?: boolean;
|
|
5274
|
+
restartOnError?: boolean | null;
|
|
5271
5275
|
/**
|
|
5272
5276
|
* @description Whether the Actor is available to users in Apify Store.
|
|
5273
5277
|
* @example false
|
|
@@ -5289,6 +5293,7 @@ export interface components {
|
|
|
5289
5293
|
stats: components["schemas"]["ActorStats"];
|
|
5290
5294
|
/** @description An array of `Version` objects. Each object represents a specific version of the Actor's source code: its location, builds, and environment configuration. */
|
|
5291
5295
|
versions: components["schemas"]["Version"][];
|
|
5296
|
+
/** @description The Actor's pricing records, including past ones. */
|
|
5292
5297
|
pricingInfos?: components["schemas"]["ActorRunPricingInfo"][];
|
|
5293
5298
|
defaultRunOptions: components["schemas"]["DefaultRunOptions"];
|
|
5294
5299
|
exampleRunInput?: components["schemas"]["ExampleRunInput"] | null;
|
|
@@ -5418,6 +5423,7 @@ export interface components {
|
|
|
5418
5423
|
restartOnError?: boolean;
|
|
5419
5424
|
/** @description An array of `Version` objects. Each object represents a specific version of the Actor's source code: its location, builds, and environment configuration. */
|
|
5420
5425
|
versions?: components["schemas"]["CreateVersionRequest"][];
|
|
5426
|
+
/** @description The Actor's pricing records. You can't add the `FLAT_PRICE_PER_MONTH` or `PRICE_PER_DATASET_ITEM` records, because these pricing models are no longer supported. */
|
|
5421
5427
|
pricingInfos?: components["schemas"]["ActorRunPricingInfo"][];
|
|
5422
5428
|
/**
|
|
5423
5429
|
* @description A list of categories that best define the Actor. Reflected in Apify Store's search and filtering options.
|
|
@@ -5866,8 +5872,11 @@ export interface components {
|
|
|
5866
5872
|
*/
|
|
5867
5873
|
actVersion?: {
|
|
5868
5874
|
sourceType?: components["schemas"]["VersionSourceType"];
|
|
5869
|
-
/**
|
|
5870
|
-
|
|
5875
|
+
/**
|
|
5876
|
+
* @description The build tag of the Actor version this build was created from. Can be `null` when the version has no build tag, in which case the build is tagged on success only if the `tag` parameter was passed when starting it.
|
|
5877
|
+
* @example experimental
|
|
5878
|
+
*/
|
|
5879
|
+
buildTag?: string | null;
|
|
5871
5880
|
/** @example 0.0 */
|
|
5872
5881
|
versionNumber?: string;
|
|
5873
5882
|
/**
|
|
@@ -6291,11 +6300,11 @@ export interface components {
|
|
|
6291
6300
|
/** @description Resource usage statistics for the run. */
|
|
6292
6301
|
usage?: components["schemas"]["RunUsage"] | null;
|
|
6293
6302
|
/**
|
|
6294
|
-
* @description Total cost in USD for this run. Represents what you actually pay. For run owners: includes platform usage (compute units) and/or event costs depending on the Actor's pricing model. For run non-owners: only available for
|
|
6303
|
+
* @description Total cost in USD for this run. Represents what you actually pay. For run owners: includes platform usage (compute units) and/or event costs depending on the Actor's pricing model. For run non-owners: only available for pay-per-event Actors (event costs only). Requires authentication token to access.
|
|
6295
6304
|
* @example 0.2654
|
|
6296
6305
|
*/
|
|
6297
6306
|
usageTotalUsd?: number | null;
|
|
6298
|
-
/** @description Platform usage costs breakdown in USD. Only present if you own the run
|
|
6307
|
+
/** @description Platform usage costs breakdown in USD. Only present if you own the run and are paying for platform usage (pay-per-usage or pay-per-event with usage costs like Standby Actors). Not available for standard pay-per-event Actors. Requires authentication token to access. */
|
|
6299
6308
|
usageUsd?: components["schemas"]["RunUsageUsd"] | null;
|
|
6300
6309
|
/** @description List of metamorph events that occurred during the run. */
|
|
6301
6310
|
metamorphs?: components["schemas"]["RunMetamorphEvent"][] | null;
|
|
@@ -7418,7 +7427,7 @@ export interface components {
|
|
|
7418
7427
|
* Format: date-time
|
|
7419
7428
|
* @description Time when the task was published, or `null` if the task isn't published.
|
|
7420
7429
|
* This field is server-controlled. To publish or unpublish a task, use the
|
|
7421
|
-
* [Update task](https://docs.apify.com/api/v2/actor-task-put) endpoint and set `isPublic`.
|
|
7430
|
+
* [Update Actor task](https://docs.apify.com/api/v2/actor-task-put) endpoint and set `isPublic`.
|
|
7422
7431
|
* @example 2025-06-16T09:20:45.777Z
|
|
7423
7432
|
*/
|
|
7424
7433
|
readonly publishedAt?: Date | null;
|
|
@@ -8114,12 +8123,6 @@ export interface components {
|
|
|
8114
8123
|
isPPEPlatformUsagePaidByUser?: boolean;
|
|
8115
8124
|
/** @example null */
|
|
8116
8125
|
reasonForChange?: string | null;
|
|
8117
|
-
/** @example null */
|
|
8118
|
-
trialMinutes?: number | null;
|
|
8119
|
-
/** @example null */
|
|
8120
|
-
unitName?: string | null;
|
|
8121
|
-
/** @example null */
|
|
8122
|
-
pricePerUnitUsd?: number | null;
|
|
8123
8126
|
/** @example 0.5 */
|
|
8124
8127
|
minimalMaxTotalChargeUsd?: number | null;
|
|
8125
8128
|
/** @description Per-event pricing configuration for pay-per-event Actors. */
|
|
@@ -10470,6 +10473,7 @@ export interface operations {
|
|
|
10470
10473
|
};
|
|
10471
10474
|
};
|
|
10472
10475
|
400: components["responses"]["BadRequest"];
|
|
10476
|
+
401: components["responses"]["Unauthorized"];
|
|
10473
10477
|
403: components["responses"]["Forbidden"];
|
|
10474
10478
|
404: components["responses"]["NotFound"];
|
|
10475
10479
|
405: components["responses"]["MethodNotAllowed"];
|
|
@@ -20734,7 +20738,7 @@ export interface operations {
|
|
|
20734
20738
|
/** @description Filters the results by the specified username. */
|
|
20735
20739
|
username?: string;
|
|
20736
20740
|
/** @description Only return Actors with the specified pricing model. */
|
|
20737
|
-
pricingModel?: "FREE" | "
|
|
20741
|
+
pricingModel?: "FREE" | "PRICE_PER_DATASET_ITEM" | "PAY_PER_EVENT";
|
|
20738
20742
|
/**
|
|
20739
20743
|
* @description If true, only return Actors that allow agentic users. If false, only
|
|
20740
20744
|
* return Actors that do not allow agentic users.
|