application/json).
+ *
+ * The response contains the record stored under the `OUTPUT` key in the run's
+ * default key-value store. This is a legacy approach that has been replaced by
+ * the Actor [output object](https://docs.apify.com/platform/actors/development/actor-definition/output-schema#output-object-definition);
+ * Actors aren't required to store a record under this key, so the response may
+ * not contain any data. Use the `outputRecordKey` query parameter to return a
+ * different record.
+ *
+ * The Actor is started with the default options; you can override them using
+ * various URL query parameters.
+ * If the Actor run exceeds 300 seconds,
+ * the HTTP response will have status 408 (Request Timeout).
+ *
+ * Beware that it might be impossible to maintain an idle HTTP connection for a
+ * long period of time, due to client timeout or network conditions. Make sure your HTTP client is
+ * configured to have a long enough connection timeout.
+ * If the connection breaks, you will not receive any information about the run
+ * and its status.
+ *
+ * To run the Actor asynchronously, use the [Run
+ * Actor](#/reference/actors/run-collection/run-actor) API endpoint instead.
+ */
+ post: operations["actor_runSync_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/run-sync-get-dataset-items": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Run Actor synchronously without input and get dataset items
+ * @description Runs a specific Actor and returns its dataset items.
+ * The run must finish in 300 seconds
+ * otherwise the API endpoint returns a timeout error.
+ * The Actor is not passed any input.
+ *
+ * It allows to send all possible options in parameters from [Get Dataset
+ * Items](#/reference/datasets/item-collection/get-items) API endpoint.
+ *
+ * Beware that it might be impossible to maintain an idle HTTP connection for a
+ * long period of time,
+ * due to client timeout or network conditions. Make sure your HTTP client is
+ * configured to have a long enough connection timeout.
+ * If the connection breaks, you will not receive any information about the run
+ * and its status.
+ *
+ * To run the Actor asynchronously, use the [Run
+ * Actor](#/reference/actors/run-collection/run-actor) API endpoint instead.
+ */
+ get: operations["actor_runSyncGetDatasetItems_get"];
+ put?: never;
+ /**
+ * Run Actor synchronously and get dataset items
+ * @description Runs a specific Actor and returns its dataset items.
+ *
+ * The POST payload including its `Content-Type` header is passed as `INPUT` to
+ * the Actor (usually `application/json`).
+ * The HTTP response contains the Actors dataset items, while the format of
+ * items depends on specifying dataset items' `format` parameter.
+ *
+ * You can send all the same options in parameters as the [Get Dataset
+ * Items](#/reference/datasets/item-collection/get-items) API endpoint.
+ *
+ * The Actor is started with the default options; you can override them using
+ * URL query parameters.
+ * If the Actor run exceeds 300 seconds,
+ * the HTTP response will return the 408 status code (Request Timeout).
+ *
+ * Beware that it might be impossible to maintain an idle HTTP connection for a
+ * long period of time,
+ * due to client timeout or network conditions. Make sure your HTTP client is
+ * configured to have a long enough connection timeout.
+ * If the connection breaks, you will not receive any information about the run
+ * and its status.
+ *
+ * To run the Actor asynchronously, use the [Run
+ * Actor](#/reference/actors/run-collection/run-actor) API endpoint instead.
+ */
+ post: operations["actor_runSyncGetDatasetItems_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/validate-input": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Validate Actor input
+ * @description Validates the provided input against the Actor's input schema for the specified build.
+ *
+ * The endpoint checks whether the JSON payload conforms to the input schema
+ * defined in the Actor's build. If no `build` query parameter is provided,
+ * the `latest` build tag is used by default.
+ */
+ post: operations["actor_validateInput_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/{runId}/resurrect": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Resurrect run
+ * @description **[DEPRECATED]** API endpoints related to run of the Actor were moved under
+ * new namespace [`actor-runs`](#/reference/actor-runs).Resurrects a finished
+ * Actor run and returns an object that contains all the details about the
+ * resurrected run.
+ *
+ * Only finished runs, i.e. runs with status `FINISHED`, `FAILED`, `ABORTED`
+ * and `TIMED-OUT` can be resurrected.
+ * Run status will be updated to RUNNING and its container will be restarted
+ * with the same storages
+ * (the same behaviour as when the run gets migrated to the new server).
+ *
+ * For more information, see the [Actor
+ * docs](https://docs.apify.com/platform/actors/running/runs-and-builds#resurrection-of-finished-run).
+ */
+ post: operations["actor_run_resurrect_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last run
+ * @description This is not a single endpoint, but an entire group of endpoints that lets you to
+ * retrieve and manage the last run of given Actor or any of its default storages.
+ * All the endpoints require an authentication token.
+ *
+ * The base path represents the last Actor run object is:
+ *
+ * `/v2/actors/{actorId}/runs/last{?token,status,origin}`
+ *
+ * Using the `status` query parameter you can ensure to only get a run with a certain status
+ * (e.g. `status=SUCCEEDED`). Similarly, the `origin` query parameter filters runs by the means
+ * by which they were started (e.g. `origin=API`). The output of this endpoint and other query
+ * parameters are the same as in the [Run object](#/reference/actors/run-object) endpoint.
+ *
+ * ##### Convenience endpoints for last Actor run
+ *
+ * * [Dataset](https://docs.apify.com/api/v2/last-actor-runs-default-dataset)
+ *
+ * * [Key-value store](https://docs.apify.com/api/v2/last-actor-runs-default-key-value-store)
+ *
+ * * [Request queue](https://docs.apify.com/api/v2/last-actor-runs-default-request-queue)
+ *
+ * * [Log](https://docs.apify.com/api/v2/last-actor-runs-log)
+ */
+ get: operations["actor_runs_last_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/dataset": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last run's default dataset
+ * @description Returns the default dataset associated with the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
+ * [Get dataset](https://docs.apify.com/api/v2/dataset-get) endpoint.
+ */
+ get: operations["actor_runs_last_dataset_get"];
+ /**
+ * Update last run's default dataset
+ * @description Updates the default dataset associated with the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
+ * [Update dataset](https://docs.apify.com/api/v2/dataset-put) endpoint.
+ */
+ put: operations["actor_runs_last_dataset_put"];
+ post?: never;
+ /**
+ * Delete last run's default dataset
+ * @description Deletes the default dataset associated with the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
+ * [Delete dataset](https://docs.apify.com/api/v2/dataset-delete) endpoint.
+ */
+ delete: operations["actor_runs_last_dataset_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/dataset/items": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last run's dataset items
+ * @description Returns data stored in the default dataset of the last Actor run in the desired format.
+ *
+ * This endpoint is a shortcut that resolves the last run's `defaultDatasetId` and proxies to the
+ * [Get dataset items](https://docs.apify.com/api/v2/dataset-items-get) endpoint.
+ */
+ get: operations["actor_runs_last_dataset_items_get"];
+ put?: never;
+ /**
+ * Store items in last run's dataset
+ * @description Appends an item or an array of items to the end of the last Actor run's default dataset.
+ *
+ * This endpoint is a shortcut that resolves the last run's `defaultDatasetId` and proxies to the
+ * [Store items](https://docs.apify.com/api/v2/dataset-items-post) endpoint.
+ *
+ * To save bandwidth and speed up your upload, you can send the request payload compressed and set the `Content-Encoding` header accordingly.
+ *
+ * Below is a list of supported `Content-Encoding` types.
+ *
+ * * Brotli: `Content-Encoding: br`
+ * * Gzip: `Content-Encoding: gzip`
+ * * Deflate: `Content-Encoding: deflate`
+ */
+ post: operations["actor_runs_last_dataset_items_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/dataset/statistics": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last run's dataset statistics
+ * @description Returns statistics for the last Actor run's default dataset.
+ *
+ * This endpoint is a shortcut that resolves the last run's `defaultDatasetId` and proxies to the
+ * [Get dataset statistics](https://docs.apify.com/api/v2/dataset-statistics-get) endpoint.
+ */
+ get: operations["actor_runs_last_dataset_statistics_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/key-value-store": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last run's default store
+ * @description Gets an object that contains all the details about the default key-value store associated with the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
+ * [Get store](https://docs.apify.com/api/v2/key-value-store-get) endpoint.
+ */
+ get: operations["actor_runs_last_keyValueStore_get"];
+ /**
+ * Update last run's default store
+ * @description Updates the last Actor run key-value store's name and general resource access level using a value specified by a JSON object
+ * passed in the PUT payload.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
+ * [Update store](https://docs.apify.com/api/v2/key-value-store-put) endpoint.
+ */
+ put: operations["actor_runs_last_keyValueStore_put"];
+ post?: never;
+ /**
+ * Delete last run's default store
+ * @description Deletes the last Actor run key-value store.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
+ * [Delete store](https://docs.apify.com/api/v2/key-value-store-delete) endpoint.
+ */
+ delete: operations["actor_runs_last_keyValueStore_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/key-value-store/keys": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last run's default store's list of keys
+ * @description Returns a list of keys for the default key-value store of the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the
+ * [Get list of keys](https://docs.apify.com/api/v2/key-value-store-keys-get) endpoint.
+ */
+ get: operations["actor_runs_last_keyValueStore_keys_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/key-value-store/records": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Download last run's default store's records
+ * @description Downloads all records from the default key-value store of the last Actor run as a ZIP archive.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the
+ * [Download records](https://docs.apify.com/api/v2/key-value-store-records-get) endpoint.
+ */
+ get: operations["actor_runs_last_keyValueStore_records_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/key-value-store/records/{recordKey}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last run's default store's record
+ * @description Gets a value stored under a specific key in the default key-value store of the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the
+ * [Get record](https://docs.apify.com/api/v2/key-value-store-record-get) endpoint.
+ */
+ get: operations["actor_runs_last_keyValueStore_record_get"];
+ /**
+ * Store record in last run's default store
+ * @description Stores a value under a specific key in the default key-value store of the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the
+ * [Store record](https://docs.apify.com/api/v2/key-value-store-record-put) endpoint.
+ */
+ put: operations["actor_runs_last_keyValueStore_record_put"];
+ /**
+ * Store record in last run's default store (POST)
+ * @description Stores a value under a specific key in the default key-value store of the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the
+ * [Store record](https://docs.apify.com/api/v2/key-value-store-record-post) endpoint.
+ */
+ post: operations["actor_runs_last_keyValueStore_record_post"];
+ /**
+ * Delete last run's default store's record
+ * @description Removes a record specified by a key from the default key-value store of the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the
+ * [Delete record](https://docs.apify.com/api/v2/key-value-store-record-delete) endpoint.
+ */
+ delete: operations["actor_runs_last_keyValueStore_record_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/request-queue": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last run's default request queue
+ * @description Returns the default request queue associated with the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
+ * [Get request queue](https://docs.apify.com/api/v2/request-queue-get) endpoint.
+ */
+ get: operations["actor_runs_last_requestQueue_get"];
+ /**
+ * Update last run's default request queue
+ * @description Updates the default request queue associated with the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
+ * [Update request queue](https://docs.apify.com/api/v2/request-queue-put) endpoint.
+ */
+ put: operations["actor_runs_last_requestQueue_put"];
+ post?: never;
+ /**
+ * Delete last run's default request queue
+ * @description Deletes the default request queue associated with the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
+ * [Delete request queue](https://docs.apify.com/api/v2/request-queue-delete) endpoint.
+ */
+ delete: operations["actor_runs_last_requestQueue_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/request-queue/requests": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * List last run's default request queue's requests
+ * @description Returns a list of requests from the default request queue of the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
+ * [List requests](https://docs.apify.com/api/v2/request-queue-requests-get) endpoint.
+ */
+ get: operations["actor_runs_last_requestQueue_requests_get"];
+ put?: never;
+ /**
+ * Add request to last run's default request queue
+ * @description Adds a request to the default request queue of the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
+ * [Add request](https://docs.apify.com/api/v2/request-queue-requests-post) endpoint.
+ */
+ post: operations["actor_runs_last_requestQueue_requests_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/request-queue/requests/batch": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Batch add requests to last run's default request queue
+ * @description Adds requests to the default request queue of the last Actor run in batch.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
+ * [Add requests](https://docs.apify.com/api/v2/request-queue-requests-batch-post) endpoint.
+ */
+ post: operations["actor_runs_last_requestQueue_requests_batch_post"];
+ /**
+ * Batch delete requests from last run's default request queue
+ * @description Batch-deletes requests from the default request queue of the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
+ * [Delete requests](https://docs.apify.com/api/v2/request-queue-requests-batch-delete) endpoint.
+ */
+ delete: operations["actor_runs_last_requestQueue_requests_batch_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/request-queue/requests/unlock": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Unlock requests in last run's default request queue
+ * @description Unlocks requests in the default request queue of the last Actor run that are currently locked by the client.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
+ * [Unlock requests](https://docs.apify.com/api/v2/request-queue-requests-unlock-post) endpoint.
+ */
+ post: operations["actor_runs_last_requestQueue_requests_unlock_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/request-queue/requests/{requestId}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get request from last run's default request queue
+ * @description Returns a request from the default request queue of the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
+ * [Get request](https://docs.apify.com/api/v2/request-queue-request-get) endpoint.
+ */
+ get: operations["actor_runs_last_requestQueue_request_get"];
+ /**
+ * Update request in last run's default request queue
+ * @description Updates a request in the default request queue of the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
+ * [Update request](https://docs.apify.com/api/v2/request-queue-request-put) endpoint.
+ */
+ put: operations["actor_runs_last_requestQueue_request_put"];
+ post?: never;
+ /**
+ * Delete request from last run's default request queue
+ * @description Deletes a request from the default request queue of the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
+ * [Delete request](https://docs.apify.com/api/v2/request-queue-request-delete) endpoint.
+ */
+ delete: operations["actor_runs_last_requestQueue_request_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/request-queue/requests/{requestId}/lock": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ /**
+ * Prolong lock on request in last run's default request queue
+ * @description Prolongs a request lock in the default request queue of the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
+ * [Prolong request lock](https://docs.apify.com/api/v2/request-queue-request-lock-put) endpoint.
+ */
+ put: operations["actor_runs_last_requestQueue_request_lock_put"];
+ post?: never;
+ /**
+ * Delete lock on request in last run's default request queue
+ * @description Deletes a request lock in the default request queue of the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
+ * [Delete request lock](https://docs.apify.com/api/v2/request-queue-request-lock-delete) endpoint.
+ */
+ delete: operations["actor_runs_last_requestQueue_request_lock_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/request-queue/head": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last run's default request queue head
+ * @description Returns the given number of first requests from the default request queue of the last Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
+ * [Get head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
+ */
+ get: operations["actor_runs_last_requestQueue_head_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/request-queue/head/lock": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Get and lock last run's default request queue head
+ * @description Returns the given number of first requests from the default request queue of the last Actor run
+ * and locks them for the given time.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
+ * [Get head and lock](https://docs.apify.com/api/v2/request-queue-head-lock-post) endpoint.
+ */
+ post: operations["actor_runs_last_requestQueue_head_lock_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/log": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last Actor run's log
+ * @description Retrieves last Actor run's logs.
+ *
+ * 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.
+ */
+ get: operations["actor_runs_last_log_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/abort": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Abort Actor's last run
+ * @description Aborts the last run of the specified Actor and returns an object that
+ * contains all the details about the run.
+ *
+ * This endpoint is a shortcut for [Abort run](#/reference/actor-runs/abort-run/abort-run)
+ * on the Actor's last run. Only runs that are starting or running are aborted.
+ * For runs with status `FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call
+ * does nothing.
+ */
+ post: operations["actor_runs_last_abort_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/metamorph": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Metamorph Actor's last run
+ * @description Transforms the last run of the specified Actor into a run of another Actor with
+ * a new input.
+ *
+ * This endpoint is a shortcut for [Metamorph run](#/reference/actor-runs/metamorph-run/metamorph-run)
+ * on the Actor's last run.
+ */
+ post: operations["actor_runs_last_metamorph_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/last/reboot": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Reboot Actor's last run
+ * @description Reboots the last run of the specified Actor and returns an object that
+ * contains all the details about the rebooted run.
+ *
+ * This endpoint is a shortcut for [Reboot run](#/reference/actor-runs/reboot-run/reboot-run)
+ * on the Actor's last run. Only runs with status `RUNNING` can be rebooted. The run's
+ * container will be restarted, so any data not persisted in the key-value store, dataset,
+ * or request queue will be lost.
+ */
+ post: operations["actor_runs_last_reboot_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/{runId}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get run
+ * @deprecated
+ * @description **[DEPRECATED]** API endpoints related to run of the Actor were moved under
+ * new namespace [`actor-runs`](#/reference/actor-runs).
+ *
+ * Gets an object that contains all the details about a specific run of an Actor.
+ *
+ * By passing the optional `waitForFinish` parameter the API endpoint will
+ * synchronously wait for the run to finish.
+ * This is useful to avoid periodic polling when waiting for Actor run to
+ * complete.
+ *
+ * This endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the run. However,
+ * if you access the endpoint without the token, certain attributes, such as `usageUsd` and `usageTotalUsd`, will be hidden.
+ */
+ get: operations["actors_run_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/{runId}/abort": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Abort run
+ * @deprecated
+ * @description **[DEPRECATED]** API endpoints related to run of the Actor were moved under
+ * new namespace [`actor-runs`](#/reference/actor-runs). Aborts an Actor run and
+ * returns an object that contains all the details about the run.
+ *
+ * Only runs that are starting or running are aborted. For runs with status
+ * `FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call does nothing.
+ */
+ post: operations["actors_run_abort_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actors/{actorId}/runs/{runId}/metamorph": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Metamorph run
+ * @deprecated
+ * @description **[DEPRECATED]** API endpoints related to run of the Actor were moved under
+ * new namespace [`actor-runs`](#/reference/actor-runs). Transforms an Actor run
+ * into a run of another Actor with a new input.
+ *
+ * This is useful if you want to use another Actor to finish the work
+ * of your current Actor run, without the need to create a completely new run
+ * and waiting for its finish.
+ * For the users of your Actors, the metamorph operation is transparent, they
+ * will just see your Actor got the work done.
+ *
+ * There is a limit on how many times you can metamorph a single run. You can
+ * check the limit in [the Actor runtime limits](https://docs.apify.com/platform/limits#actor-limits).
+ *
+ * Internally, the system stops the Docker container corresponding to the Actor
+ * run and starts a new container using a different Docker image.
+ * All the default storages are preserved and the new input is stored under the
+ * `INPUT-METAMORPH-1` key in the same default key-value store.
+ *
+ * For more information, see the [Actor docs](https://docs.apify.com/platform/actors/development/programming-interface/metamorph).
+ */
+ post: operations["actors_run_metamorph_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get list of tasks
+ * @description Gets the complete list of tasks that a user has created or used.
+ *
+ * The response is a list of objects in which each object contains essential
+ * information about a single task.
+ *
+ * The endpoint supports pagination using the `limit` and `offset` parameters,
+ * and it does not return more than a 1000 records.
+ *
+ * By default, the records are sorted by the `createdAt` field in ascending
+ * order; therefore you can use pagination to incrementally fetch all tasks while new
+ * ones are still being created. To sort the records in descending order, use
+ * the `desc=1` parameter.
+ */
+ get: operations["actorTasks_get"];
+ put?: never;
+ /**
+ * Create task
+ * @description Create a new task with settings specified by the object passed as JSON in
+ * the POST payload.
+ *
+ * The response is the full task object as returned by the
+ * [Get task](https://docs.apify.com/api/v2/actor-task-get) endpoint.
+ *
+ * The request needs to specify the `Content-Type: application/json` HTTP header!
+ *
+ * When providing your API authentication token, we recommend using the
+ * request's `Authorization` header, rather than the URL.
+ */
+ post: operations["actorTasks_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get task
+ * @description Get an object that contains all the details about a task.
+ */
+ get: operations["actorTask_get"];
+ /**
+ * Update task
+ * @description Update settings of a task using values specified by an object passed as JSON
+ * in the POST payload.
+ *
+ * If the object does not define a specific property, its value is not updated.
+ *
+ * The response is the full task object as returned by the
+ * [Get task](https://docs.apify.com/api/v2/actor-task-get) endpoint.
+ *
+ * The request needs to specify the `Content-Type: application/json` HTTP
+ * header!
+ *
+ * When providing your API authentication token, we recommend using the
+ * request's `Authorization` header, rather than the URL.
+ */
+ put: operations["actorTask_put"];
+ post?: never;
+ /**
+ * Delete task
+ * @description Delete the task specified through the `actorTaskId` parameter.
+ */
+ delete: operations["actorTask_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/input": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get task input
+ * @description Returns the input of a given task.
+ */
+ get: operations["actorTask_input_get"];
+ /**
+ * Update task input
+ * @description Updates the input of a task using values specified by an object passed as
+ * JSON in the PUT payload.
+ *
+ * If the object does not define a specific property, its value is not updated.
+ *
+ * The response is the full task input as returned by the
+ * [Get task input](#/reference/tasks/task-input-object/get-task-input) endpoint.
+ *
+ * The request needs to specify the `Content-Type: application/json` HTTP
+ * header!
+ *
+ * When providing your API authentication token, we recommend using the
+ * request's `Authorization` header, rather than the URL. ([More
+ * info](#/introduction/authentication)).
+ */
+ put: operations["actorTask_input_put"];
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/webhooks": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get list of webhooks
+ * @description Gets the list of webhooks of a specific Actor task. The response is a JSON
+ * with the list of objects, where each object contains basic information about a single webhook.
+ *
+ * The endpoint supports pagination using the `limit` and `offset` parameters
+ * and it will not return more than 1000 records.
+ *
+ * By default, the records are sorted by the `createdAt` field in ascending
+ * order, to sort the records in descending order, use the `desc=1` parameter.
+ */
+ get: operations["actorTask_webhooks_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get list of task runs
+ * @description Get a list of runs of a specific task. The response is a list of objects,
+ * where each object contains essential information about a single task run.
+ *
+ * The endpoint supports pagination using the `limit` and `offset` parameters,
+ * and it does not return more than a 1000 array elements.
+ *
+ * By default, the records are sorted by the `startedAt` field in ascending
+ * order; therefore you can use pagination to incrementally fetch all records while
+ * new ones are still being created. To sort the records in descending order, use
+ * the `desc=1` parameter. You can also filter runs by status ([available
+ * statuses](https://docs.apify.com/platform/actors/running/runs-and-builds#lifecycle)).
+ */
+ get: operations["actorTask_runs_get"];
+ put?: never;
+ /**
+ * Run task
+ * @description Runs an Actor task and immediately returns without waiting for the run to
+ * finish.
+ *
+ * Optionally, you can override the Actor input configuration by passing a JSON
+ * object as the POST payload and setting the `Content-Type: application/json` HTTP header.
+ *
+ * Note that if the object in the POST payload does not define a particular
+ * input property, the Actor run uses the default value defined by the task (or Actor's input
+ * schema if not defined by the task).
+ *
+ * The response is the Actor Run object as returned by the [Get
+ * run](#/reference/actor-runs/run-object-and-its-storages/get-run) endpoint.
+ *
+ * If you want to wait for the run to finish and receive the actual output of
+ * the Actor run as the response, use one of the [Run task
+ * synchronously](#/reference/actor-tasks/run-task-synchronously) API endpoints
+ * instead.
+ *
+ * To fetch the Actor run results that are typically stored in the default
+ * dataset, you'll need to pass the ID received in the `defaultDatasetId` field
+ * received in the response JSON to the
+ * [Get dataset items](#/reference/datasets/item-collection/get-items) API endpoint.
+ */
+ post: operations["actorTask_runs_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/run-sync": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Run task synchronously
+ * @description Runs an Actor task and synchronously returns a key-value store record.
+ *
+ * The response contains the record stored under the `OUTPUT` key in the run's
+ * default key-value store. This is a legacy approach that has been replaced by
+ * the Actor [output object](https://docs.apify.com/platform/actors/development/actor-definition/output-schema#output-object-definition);
+ * Actors aren't required to store a record under this key, so the response may
+ * not contain any data. Use the `outputRecordKey` query parameter to return a
+ * different record.
+ *
+ * The run must finish in 300 seconds
+ * otherwise the HTTP request fails with a timeout error (this won't abort
+ * the run itself).
+ *
+ * Beware that it might be impossible to maintain an idle HTTP connection for
+ * an extended period, due to client timeout or network conditions. Make sure your HTTP client is
+ * configured to have a long enough connection timeout.
+ *
+ * If the connection breaks, you will not receive any information about the run
+ * and its status.
+ *
+ * To run the Task asynchronously, use the
+ * [Run task asynchronously](#/reference/actor-tasks/run-collection/run-task)
+ * endpoint instead.
+ */
+ get: operations["actorTask_runSync_get"];
+ put?: never;
+ /**
+ * Run task synchronously
+ * @description Runs an Actor task and synchronously returns a key-value store record.
+ *
+ * The response contains the record stored under the `OUTPUT` key in the run's
+ * default key-value store. This is a legacy approach that has been replaced by
+ * the Actor [output object](https://docs.apify.com/platform/actors/development/actor-definition/output-schema#output-object-definition);
+ * Actors aren't required to store a record under this key, so the response may
+ * not contain any data. Use the `outputRecordKey` query parameter to return a
+ * different record.
+ *
+ * The run must finish in 300 seconds
+ * otherwise the HTTP request fails with a timeout error (this won't abort
+ * the run itself).
+ *
+ * Optionally, you can override the Actor input configuration by passing a JSON
+ * object as the POST payload and setting the `Content-Type: application/json` HTTP header.
+ *
+ * Note that if the object in the POST payload does not define a particular
+ * input property, the Actor run uses the default value defined by the task (or Actor's input
+ * schema if not defined by the task).
+ *
+ * Beware that it might be impossible to maintain an idle HTTP connection for
+ * an extended period, due to client timeout or network conditions. Make sure your HTTP client is
+ * configured to have a long enough connection timeout.
+ *
+ * If the connection breaks, you will not receive any information about the run
+ * and its status.
+ *
+ * Input fields from Actor task configuration can be overloaded with values
+ * passed as the POST payload.
+ *
+ * Just make sure to specify `Content-Type` header to be `application/json` and
+ * input to be an object.
+ *
+ * To run the task asynchronously, use the [Run
+ * task](#/reference/actor-tasks/run-collection/run-task) API endpoint instead.
+ */
+ post: operations["actorTask_runSync_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/run-sync-get-dataset-items": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Run task synchronously and get dataset items
+ * @description Run a specific task and return its dataset items.
+ *
+ * The run must finish in 300 seconds
+ * otherwise the HTTP request fails with a timeout error (this won't abort
+ * the run itself).
+ *
+ * You can send all the same options in parameters as the [Get Dataset
+ * Items](#/reference/datasets/item-collection/get-items) API endpoint.
+ *
+ * Beware that it might be impossible to maintain an idle HTTP connection for
+ * an extended period, due to client timeout or network conditions. Make sure your HTTP client is
+ * configured to have a long enough connection timeout.
+ *
+ * If the connection breaks, you will not receive any information about the run
+ * and its status.
+ *
+ * To run the Task asynchronously, use the [Run task
+ * asynchronously](#/reference/actor-tasks/run-collection/run-task) endpoint
+ * instead.
+ */
+ get: operations["actorTask_runSyncGetDatasetItems_get"];
+ put?: never;
+ /**
+ * Run task synchronously and get dataset items
+ * @description Runs an Actor task and synchronously returns its dataset items.
+ *
+ * The run must finish in 300 seconds
+ * otherwise the HTTP request fails with a timeout error (this won't abort
+ * the run itself).
+ *
+ * Optionally, you can override the Actor input configuration by passing a JSON
+ * object as the POST payload and setting the `Content-Type: application/json` HTTP header.
+ *
+ * Note that if the object in the POST payload does not define a particular
+ * input property, the Actor run uses the default value defined by the task (or the Actor's
+ * input schema if not defined by the task).
+ *
+ * You can send all the same options in parameters as the [Get Dataset
+ * Items](#/reference/datasets/item-collection/get-items) API endpoint.
+ *
+ * Beware that it might be impossible to maintain an idle HTTP connection for
+ * an extended period, due to client timeout or network conditions. Make sure your HTTP client is
+ * configured to have a long enough connection timeout.
+ *
+ * If the connection breaks, you will not receive any information about the run
+ * and its status.
+ *
+ * Input fields from Actor task configuration can be overloaded with values
+ * passed as the POST payload.
+ *
+ * Just make sure to specify the `Content-Type` header as `application/json`
+ * and that the input is an object.
+ *
+ * To run the task asynchronously, use the [Run
+ * task](#/reference/actor-tasks/run-collection/run-task) API endpoint instead.
+ */
+ post: operations["actorTask_runSyncGetDatasetItems_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last run
+ * @description This is not a single endpoint, but an entire group of endpoints that lets you to
+ * retrieve and manage the last run of given actor task or any of its default storages.
+ * All the endpoints require an authentication token.
+ *
+ * The base path represents the last actor task run object is:
+ *
+ * `/v2/actor-tasks/{actorTaskId}/runs/last{?token,status,origin}`
+ *
+ * Using the `status` query parameter you can ensure to only get a run with a certain status
+ * (e.g. `status=SUCCEEDED`). Similarly, the `origin` query parameter filters runs by the means
+ * by which they were started (e.g. `origin=API`). The output of this endpoint and other query
+ * parameters are the same as in the [Run object](https://docs.apify.com/api/v2/actor-run-get) endpoint.
+ *
+ * ##### Convenience endpoints for last Actor task run
+ *
+ * * [Dataset](https://docs.apify.com/api/v2/last-actor-task-runs-default-dataset)
+ *
+ * * [Key-value store](https://docs.apify.com/api/v2/last-actor-task-runs-default-key-value-store)
+ *
+ * * [Request queue](https://docs.apify.com/api/v2/last-actor-task-runs-default-request-queue)
+ *
+ * * [Log](https://docs.apify.com/api/v2/last-actor-task-runs-log)
+ */
+ get: operations["actorTask_runs_last_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/log": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last Actor task run's log
+ * @description Retrieves last Actor task run's logs.
+ *
+ * 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.
+ */
+ get: operations["actorTask_last_log_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/abort": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Abort Actor task's last run
+ * @description Aborts the last run of the specified Actor task and returns an object that
+ * contains all the details about the run.
+ *
+ * This endpoint is a shortcut for [Abort run](#/reference/actor-runs/abort-run/abort-run)
+ * on the Actor task's last run. Only runs that are starting or running are aborted.
+ * For runs with status `FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call
+ * does nothing.
+ */
+ post: operations["actorTask_runs_last_abort_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/metamorph": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Metamorph Actor task's last run
+ * @description Transforms the last run of the specified Actor task into a run of another Actor with
+ * a new input.
+ *
+ * This endpoint is a shortcut for [Metamorph run](#/reference/actor-runs/metamorph-run/metamorph-run)
+ * on the Actor task's last run.
+ */
+ post: operations["actorTask_runs_last_metamorph_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/reboot": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Reboot Actor task's last run
+ * @description Reboots the last run of the specified Actor task and returns an object that
+ * contains all the details about the rebooted run.
+ *
+ * This endpoint is a shortcut for [Reboot run](#/reference/actor-runs/reboot-run/reboot-run)
+ * on the Actor task's last run. Only runs with status `RUNNING` can be rebooted. The run's
+ * container will be restarted, so any data not persisted in the key-value store, dataset,
+ * or request queue will be lost.
+ */
+ post: operations["actorTask_runs_last_reboot_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/dataset": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last task run's default dataset
+ * @description Returns the default dataset associated with the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultDatasetId` and then using the
+ * [Get dataset](https://docs.apify.com/api/v2/dataset-get) endpoint.
+ */
+ get: operations["actorTask_runs_last_dataset_get"];
+ /**
+ * Update last task run's default dataset
+ * @description Updates the default dataset associated with the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultDatasetId` and then using the
+ * [Update dataset](https://docs.apify.com/api/v2/dataset-put) endpoint.
+ */
+ put: operations["actorTask_runs_last_dataset_put"];
+ post?: never;
+ /**
+ * Delete last task run's default dataset
+ * @description Deletes the default dataset associated with the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultDatasetId` and then using the
+ * [Delete dataset](https://docs.apify.com/api/v2/dataset-delete) endpoint.
+ */
+ delete: operations["actorTask_runs_last_dataset_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/dataset/items": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last task run's dataset items
+ * @description Returns data stored in the default dataset of the last Actor task run in the desired format.
+ *
+ * This endpoint is a shortcut that resolves the last task run's `defaultDatasetId` and proxies to the
+ * [Get dataset items](https://docs.apify.com/api/v2/dataset-items-get) endpoint.
+ */
+ get: operations["actorTask_runs_last_dataset_items_get"];
+ put?: never;
+ /**
+ * Store items in last task run's dataset
+ * @description Appends an item or an array of items to the end of the last Actor task run's default dataset.
+ *
+ * This endpoint is a shortcut that resolves the last task run's `defaultDatasetId` and proxies to the
+ * [Store items](https://docs.apify.com/api/v2/dataset-items-post) endpoint.
+ *
+ * To save bandwidth and speed up your upload, you can send the request payload compressed and set the `Content-Encoding` header accordingly.
+ *
+ * Below is a list of supported `Content-Encoding` types.
+ *
+ * * Brotli: `Content-Encoding: br`
+ * * Gzip: `Content-Encoding: gzip`
+ * * Deflate: `Content-Encoding: deflate`
+ */
+ post: operations["actorTask_runs_last_dataset_items_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/dataset/statistics": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last task run's dataset statistics
+ * @description Returns statistics for the last Actor task run's default dataset.
+ *
+ * This endpoint is a shortcut that resolves the last task run's `defaultDatasetId` and proxies to the
+ * [Get dataset statistics](https://docs.apify.com/api/v2/dataset-statistics-get) endpoint.
+ */
+ get: operations["actorTask_runs_last_dataset_statistics_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/key-value-store": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last task run's default store
+ * @description Gets an object that contains all the details about the default key-value store of the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
+ * [Get store](https://docs.apify.com/api/v2/key-value-store-get) endpoint.
+ */
+ get: operations["actorTask_runs_last_keyValueStore_get"];
+ /**
+ * Update last task run's default store
+ * @description Updates the default key-value store associated with the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
+ * [Update store](https://docs.apify.com/api/v2/key-value-store-put) endpoint.
+ */
+ put: operations["actorTask_runs_last_keyValueStore_put"];
+ post?: never;
+ /**
+ * Delete last task run's default store
+ * @description Deletes the default key-value store of the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
+ * [Delete store](https://docs.apify.com/api/v2/key-value-store-delete) endpoint.
+ */
+ delete: operations["actorTask_runs_last_keyValueStore_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/key-value-store/keys": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last task run's default store's list of keys
+ * @description Returns a list of keys for the default key-value store of the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
+ * [Get list of keys](https://docs.apify.com/api/v2/key-value-store-keys-get) endpoint.
+ */
+ get: operations["actorTask_runs_last_keyValueStore_keys_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/key-value-store/records": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Download last task run's default store's records
+ * @description Downloads all records from the default key-value store of the last Actor task run as a ZIP archive.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
+ * [Download records](https://docs.apify.com/api/v2/key-value-store-records-get) endpoint.
+ */
+ get: operations["actorTask_runs_last_keyValueStore_records_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/key-value-store/records/{recordKey}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last task run's default store's record
+ * @description Gets a value stored under a specific key in the default key-value store of the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
+ * [Get record](https://docs.apify.com/api/v2/key-value-store-record-get) endpoint.
+ */
+ get: operations["actorTask_runs_last_keyValueStore_record_get"];
+ /**
+ * Store record in last task run's default store
+ * @description Stores a value under a specific key in the default key-value store of the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
+ * [Store record](https://docs.apify.com/api/v2/key-value-store-record-put) endpoint.
+ */
+ put: operations["actorTask_runs_last_keyValueStore_record_put"];
+ /**
+ * Store record in last task run's default store (POST)
+ * @description Stores a value under a specific key in the default key-value store of the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
+ * [Store record](https://docs.apify.com/api/v2/key-value-store-record-post) endpoint.
+ */
+ post: operations["actorTask_runs_last_keyValueStore_record_post"];
+ /**
+ * Delete last task run's default store's record
+ * @description Removes a record specified by a key from the default key-value store of the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
+ * [Delete record](https://docs.apify.com/api/v2/key-value-store-record-delete) endpoint.
+ */
+ delete: operations["actorTask_runs_last_keyValueStore_record_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/request-queue": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last task run's default request queue
+ * @description Returns the default request queue associated with the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
+ * [Get request queue](https://docs.apify.com/api/v2/request-queue-get) endpoint.
+ */
+ get: operations["actorTask_runs_last_requestQueue_get"];
+ /**
+ * Update last task run's default request queue
+ * @description Updates the default request queue associated with the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
+ * [Update request queue](https://docs.apify.com/api/v2/request-queue-put) endpoint.
+ */
+ put: operations["actorTask_runs_last_requestQueue_put"];
+ post?: never;
+ /**
+ * Delete last task run's default request queue
+ * @description Deletes the default request queue associated with the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
+ * [Delete request queue](https://docs.apify.com/api/v2/request-queue-delete) endpoint.
+ */
+ delete: operations["actorTask_runs_last_requestQueue_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/head": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get last task run's default request queue head
+ * @description Returns the given number of first requests from the default request queue of the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
+ * [Get head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
+ */
+ get: operations["actorTask_runs_last_requestQueue_head_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/head/lock": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Get and lock last task run's default request queue head
+ * @description Returns the given number of first requests from the default request queue of the last Actor task run
+ * and locks them for the given time.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
+ * [Get head and lock](https://docs.apify.com/api/v2/request-queue-head-lock-post) endpoint.
+ */
+ post: operations["actorTask_runs_last_requestQueue_head_lock_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * List last task run's default request queue's requests
+ * @description Returns a list of requests from the default request queue of the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
+ * [List requests](https://docs.apify.com/api/v2/request-queue-requests-get) endpoint.
+ */
+ get: operations["actorTask_runs_last_requestQueue_requests_get"];
+ put?: never;
+ /**
+ * Add request to last task run's default request queue
+ * @description Adds a request to the default request queue of the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
+ * [Add request](https://docs.apify.com/api/v2/request-queue-requests-post) endpoint.
+ */
+ post: operations["actorTask_runs_last_requestQueue_requests_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/batch": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Batch add requests to last task run's default request queue
+ * @description Adds requests to the default request queue of the last Actor task run in batch.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
+ * [Add requests](https://docs.apify.com/api/v2/request-queue-requests-batch-post) endpoint.
+ */
+ post: operations["actorTask_runs_last_requestQueue_requests_batch_post"];
+ /**
+ * Batch delete requests from last task run's default request queue
+ * @description Batch-deletes requests from the default request queue of the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
+ * [Delete requests](https://docs.apify.com/api/v2/request-queue-requests-batch-delete) endpoint.
+ */
+ delete: operations["actorTask_runs_last_requestQueue_requests_batch_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/unlock": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Unlock requests in last task run's default request queue
+ * @description Unlocks requests in the default request queue of the last Actor task run that are currently locked by the client.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
+ * [Unlock requests](https://docs.apify.com/api/v2/request-queue-requests-unlock-post) endpoint.
+ */
+ post: operations["actorTask_runs_last_requestQueue_requests_unlock_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/{requestId}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get request from last task run's default request queue
+ * @description Returns a request from the default request queue of the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
+ * [Get request](https://docs.apify.com/api/v2/request-queue-request-get) endpoint.
+ */
+ get: operations["actorTask_runs_last_requestQueue_request_get"];
+ /**
+ * Update request in last task run's default request queue
+ * @description Updates a request in the default request queue of the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
+ * [Update request](https://docs.apify.com/api/v2/request-queue-request-put) endpoint.
+ */
+ put: operations["actorTask_runs_last_requestQueue_request_put"];
+ post?: never;
+ /**
+ * Delete request from last task run's default request queue
+ * @description Deletes a request from the default request queue of the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
+ * [Delete request](https://docs.apify.com/api/v2/request-queue-request-delete) endpoint.
+ */
+ delete: operations["actorTask_runs_last_requestQueue_request_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/{requestId}/lock": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ /**
+ * Prolong lock on request in last task run's default request queue
+ * @description Prolongs a request lock in the default request queue of the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
+ * [Prolong request lock](https://docs.apify.com/api/v2/request-queue-request-lock-put) endpoint.
+ */
+ put: operations["actorTask_runs_last_requestQueue_request_lock_put"];
+ post?: never;
+ /**
+ * Delete lock on request in last task run's default request queue
+ * @description Deletes a request lock in the default request queue of the last Actor task run.
+ *
+ * This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
+ * [Delete request lock](https://docs.apify.com/api/v2/request-queue-request-lock-delete) endpoint.
+ */
+ delete: operations["actorTask_runs_last_requestQueue_request_lock_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get user runs list
+ * @description Gets a list of all runs for a user. The response is a list of objects, where
+ * each object contains basic information about a single Actor run.
+ *
+ * The endpoint supports pagination using the `limit` and `offset` parameters
+ * and it will not return more than 1000 array elements.
+ *
+ * By default, the records are sorted by the `startedAt` field in ascending
+ * order. Therefore, you can use pagination to incrementally fetch all records while
+ * new ones are still being created. To sort the records in descending order, use
+ * `desc=1` parameter. You can also filter runs by `startedAt`` and `status`` fields ([available
+ * statuses](https://docs.apify.com/platform/actors/running/runs-and-builds#lifecycle)).
+ */
+ get: operations["actorRuns_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get run
+ * @description This is not a single endpoint, but an entire group of endpoints that lets
+ * you retrieve the run or any of its default storages.
+ *
+ * ##### Convenience endpoints for Actor run default storages
+ *
+ * * [Dataset](https://docs.apify.com/api/v2/default-dataset)
+ *
+ * * [Key-value store](https://docs.apify.com/api/v2/default-key-value-store)
+ *
+ * * [Request queue](https://docs.apify.com/api/v2/default-request-queue)
+ *
+ * Gets an object that contains all the details about a
+ * specific run of an Actor.
+ *
+ * By passing the optional `waitForFinish` parameter the API endpoint will synchronously wait
+ * for the run to finish. This is useful to avoid periodic polling when waiting for Actor run to complete.
+ * Note that the first response after completion can still show preliminary `stats`, costs, and event counts.
+ * For stable figures, wait about 10 seconds and call the endpoint again.
+ *
+ * This endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the run. However,
+ * if you access the endpoint without the token, certain attributes, such as `usageUsd` and `usageTotalUsd`, will be hidden.
+ */
+ get: operations["actorRun_get"];
+ /**
+ * Update run
+ * @description This endpoint can be used to update both the run's status message and to configure its general resource access level.
+ *
+ * **Status message:**
+ *
+ * You can set a single status message on your run that will be displayed in
+ * the Apify Console UI. During an Actor run, you will typically do this in order
+ * to inform users of your Actor about the Actor's progress.
+ *
+ * The request body must contain `runId` and `statusMessage` properties. The
+ * `isStatusMessageTerminal` property is optional and it indicates if the
+ * status message is the very last one. In the absence of a status message, the
+ * platform will try to substitute sensible defaults.
+ *
+ * **General resource access:**
+ *
+ * You can also update the run's general resource access setting, which determines who can view the run and its related data.
+ *
+ * Allowed values:
+ *
+ * * `FOLLOW_USER_SETTING` - The run inherits the general access setting from the account level.
+ * * `ANYONE_WITH_ID_CAN_READ` - The run can be viewed anonymously by anyone who has its ID.
+ * * `RESTRICTED` - Only users with explicit access to the resource can access the run.
+ *
+ * When a run is accessible anonymously, all of the run's default storages and logs also become accessible anonymously.
+ */
+ put: operations["actorRun_put"];
+ post?: never;
+ /**
+ * Delete run
+ * @description Delete the run. Only finished runs can be deleted. Only the person or
+ * organization that initiated the run can delete it.
+ */
+ delete: operations["actorRun_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/abort": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Abort run
+ * @description Aborts an Actor run and returns an object that contains all the details
+ * about the run.
+ *
+ * Only runs that are starting or running are aborted. For runs with status
+ * `FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call does nothing.
+ */
+ post: operations["actorRun_abort_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/metamorph": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Metamorph run
+ * @description Transforms an Actor run into a run of another Actor with a new input.
+ *
+ * This is useful if you want to use another Actor to finish the work
+ * of your current Actor run, without the need to create a completely new run
+ * and waiting for its finish.
+ *
+ * For the users of your Actors, the metamorph operation is transparent, they
+ * will just see your Actor got the work done.
+ *
+ * Internally, the system stops the Docker container corresponding to the Actor
+ * run and starts a new container using a different Docker image.
+ *
+ * All the default storages are preserved and the new input is stored under the
+ * `INPUT-METAMORPH-1` key in the same default key-value store.
+ *
+ * For more information, see the [Actor docs](https://docs.apify.com/platform/actors/development/programming-interface/metamorph).
+ */
+ post: operations["actorRun_metamorph_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/reboot": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Reboot run
+ * @description Reboots an Actor run and returns an object that contains all the details
+ * about the rebooted run.
+ *
+ * Only runs that are running, i.e. runs with status `RUNNING` can be rebooted.
+ *
+ * The run's container will be restarted, so any data not persisted in the
+ * key-value store, dataset, or request queue will be lost.
+ */
+ post: operations["actorRun_reboot_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/resurrect": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Resurrect run
+ * @description Resurrects a finished Actor run and returns an object that contains all the details about the resurrected run.
+ * Only finished runs, i.e. runs with status `FINISHED`, `FAILED`, `ABORTED` and `TIMED-OUT` can be resurrected.
+ * Run status will be updated to RUNNING and its container will be restarted with the same storages
+ * (the same behaviour as when the run gets migrated to the new server).
+ *
+ * For more information, see the [Actor docs](https://docs.apify.com/platform/actors/running/runs-and-builds#resurrection-of-finished-run).
+ */
+ post: operations["PostResurrectRun"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/charge": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Charge events in run
+ * @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).
+ * 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,
+ * 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.
+ *
+ * :::info Learn more about pay-per-event pricing
+ *
+ * For more details about pay-per-event (PPE) pricing, refer to our [PPE documentation](https://docs.apify.com/actors/publishing/monetize/pay-per-event).
+ *
+ * :::
+ */
+ post: operations["PostChargeRun"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/dataset": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get default dataset
+ * @description Returns the default dataset associated with an Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultDatasetId` and then using the
+ * [Get dataset](https://docs.apify.com/api/v2/dataset-get) endpoint.
+ */
+ get: operations["actorRun_dataset_get"];
+ /**
+ * Update default dataset
+ * @description Updates the default dataset associated with an Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultDatasetId` and then using the
+ * [Put dataset](https://docs.apify.com/api/v2/dataset-put) endpoint.
+ */
+ put: operations["actorRun_dataset_put"];
+ post?: never;
+ /**
+ * Delete default dataset
+ * @description Deletes default dataset associated with an Actor run.
+ *
+ * This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
+ * [ Delete dataset ](https://docs.apify.com/api/v2/dataset-delete) endpoint.
+ */
+ delete: operations["actorRun_dataset_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/dataset/items": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get default dataset items
+ * @description Returns data stored in the default dataset of the Actor run in the desired format.
+ *
+ * This endpoint is a shortcut that resolves the run's `defaultDatasetId` and proxies to the
+ * [Get dataset items](https://docs.apify.com/api/v2/dataset-items-get) endpoint.
+ */
+ get: operations["actorRun_dataset_items_get"];
+ put?: never;
+ /**
+ * Store items
+ * @description Appends an item or an array of items to the end of the Actor run's default dataset.
+ *
+ * This endpoint is a shortcut that resolves the run's `defaultDatasetId` and proxies to the
+ * [Store items](https://docs.apify.com/api/v2/dataset-items-post) endpoint.
+ *
+ * To save bandwidth and speed up your upload, you can send the request payload compressed and set the `Content-Encoding` header accordingly.
+ *
+ * Below is a list of supported `Content-Encoding` types.
+ *
+ * * Brotli: `Content-Encoding: br`
+ * * Gzip: `Content-Encoding: gzip`
+ * * Deflate: `Content-Encoding: deflate`
+ */
+ post: operations["actorRun_dataset_items_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/dataset/statistics": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get default dataset statistics
+ * @description Returns statistics for the Actor run's default dataset.
+ *
+ * This endpoint is a shortcut that resolves the run's `defaultDatasetId` and proxies to the
+ * [Get dataset statistics](https://docs.apify.com/api/v2/dataset-statistics-get) endpoint.
+ */
+ get: operations["actorRun_dataset_statistics_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/key-value-store": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get default store
+ * @description Gets an object that contains all the details about the default key-value
+ * store.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
+ * [Get store](https://docs.apify.com/api/v2/key-value-store-get) endpoint.
+ */
+ get: operations["actorRun_keyValueStore_get"];
+ /**
+ * Update default store
+ * @description Updates the default key-value store's name and general resource access level using a value specified by a JSON object
+ * passed in the PUT payload.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
+ * [Update store](https://docs.apify.com/api/v2/key-value-store-put) endpoint.
+ */
+ put: operations["actorRun_keyValueStore_put"];
+ post?: never;
+ /**
+ * Delete default store
+ * @description Delete the default key-value store.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
+ * [Delete store](https://docs.apify.com/api/v2/key-value-store-delete) endpoint.
+ */
+ delete: operations["actorRun_keyValueStore_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/key-value-store/keys": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get default store's list of keys
+ * @description Returns a list of keys for the default key-value store of the Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
+ * [Get list of keys](https://docs.apify.com/api/v2/key-value-store-keys-get) endpoint.
+ */
+ get: operations["actorRun_keyValueStore_keys_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/key-value-store/records": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Download default store's records
+ * @description Downloads all records from the default key-value store of the Actor run as a ZIP archive.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
+ * [Download records](https://docs.apify.com/api/v2/key-value-store-records-get) endpoint.
+ */
+ get: operations["actorRun_keyValueStore_records_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/key-value-store/records/{recordKey}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get default store's record
+ * @description Gets a value stored under a specific key in the default key-value store of the Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
+ * [Get record](https://docs.apify.com/api/v2/key-value-store-record-get) endpoint.
+ */
+ get: operations["actorRun_keyValueStore_record_get"];
+ /**
+ * Store record in default store
+ * @description Stores a value under a specific key in the default key-value store of the Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
+ * [Store record](https://docs.apify.com/api/v2/key-value-store-record-put) endpoint.
+ */
+ put: operations["actorRun_keyValueStore_record_put"];
+ /**
+ * Store record in default store (POST)
+ * @description Stores a value under a specific key in the default key-value store of the Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
+ * [Store record](https://docs.apify.com/api/v2/key-value-store-record-post) endpoint.
+ */
+ post: operations["actorRun_keyValueStore_record_post"];
+ /**
+ * Delete default store's record
+ * @description Removes a record specified by a key from the default key-value store of the Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
+ * [Delete record](https://docs.apify.com/api/v2/key-value-store-record-delete) endpoint.
+ */
+ delete: operations["actorRun_keyValueStore_record_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/request-queue": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get default request queue
+ * @description Returns the default request queue associated with an Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
+ * [Get request queue](https://docs.apify.com/api/v2/request-queue-get) endpoint.
+ */
+ get: operations["actorRun_requestQueue_get"];
+ /**
+ * Update default request queue
+ * @description Updates the default request queue associated with an Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
+ * [Update request queue](https://docs.apify.com/api/v2/request-queue-put) endpoint.
+ */
+ put: operations["actorRun_requestQueue_put"];
+ post?: never;
+ /**
+ * Delete default request queue
+ * @description Deletes the default request queue associated with an Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
+ * [Delete request queue](https://docs.apify.com/api/v2/request-queue-delete) endpoint.
+ */
+ delete: operations["actorRun_requestQueue_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/request-queue/requests": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * List default request queue's requests
+ * @description Returns a list of requests from the default request queue of the Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
+ * [List requests](https://docs.apify.com/api/v2/request-queue-requests-get) endpoint.
+ */
+ get: operations["actorRun_requestQueue_requests_get"];
+ put?: never;
+ /**
+ * Add request to default request queue
+ * @description Adds a request to the default request queue of the Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
+ * [Add request](https://docs.apify.com/api/v2/request-queue-requests-post) endpoint.
+ */
+ post: operations["actorRun_requestQueue_requests_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/request-queue/requests/batch": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Batch add requests to default request queue
+ * @description Adds requests to the default request queue of the Actor run in batch.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
+ * [Add requests](https://docs.apify.com/api/v2/request-queue-requests-batch-post) endpoint.
+ */
+ post: operations["actorRun_requestQueue_requests_batch_post"];
+ /**
+ * Batch delete requests from default request queue
+ * @description Batch-deletes requests from the default request queue of the Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
+ * [Delete requests](https://docs.apify.com/api/v2/request-queue-requests-batch-delete) endpoint.
+ */
+ delete: operations["actorRun_requestQueue_requests_batch_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/request-queue/requests/unlock": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Unlock requests in default request queue
+ * @description Unlocks requests in the default request queue of the Actor run that are currently locked by the client.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
+ * [Unlock requests](https://docs.apify.com/api/v2/request-queue-requests-unlock-post) endpoint.
+ */
+ post: operations["actorRun_requestQueue_requests_unlock_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/request-queue/requests/{requestId}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get request from default request queue
+ * @description Returns a request from the default request queue of the Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
+ * [Get request](https://docs.apify.com/api/v2/request-queue-request-get) endpoint.
+ */
+ get: operations["actorRun_requestQueue_request_get"];
+ /**
+ * Update request in default request queue
+ * @description Updates a request in the default request queue of the Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
+ * [Update request](https://docs.apify.com/api/v2/request-queue-request-put) endpoint.
+ */
+ put: operations["actorRun_requestQueue_request_put"];
+ post?: never;
+ /**
+ * Delete request from default request queue
+ * @description Deletes a request from the default request queue of the Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
+ * [Delete request](https://docs.apify.com/api/v2/request-queue-request-delete) endpoint.
+ */
+ delete: operations["actorRun_requestQueue_request_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/request-queue/requests/{requestId}/lock": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ /**
+ * Prolong lock on request in default request queue
+ * @description Prolongs a request lock in the default request queue of the Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
+ * [Prolong request lock](https://docs.apify.com/api/v2/request-queue-request-lock-put) endpoint.
+ */
+ put: operations["actorRun_requestQueue_request_lock_put"];
+ post?: never;
+ /**
+ * Delete lock on request in default request queue
+ * @description Deletes a request lock in the default request queue of the Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
+ * [Delete request lock](https://docs.apify.com/api/v2/request-queue-request-lock-delete) endpoint.
+ */
+ delete: operations["actorRun_requestQueue_request_lock_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/request-queue/head": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get default request queue head
+ * @description Returns the given number of first requests from the default request queue of the Actor run.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
+ * [Get head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
+ */
+ get: operations["actorRun_requestQueue_head_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/request-queue/head/lock": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Get and lock default request queue head
+ * @description Returns the given number of first requests from the default request queue of the Actor run
+ * and locks them for the given time.
+ *
+ * This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
+ * [Get head and lock](https://docs.apify.com/api/v2/request-queue-head-lock-post) endpoint.
+ */
+ post: operations["actorRun_requestQueue_head_lock_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-runs/{runId}/log": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get run's log
+ * @description Retrieves Actor run's logs.
+ *
+ * This endpoint is a shortcut for getting the run's log. Same as [Get log](https://docs.apify.com/api/v2/log-get) endpoint.
+ */
+ get: operations["actorRun_log_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-builds": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get user builds list
+ * @description Gets a list of all builds for a user. The response is a JSON array of
+ * objects, where each object contains basic information about a single build.
+ *
+ * The endpoint supports pagination using the `limit` and `offset` parameters
+ * and it will not return more than 1000 records.
+ *
+ * By default, the records are sorted by the `startedAt` field in ascending
+ * order. Therefore, you can use pagination to incrementally fetch all builds while
+ * new ones are still being started. To sort the records in descending order, use
+ * the `desc=1` parameter.
+ */
+ get: operations["actorBuilds_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-builds/{buildId}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get build
+ * @description Gets an object that contains all the details about a specific build of an
+ * Actor.
+ *
+ * By passing the optional `waitForFinish` parameter the API endpoint will
+ * synchronously wait for the build to finish. This is useful to avoid periodic
+ * polling when waiting for an Actor build to finish.
+ *
+ * This endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the build. However,
+ * if you access the endpoint without the token, certain attributes, such as `usageUsd` and `usageTotalUsd`, will be hidden.
+ */
+ get: operations["actorBuild_get"];
+ put?: never;
+ post?: never;
+ /**
+ * Delete build
+ * @description Delete the build. The build that is the current default build for the Actor
+ * cannot be deleted.
+ *
+ * Only users with build permissions for the Actor can delete builds.
+ */
+ delete: operations["actorBuild_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-builds/{buildId}/abort": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Abort build
+ * @description Aborts an Actor build and returns an object that contains all the details
+ * about the build.
+ *
+ * Only builds that are starting or running are aborted. For builds with status
+ * `FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call does nothing.
+ */
+ post: operations["actorBuild_abort_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-builds/{buildId}/log": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get build's Log
+ * @description Retrieves Actor build's logs.
+ *
+ * This endpoint is a shortcut for getting the build's log. Same as [Get log](https://docs.apify.com/api/v2/log-get) endpoint.
+ */
+ get: operations["actorBuild_log_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/actor-builds/{buildId}/openapi.json": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get OpenAPI definition
+ * @description Get the OpenAPI definition for Actor builds. Two similar endpoints are available:
+ *
+ * - [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.
+ * - [Second endpoint](https://docs.apify.com/api/v2/actor-build-openapi-json-get): Requires only `buildId`.
+ *
+ * Get the OpenAPI definition for a specific Actor build.
+ * Authentication is based on the build's unique ID. No authentication token is required.
+ *
+ * :::note
+ *
+ * You can also use the [`/api/v2/actor-openapi-json-get`](https://docs.apify.com/api/v2/actor-openapi-json-get) endpoint to get the OpenAPI definition for a build.
+ *
+ * :::
+ */
+ get: operations["actorBuild_openapi_json_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/key-value-stores": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get list of key-value stores
+ * @description Gets the list of key-value stores owned by the user.
+ *
+ * The response is a list of objects, where each objects contains a basic
+ * information about a single key-value store.
+ *
+ * The endpoint supports pagination using the `limit` and `offset` parameters
+ * and it will not return more than 1000 array elements.
+ *
+ * By default, the records are sorted by the `createdAt` field in ascending
+ * order, therefore you can use pagination to incrementally fetch all key-value stores
+ * while new ones are still being created. To sort the records in descending order, use
+ * the `desc=1` parameter.
+ */
+ get: operations["keyValueStores_get"];
+ put?: never;
+ /**
+ * Create key-value store
+ * @description Creates a key-value store and returns its object. The response is the same
+ * object as returned by the [Get store](#/reference/key-value-stores/store-object/get-store)
+ * endpoint.
+ *
+ * Keep in mind that data stored under unnamed store follows [data retention
+ * period](https://docs.apify.com/platform/storage#data-retention).
+ *
+ * It creates a store with the given name if the parameter name is used.
+ * If there is another store with the same name, the endpoint does not create a
+ * new one and returns the existing object instead.
+ */
+ post: operations["keyValueStores_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/key-value-stores/{storeId}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get store
+ * @description Gets an object that contains all the details about a specific key-value
+ * store.
+ */
+ get: operations["keyValueStore_get"];
+ /**
+ * Update store
+ * @description Updates a key-value store's name and general resource access level using a value specified by a JSON object
+ * passed in the PUT payload.
+ *
+ * The response is the updated key-value store object, as returned by the [Get
+ * store](#/reference/key-value-stores/store-object/get-store) API endpoint.
+ */
+ put: operations["keyValueStore_put"];
+ post?: never;
+ /**
+ * Delete store
+ * @description Deletes a key-value store.
+ */
+ delete: operations["keyValueStore_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/key-value-stores/{storeId}/keys": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get list of keys
+ * @description Returns a list of objects describing keys of a given key-value store, as
+ * well as some information about the values (e.g. size).
+ *
+ * This endpoint is paginated using `exclusiveStartKey` and `limit` parameters
+ * - see [Pagination](https://docs.apify.com/api/v2#using-key) for more details.
+ */
+ get: operations["keyValueStore_keys_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/key-value-stores/{storeId}/records": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Download records
+ * @description Downloads all records from the key-value store as a ZIP archive.
+ * Each record is stored as a separate file in the archive, with the filename equal to the record key.
+ *
+ * You can optionally filter the records by `collection` or `prefix` to download only a subset of the store.
+ */
+ get: operations["keyValueStore_records_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/key-value-stores/{storeId}/records/{recordKey}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get record
+ * @description Gets a value stored in the key-value store under a specific key.
+ *
+ * The response body has the same `Content-Encoding` header as it was set in
+ * [Put record](#tag/Key-value-storesRecord/operation/keyValueStore_record_put).
+ *
+ * If the request does not define the `Accept-Encoding` HTTP header with the
+ * right encoding, the record will be decompressed.
+ *
+ * Most HTTP clients support decompression by default. After using the HTTP
+ * client with decompression support, the `Accept-Encoding` header is set by
+ * the client and body is decompressed automatically.
+ *
+ * Please note that for security reasons, Apify API can perform small modifications
+ * to HTML documents before they are served via this endpoint. To fetch the raw HTML
+ * content without any modifications, use the `attachment` query parameter.
+ */
+ get: operations["keyValueStore_record_get"];
+ /**
+ * Store record
+ * @description Stores a value under a specific key to the key-value store.
+ *
+ * The value is passed as the PUT payload and it is stored with a MIME content
+ * type defined by the `Content-Type` header and with encoding defined by the
+ * `Content-Encoding` header.
+ *
+ * To save bandwidth, storage, and speed up your upload, send the request
+ * payload compressed with Gzip compression and add the `Content-Encoding: gzip`
+ * header. It is possible to set up another compression type with `Content-Encoding`
+ * request header.
+ *
+ * Below is a list of supported `Content-Encoding` types.
+ *
+ * * Brotli compression: `Content-Encoding: br`
+ * * Gzip compression: `Content-Encoding: gzip`
+ * * Deflate compression: `Content-Encoding: deflate`
+ */
+ put: operations["keyValueStore_record_put"];
+ /**
+ * Store record (POST)
+ * @description Stores a value under a specific key to the key-value store.
+ *
+ * This endpoint is an alias for the [`PUT` record](#tag/Key-value-storesRecord/operation/keyValueStore_record_put) method and behaves identically.
+ */
+ post: operations["keyValueStore_record_post"];
+ /**
+ * Delete record
+ * @description Removes a record specified by a key from the key-value store.
+ */
+ delete: operations["keyValueStore_record_delete"];
+ options?: never;
+ /**
+ * Check if a record exists
+ * @description Check if a value is stored in the key-value store under a specific key.
+ */
+ head: operations["keyValueStore_record_head"];
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/datasets": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get list of datasets
+ * @description Lists all of a user's datasets.
+ *
+ * The response is a JSON array of objects,
+ * where each object contains basic information about one dataset.
+ *
+ * By default, the objects are sorted by the `createdAt` field in ascending
+ * order, therefore you can use pagination to incrementally fetch all datasets while new
+ * ones are still being created. To sort them in descending order, use `desc=1`
+ * parameter. The endpoint supports pagination using `limit` and `offset`
+ * parameters and it will not return more than 1000 array elements.
+ */
+ get: operations["datasets_get"];
+ put?: never;
+ /**
+ * Create dataset
+ * @description Creates a dataset and returns its object.
+ * Keep in mind that data stored under unnamed dataset follows [data retention period](https://docs.apify.com/platform/storage#data-retention).
+ * It creates a dataset with the given name if the parameter name is used.
+ * If a dataset with the given name already exists then returns its object.
+ */
+ post: operations["datasets_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/datasets/{datasetId}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get dataset
+ * @description Returns dataset object for given dataset ID.
+ *
+ * This does not return dataset items, only information about the storage itself.
+ * To retrieve dataset items, use the [List dataset items](https://docs.apify.com/api/v2/dataset-items-get) endpoint.
+ *
+ * :::note
+ *
+ * Keep in mind that attributes `itemCount` and `cleanItemCount` are not propagated right away after data are pushed into a dataset.
+ *
+ * :::
+ *
+ * There is a short period (up to 5 seconds) during which these counters may not match with exact counts in dataset items.
+ */
+ get: operations["dataset_get"];
+ /**
+ * Update dataset
+ * @description Updates a dataset's name and general resource access level using a value specified by a JSON object passed in the PUT payload.
+ * The response is the updated dataset object, as returned by the [Get dataset](https://docs.apify.com/api/v2/dataset-get) API endpoint.
+ */
+ put: operations["dataset_put"];
+ post?: never;
+ /**
+ * Delete dataset
+ * @description Deletes a specific dataset.
+ */
+ delete: operations["dataset_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/datasets/{datasetId}/items": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get dataset items
+ * @description Returns data stored in the dataset in a desired format.
+ *
+ * ### Response format
+ *
+ * The format of the response depends on format query parameter.
+ *
+ * The format parameter can have one of the following values:
+ * json, jsonl, xml, html,
+ * csv, xlsx and rss.
+ *
+ * The following table describes how each format is treated.
+ *
+ * | Format | + *Items | + *|
|---|---|---|
json |
+ * The response is a JSON, JSONL or XML array of raw item objects. | + *|
jsonl |
+ * ||
xml |
+ * ||
html |
+ * The response is a HTML, CSV or XLSX table, where columns correspond to the + * properties of the item and rows correspond to each dataset item. | + *|
csv |
+ * ||
xlsx |
+ * ||
rss |
+ * The response is a RSS file. Each item is displayed as child elements of one
+ * <item>. |
+ * |
xmlRoot and xmlRow url parameters.
+ *
+ * ### Pagination
+ *
+ * The generated response supports [pagination](#/introduction/pagination).
+ * The pagination is always performed with the granularity of a single item, regardless whether unwind parameter was provided.
+ * By default, the **Items** in the response are sorted by the time they were stored to the database, therefore you can use pagination to incrementally fetch the items as they are being added.
+ * No limit exists to how many items can be returned in one response.
+ *
+ * If you specify `desc=1` query parameter, the results are returned in the reverse order than they were stored (i.e. from newest to oldest items).
+ * Note that only the order of **Items** is reversed, but not the order of the `unwind` array elements.
+ */
+ get: operations["dataset_items_get"];
+ put?: never;
+ /**
+ * Store items
+ * @description Appends an item or an array of items to the end of the dataset.
+ * The POST payload is a JSON object or a JSON array of objects to save into the dataset.
+ *
+ * If the data you attempt to store in the dataset is invalid (meaning any of the items received by the API fails the validation), the whole request is discarded and the API will return a response with status code 400.
+ * For more information about dataset schema validation, see [Dataset schema](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation).
+ *
+ * **IMPORTANT:** The limit of request payload size for the dataset is 5 MB. If the array exceeds the size, you'll need to split it into a number of smaller arrays.
+ *
+ * To save bandwidth and speed up your upload, you can send the request payload compressed and set the `Content-Encoding` header accordingly.
+ *
+ * Below is a list of supported `Content-Encoding` types.
+ *
+ * * Brotli: `Content-Encoding: br`
+ * * Gzip: `Content-Encoding: gzip`
+ * * Deflate: `Content-Encoding: deflate`
+ */
+ post: operations["dataset_items_post"];
+ delete?: never;
+ options?: never;
+ /**
+ * Get dataset items headers
+ * @description Returns only the HTTP headers for the dataset items endpoint, without the response body.
+ * This is useful to check pagination metadata or verify access without downloading the full dataset.
+ */
+ head: operations["dataset_items_head"];
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/datasets/{datasetId}/statistics": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get dataset statistics
+ * @description Returns statistics for given dataset.
+ *
+ * Provides only [field statistics](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation#dataset-field-statistics).
+ */
+ get: operations["dataset_statistics_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/request-queues": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get list of request queues
+ * @description Lists all of a user's request queues. The response is a JSON array of
+ * objects, where each object
+ * contains basic information about one queue.
+ *
+ * By default, the objects are sorted by the `createdAt` field in ascending order,
+ * therefore you can use pagination to incrementally fetch all queues while new
+ * ones are still being created. To sort them in descending order, use `desc=1`
+ * parameter. The endpoint supports pagination using `limit` and `offset`
+ * parameters and it will not return more than 1000
+ * array elements.
+ */
+ get: operations["requestQueues_get"];
+ put?: never;
+ /**
+ * Create request queue
+ * @description Creates a request queue and returns its object.
+ * Keep in mind that requests stored under unnamed queue follows [data
+ * retention period](https://docs.apify.com/platform/storage#data-retention).
+ *
+ * It creates a queue of given name if the parameter name is used. If a queue
+ * with the given name already exists then the endpoint returns
+ * its object.
+ */
+ post: operations["requestQueues_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/request-queues/{queueId}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get request queue
+ * @description Returns queue object for given queue ID.
+ */
+ get: operations["requestQueue_get"];
+ /**
+ * Update request queue
+ * @description Updates a request queue's name and general resource access level using a value specified by a JSON object
+ * passed in the PUT payload.
+ *
+ * The response is the updated request queue object, as returned by the
+ * [Get request queue](#/reference/request-queues/queue-collection/get-request-queue) API endpoint.
+ */
+ put: operations["requestQueue_put"];
+ post?: never;
+ /**
+ * Delete request queue
+ * @description Deletes given queue.
+ */
+ delete: operations["requestQueue_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/request-queues/{queueId}/requests/batch": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Add requests
+ * @description Adds requests to the queue in batch. The maximum requests in batch is limited
+ * to 25. The response contains an array of unprocessed and processed requests.
+ * If any add operation fails because the request queue rate limit is exceeded
+ * or an internal failure occurs,
+ * the failed request is returned in the unprocessedRequests response
+ * parameter.
+ * You can resend these requests to add. It is recommended to use an
+ * exponential backoff algorithm for these retries.
+ * If a request with the same `uniqueKey` was already present in the queue,
+ * then it returns an ID of the existing request.
+ */
+ post: operations["requestQueue_requests_batch_post"];
+ /**
+ * Delete requests
+ * @description Batch-deletes given requests from the queue. The number of requests in a
+ * batch is limited to 25. The response contains an array of unprocessed and
+ * processed requests.
+ * If any delete operation fails because the request queue rate limit is
+ * exceeded or an internal failure occurs,
+ * the failed request is returned in the `unprocessedRequests` response
+ * parameter.
+ * You can re-send these delete requests. It is recommended to use an
+ * exponential backoff algorithm for these retries.
+ * Each request is identified by its ID or uniqueKey parameter. You can use
+ * either of them to identify the request.
+ */
+ delete: operations["requestQueue_requests_batch_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/request-queues/{queueId}/requests/unlock": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Unlock requests
+ * @description Unlocks requests in the queue that are currently locked by the client.
+ *
+ * * 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.
+ * * If the client is outside of an Actor run, it unlocks all requests locked using the same clientKey.
+ */
+ post: operations["requestQueue_requests_unlock_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/request-queues/{queueId}/requests": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * List requests
+ * @description Returns a list of requests. This endpoint is paginated using
+ * cursor (pagination by `exclusiveStartId` is deprecated) and limit parameters.
+ */
+ get: operations["requestQueue_requests_get"];
+ put?: never;
+ /**
+ * Add request
+ * @description Adds request to the queue. Response contains ID of the request and info if
+ * request was already present in the queue or handled.
+ *
+ * If request with same `uniqueKey` was already present in the queue then
+ * returns an ID of existing request.
+ */
+ post: operations["requestQueue_requests_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/request-queues/{queueId}/requests/{requestId}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get request
+ * @description Returns request from queue.
+ */
+ get: operations["requestQueue_request_get"];
+ /**
+ * Update request
+ * @description Updates a request in a queue. Mark request as handled by setting
+ * `request.handledAt = new Date()`.
+ * If `handledAt` is set, the request will be removed from head of the queue (and unlocked, if applicable).
+ */
+ put: operations["requestQueue_request_put"];
+ post?: never;
+ /**
+ * Delete request
+ * @description Deletes given request from queue.
+ */
+ delete: operations["requestQueue_request_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/request-queues/{queueId}/head": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get head
+ * @description Returns given number of first requests from the queue.
+ *
+ * The response contains the `hadMultipleClients` boolean field which indicates
+ * that the queue was accessed by more than one client (with unique or empty
+ * `clientKey`).
+ * This field is used by [Apify SDK](https://sdk.apify.com) to determine
+ * whether the local cache is consistent with the request queue, and thus
+ * optimize performance of certain operations.
+ */
+ get: operations["requestQueue_head_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/request-queues/{queueId}/head/lock": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Get head and lock
+ * @description Returns the given number of first requests from the queue and locks them for
+ * the given time.
+ *
+ * If this endpoint locks the request, no other client or run will be able to get and
+ * lock these requests.
+ *
+ * The response contains the `hadMultipleClients` boolean field which indicates
+ * that the queue was accessed by more than one client (with unique or empty
+ * `clientKey`).
+ */
+ post: operations["requestQueue_head_lock_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/request-queues/{queueId}/requests/{requestId}/lock": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ /**
+ * Prolong request lock
+ * @description Prolongs request lock. The request lock can be prolonged only by the client
+ * that has locked it using [Get and lock head
+ * operation](#/request-queue-head-lock-post).
+ *
+ * The clientKey identifier is used for locking and unlocking requests.
+ * You can delete or prolong the lock only for requests that were locked by the same client key or from the same Actor run.
+ */
+ put: operations["requestQueue_request_lock_put"];
+ post?: never;
+ /**
+ * Delete request lock
+ * @description Deletes a request lock. The request lock can be deleted only by the client
+ * that has locked it using [Get and lock head
+ * operation](#/request-queue-head-lock-post).
+ *
+ * The clientKey identifier is used for locking and unlocking requests.
+ * You can delete or prolong the lock only for requests that were locked by the same client key or from the same Actor run.
+ */
+ delete: operations["requestQueue_request_lock_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/webhooks": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get list of webhooks
+ * @description Gets the list of webhooks that the user created.
+ *
+ * The endpoint supports pagination using the `limit` and `offset` parameters
+ * and it will not return more than 1000 records.
+ * By default, the records are sorted by the `createdAt` field in ascending
+ * order. To sort the records in descending order, use the `desc=1`
+ * parameter.
+ */
+ get: operations["webhooks_get"];
+ put?: never;
+ /**
+ * Create webhook
+ * @description Creates a new webhook with settings provided by the webhook object passed as
+ * JSON in the payload.
+ * The response is the created webhook object.
+ *
+ * To avoid duplicating a webhook, use the `idempotencyKey` parameter in the
+ * request body.
+ * Multiple calls to create a webhook with the same `idempotencyKey` will only
+ * create the webhook with the first call and return the existing webhook on
+ * subsequent calls.
+ * Idempotency keys must be unique, so use a UUID or another random string with
+ * enough entropy.
+ *
+ * To assign the new webhook to an Actor or task, the request body must contain
+ * `requestUrl`, `eventTypes`, and `condition` properties.
+ *
+ * * `requestUrl` is the webhook's target URL, to which data is sent as a POST
+ * request with a JSON payload.
+ * * `eventTypes` is a list of events that will trigger the webhook, e.g. when
+ * the Actor run succeeds.
+ * * `condition` should be an object containing the ID of the Actor or task to
+ * which the webhook will be assigned.
+ * * `payloadTemplate` is a JSON-like string, whose syntax is extended with the
+ * use of variables.
+ * * `headersTemplate` is a JSON-like string, whose syntax is extended with the
+ * use of variables. Following values will be re-written to defaults: "host",
+ * "Content-Type", "X-Apify-Webhook", "X-Apify-Webhook-Dispatch-Id",
+ * "X-Apify-Request-Origin"
+ * * `description` is an optional string.
+ * * `shouldInterpolateStrings` is a boolean indicating whether to interpolate
+ * variables contained inside strings in the `payloadTemplate`
+ *
+ * ```
+ * "isAdHoc" : false,
+ * "requestUrl" : "https://example.com",
+ * "eventTypes" : [
+ * "ACTOR.RUN.SUCCEEDED",
+ * "ACTOR.RUN.ABORTED"
+ * ],
+ * "condition" : {
+ * "actorId": "5sTMwDQywwsLzKRRh",
+ * "actorTaskId" : "W9bs9JE9v7wprjAnJ"
+ * },
+ * "payloadTemplate": "",
+ * "headersTemplate": "",
+ * "description": "my awesome webhook",
+ * "shouldInterpolateStrings": false,
+ * ```
+ *
+ * **Important**: The request must specify the `Content-Type: application/json`
+ * HTTP header.
+ */
+ post: operations["webhooks_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/webhooks/{webhookId}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get webhook
+ * @description Gets webhook object with all details.
+ */
+ get: operations["webhook_get"];
+ /**
+ * Update webhook
+ * @description Updates a webhook using values specified by a webhook object passed as JSON
+ * in the POST payload.
+ * If the object does not define a specific property, its value will not be
+ * updated.
+ *
+ * The response is the full webhook object as returned by the
+ * [Get webhook](#/reference/webhooks/webhook-object/get-webhook) endpoint.
+ *
+ * The request needs to specify the `Content-Type: application/json` HTTP
+ * header!
+ *
+ * When providing your API authentication token, we recommend using the
+ * request's `Authorization` header, rather than the URL. ([More
+ * info](#/introduction/authentication)).
+ */
+ put: operations["webhook_put"];
+ post?: never;
+ /**
+ * Delete webhook
+ * @description Deletes a webhook.
+ */
+ delete: operations["webhook_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/webhooks/{webhookId}/test": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Test webhook
+ * @description Tests a webhook. Creates a webhook dispatch with a dummy payload.
+ */
+ post: operations["webhook_test_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/webhooks/{webhookId}/dispatches": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get collection
+ * @description Gets a given webhook's list of dispatches.
+ */
+ get: operations["webhook_webhookDispatches_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/webhook-dispatches": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get list of webhook dispatches
+ * @description Gets the list of webhook dispatches that the user have.
+ *
+ * The endpoint supports pagination using the `limit` and `offset` parameters
+ * and it will not return more than 1000 records.
+ * By default, the records are sorted by the `createdAt` field in ascending
+ * order. To sort the records in descending order, use the `desc=1`
+ * parameter.
+ */
+ get: operations["webhookDispatches_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/webhook-dispatches/{dispatchId}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get webhook dispatch
+ * @description Gets webhook dispatch object with all details.
+ */
+ get: operations["webhookDispatch_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/schedules": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get list of schedules
+ * @description Gets the list of schedules that the user created.
+ *
+ * The endpoint supports pagination using the `limit` and `offset` parameters.
+ * It will not return more than 1000 records.
+ *
+ * By default, the records are sorted by the `createdAt` field in ascending
+ * order. To sort the records in descending order, use the `desc=1` parameter.
+ */
+ get: operations["schedules_get"];
+ put?: never;
+ /**
+ * Create schedule
+ * @description Creates a new schedule with settings provided by the schedule object passed
+ * as JSON in the payload. The response is the created schedule object.
+ *
+ * The request needs to specify the `Content-Type: application/json` HTTP header!
+ *
+ * When providing your API authentication token, we recommend using the
+ * request's `Authorization` header, rather than the URL. ([More
+ * info](#/introduction/authentication)).
+ */
+ post: operations["schedules_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/schedules/{scheduleId}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get schedule
+ * @description Gets the schedule object with all details.
+ */
+ get: operations["schedule_get"];
+ /**
+ * Update schedule
+ * @description Updates a schedule using values specified by a schedule object passed as
+ * JSON in the POST payload. If the object does not define a specific property,
+ * its value will not be updated.
+ *
+ * The response is the full schedule object as returned by the
+ * [Get schedule](#/reference/schedules/schedule-object/get-schedule) endpoint.
+ *
+ * **The request needs to specify the `Content-Type: application/json` HTTP
+ * header!**
+ *
+ * When providing your API authentication token, we recommend using the
+ * request's `Authorization` header, rather than the URL. ([More
+ * info](#/introduction/authentication)).
+ */
+ put: operations["schedule_put"];
+ post?: never;
+ /**
+ * Delete schedule
+ * @description Deletes a schedule.
+ */
+ delete: operations["schedule_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/schedules/{scheduleId}/log": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get schedule log
+ * @description Gets the schedule log as a JSON array containing information about up to a
+ * 1000 invocations of the schedule.
+ */
+ get: operations["schedule_log_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/store": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get list of Actors in Store
+ * @description Gets the list of public Actors in Apify Store. You can use `search`
+ * parameter to search Actors by string in title, name, description, username
+ * and readme.
+ * If you need detailed info about a specific Actor, use the [Get
+ * Actor](#/reference/actors/actor-object/get-actor) endpoint.
+ *
+ * The endpoint supports pagination using the `limit` and `offset` parameters.
+ * It will not return more than 1,000 records.
+ */
+ get: operations["store_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/logs/{buildOrRunId}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get log
+ * @description Retrieves logs for a specific Actor build or run.
+ */
+ get: operations["log_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/users/{userId}": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get public user data
+ * @description Returns public information about a specific user account, similar to what
+ * can be seen on public profile pages (e.g. https://apify.com/apify).
+ *
+ * This operation requires no authentication token.
+ */
+ get: operations["user_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/users/me": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get private user data
+ * @description Returns information about the current user account, including both public
+ * and private information.
+ *
+ * The user account is identified by the provided authentication token.
+ *
+ * The fields `plan`, `email` and `profile` are omitted when this endpoint is accessed from Actor run.
+ */
+ get: operations["users_me_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/users/me/usage/monthly": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get monthly usage
+ * @description Returns a complete summary of your usage for the current monthly usage cycle,
+ * an overall sum, as well as a daily breakdown of usage. It is the same
+ * information you will see on your account's [Billing > Historical usage page](https://console.apify.com/billing/historical-usage). The information
+ * includes your use of Actors, compute, data transfer, and storage.
+ *
+ * Using the `date` parameter will show your usage in the monthly usage cycle that
+ * includes that date.
+ */
+ get: operations["users_me_usage_monthly_get"];
+ put?: never;
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/users/me/limits": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get limits
+ * @description Returns a complete summary of your account's limits. It is the same
+ * information you will see on your account's [Limits page](https://console.apify.com/billing#/limits). The returned data
+ * includes the current usage cycle, a summary of your limits, and your current usage.
+ */
+ get: operations["users_me_limits_get"];
+ /**
+ * Update limits
+ * @description Updates the account's limits manageable on your account's [Limits page](https://console.apify.com/billing#/limits).
+ * Specifically the: `maxMonthlyUsageUsd` and `dataRetentionDays` limits (see request body schema for more details).
+ */
+ put: operations["users_me_limits_put"];
+ post?: never;
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/browser-info": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ /**
+ * Get browser info
+ * @description Returns information about the HTTP request, including the client IP address,
+ * country code, request headers, and body length.
+ *
+ * This endpoint is designed for proxy testing. It accepts any HTTP method so you
+ * can verify that your proxy correctly forwards requests of any type and that
+ * client IP addresses are anonymized.
+ */
+ get: operations["tools_browser_info_get"];
+ /**
+ * Get browser info
+ * @description Returns information about the HTTP request, including the client IP address,
+ * country code, request headers, and body length.
+ *
+ * This endpoint is designed for proxy testing. It accepts any HTTP method so you
+ * can verify that your proxy correctly forwards requests of any type and that
+ * client IP addresses are anonymized.
+ */
+ put: operations["tools_browser_info_put"];
+ /**
+ * Get browser info
+ * @description Returns information about the HTTP request, including the client IP address,
+ * country code, request headers, and body length.
+ *
+ * This endpoint is designed for proxy testing. It accepts any HTTP method so you
+ * can verify that your proxy correctly forwards requests of any type and that
+ * client IP addresses are anonymized.
+ */
+ post: operations["tools_browser_info_post"];
+ /**
+ * Get browser info
+ * @description Returns information about the HTTP request, including the client IP address,
+ * country code, request headers, and body length.
+ *
+ * This endpoint is designed for proxy testing. It accepts any HTTP method so you
+ * can verify that your proxy correctly forwards requests of any type and that
+ * client IP addresses are anonymized.
+ */
+ delete: operations["tools_browser_info_delete"];
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/tools/encode-and-sign": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Encode and sign object
+ * @description Encodes and signs any JSON object. The encoded value includes a signature
+ * tied to the authenticated user's ID, which can later be verified using the
+ * decode-and-verify endpoint.
+ *
+ * **Important**: The request must specify the `Content-Type: application/json`
+ * HTTP header.
+ */
+ post: operations["tools_encode_and_sign_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+ "/v2/tools/decode-and-verify": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ get?: never;
+ put?: never;
+ /**
+ * Decode and verify object
+ * @description Decodes and verifies an encoded value previously created by the
+ * encode-and-sign endpoint. Returns the original decoded object along with
+ * information about the user who encoded it and whether that user is verified.
+ *
+ * **Important**: The request must specify the `Content-Type: application/json`
+ * HTTP header.
+ */
+ post: operations["tools_decode_and_verify_post"];
+ delete?: never;
+ options?: never;
+ head?: never;
+ patch?: never;
+ trace?: never;
+ };
+}
+export type webhooks = Record