diff --git a/apify-api/openapi/components/schemas/actor-runs/RunOptions.yaml b/apify-api/openapi/components/schemas/actor-runs/RunOptions.yaml index 9bf33a4b1..1edfb5b99 100644 --- a/apify-api/openapi/components/schemas/actor-runs/RunOptions.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/RunOptions.yaml @@ -4,6 +4,8 @@ required: - timeoutSecs - memoryMbytes - diskMbytes + - maxItems + - maxTotalChargeUsd type: object properties: build: @@ -18,3 +20,9 @@ properties: diskMbytes: type: number example: 2048 + maxItems: + type: number + example: 1000 + maxTotalChargeUsd: + type: number + example: 5 diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml index eee73ffa9..db47faac8 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml @@ -58,11 +58,11 @@ get: - name: maxItems in: query description: | - The maximum number of items that the task run should return. This is - useful for pay-per-result tasks, as it allows you to limit the number of - results that will be charged to your subscription. You can access the - maximum number of items in your Actor by using the - `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. + Specifies the maximum number of dataset items that will be charged for pay-per-result Actors. + This does NOT guarantee that the Actor will return only this many items. + It only ensures you won't be charged for more than this number of items. + Only works for pay-per-result Actors. + Value can be accessed in the actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true schema: @@ -451,11 +451,11 @@ post: - name: maxItems in: query description: | - The maximum number of items that the task run should return. This is - useful for pay-per-result tasks, as it allows you to limit the number of - results that will be charged to your subscription. You can access the - maximum number of items in your Actor by using the - `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. + Specifies the maximum number of dataset items that will be charged for pay-per-result Actors. + This does NOT guarantee that the Actor will return only this many items. + It only ensures you won't be charged for more than this number of items. + Only works for pay-per-result Actors. + Value can be accessed in the actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true schema: diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml index 9782b7b5c..98c9db939 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml @@ -55,11 +55,11 @@ get: - name: maxItems in: query description: | - The maximum number of items that the task run should return. This is - useful for pay-per-result tasks, as it allows you to limit the number of - results that will be charged to your subscription. You can access the - maximum number of items in your Actor by using the - `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. + Specifies the maximum number of dataset items that will be charged for pay-per-result Actors. + This does NOT guarantee that the Actor will return only this many items. + It only ensures you won't be charged for more than this number of items. + Only works for pay-per-result Actors. + Value can be accessed in the actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true schema: @@ -198,11 +198,11 @@ post: - name: maxItems in: query description: | - The maximum number of items that the task run should return. This is - useful for pay-per-result tasks, as it allows you to limit the number of - results that will be charged to your subscription. You can access the - maximum number of items in your Actor by using the - `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. + Specifies the maximum number of dataset items that will be charged for pay-per-result Actors. + This does NOT guarantee that the Actor will return only this many items. + It only ensures you won't be charged for more than this number of items. + Only works for pay-per-result Actors. + Value can be accessed in the actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true schema: diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml index 1e9cc1237..8639b27c2 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml @@ -205,10 +205,9 @@ post: in: query description: | Specifies the maximum cost of the Actor run. This parameter is - useful for pay-per-event Actors, as it allows you to limit the amount - charged to your subscription. You can access the - maximum cost in your Actor by using the - `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. + used only for pay-per-event Actors. It allows you to limit the amount + charged to your subscription. You can access the maximum cost in your + Actor by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. style: form explode: true schema: diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml index 3e9bbfdca..e213b5093 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml @@ -78,10 +78,9 @@ post: in: query description: | Specifies the maximum cost of the Actor run. This parameter is - useful for pay-per-event Actors, as it allows you to limit the amount - charged to your subscription. You can access the - maximum cost in your Actor by using the - `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. + used only for pay-per-event Actors. It allows you to limit the amount + charged to your subscription. You can access the maximum cost in your + Actor by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. style: form explode: true schema: @@ -489,10 +488,9 @@ get: in: query description: | Specifies the maximum cost of the Actor run. This parameter is - useful for pay-per-event Actors, as it allows you to limit the amount - charged to your subscription. You can access the - maximum cost in your Actor by using the - `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. + used only for pay-per-event Actors. It allows you to limit the amount + charged to your subscription. You can access the maximum cost in your + Actor by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. style: form explode: true schema: diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml index 209320c11..ac0b651f1 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml @@ -84,10 +84,9 @@ post: in: query description: | Specifies the maximum cost of the Actor run. This parameter is - useful for pay-per-event Actors, as it allows you to limit the amount - charged to your subscription. You can access the - maximum cost in your Actor by using the - `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. + used only for pay-per-event Actors. It allows you to limit the amount + charged to your subscription. You can access the maximum cost in your + Actor by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. style: form explode: true schema: @@ -239,11 +238,11 @@ get: - name: maxItems in: query description: | - The maximum number of items that the Actor run should return. This is - useful for pay-per-result Actors, as it allows you to limit the number - of results that will be charged to your subscription. You can access the - maximum number of items in your Actor by using the - `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. + Specifies the maximum number of dataset items that will be charged for pay-per-result Actors. + This does NOT guarantee that the Actor will return only this many items. + It only ensures you won't be charged for more than this number of items. + Only works for pay-per-result Actors. + Value can be accessed in the actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true schema: @@ -254,10 +253,9 @@ get: in: query description: | Specifies the maximum cost of the Actor run. This parameter is - useful for pay-per-event Actors, as it allows you to limit the amount - charged to your subscription. You can access the - maximum cost in your Actor by using the - `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. + used only for pay-per-event Actors. It allows you to limit the amount + charged to your subscription. You can access the maximum cost in your + Actor by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. style: form explode: true schema: diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml index e2df1ce35..17ba993b9 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml @@ -220,10 +220,9 @@ post: in: query description: | Specifies the maximum cost of the Actor run. This parameter is - useful for pay-per-event Actors, as it allows you to limit the amount - charged to your subscription. You can access the - maximum cost in your Actor by using the - `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. + used only for pay-per-event Actors. It allows you to limit the amount + charged to your subscription. You can access the maximum cost in your + Actor by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. style: form explode: true schema: