apify-client 3.0.0-beta.4 → 3.0.0-beta.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/README.md +3 -1
  2. package/dist/apify_api_error.d.ts +59 -3
  3. package/dist/apify_api_error.js +66 -2
  4. package/dist/base/resource_client.d.ts +4 -3
  5. package/dist/base/resource_client.js +7 -7
  6. package/dist/base/resource_collection_client.d.ts +5 -4
  7. package/dist/base/resource_collection_client.js +9 -9
  8. package/dist/bundle.js +16 -14
  9. package/dist/bundle.js.map +1 -1
  10. package/dist/generated/api.d.ts +287 -214
  11. package/dist/generated/schemas.d.ts +6699 -0
  12. package/dist/generated/schemas.js +1521 -0
  13. package/dist/http_client.js +1 -1
  14. package/dist/index.d.ts +1 -0
  15. package/dist/index.js +1 -0
  16. package/dist/lazy_schema.d.ts +8 -0
  17. package/dist/lazy_schema.js +11 -0
  18. package/dist/models.d.ts +21 -40
  19. package/dist/resource_clients/actor.js +7 -6
  20. package/dist/resource_clients/actor_collection.js +3 -2
  21. package/dist/resource_clients/actor_env_var.js +3 -2
  22. package/dist/resource_clients/actor_env_var_collection.js +3 -2
  23. package/dist/resource_clients/actor_version.js +3 -2
  24. package/dist/resource_clients/actor_version_collection.js +3 -2
  25. package/dist/resource_clients/build.js +5 -4
  26. package/dist/resource_clients/build_collection.js +2 -1
  27. package/dist/resource_clients/dataset.js +5 -4
  28. package/dist/resource_clients/dataset_collection.js +3 -2
  29. package/dist/resource_clients/key_value_store.js +5 -4
  30. package/dist/resource_clients/key_value_store_collection.js +3 -2
  31. package/dist/resource_clients/request_queue.js +24 -16
  32. package/dist/resource_clients/request_queue_collection.js +3 -2
  33. package/dist/resource_clients/run.js +9 -8
  34. package/dist/resource_clients/run_collection.js +2 -1
  35. package/dist/resource_clients/schedule.d.ts +4 -4
  36. package/dist/resource_clients/schedule.js +8 -5
  37. package/dist/resource_clients/schedule_collection.js +3 -2
  38. package/dist/resource_clients/store_collection.js +2 -1
  39. package/dist/resource_clients/task.js +5 -4
  40. package/dist/resource_clients/task_collection.js +3 -2
  41. package/dist/resource_clients/user.js +6 -6
  42. package/dist/resource_clients/webhook.js +5 -4
  43. package/dist/resource_clients/webhook_collection.js +3 -2
  44. package/dist/resource_clients/webhook_dispatch.js +2 -1
  45. package/dist/resource_clients/webhook_dispatch_collection.js +2 -1
  46. package/dist/response_validation_error.d.ts +26 -0
  47. package/dist/response_validation_error.js +37 -0
  48. package/dist/schemas.d.ts +15 -0
  49. package/dist/schemas.js +15 -0
  50. package/dist/utils.d.ts +12 -2
  51. package/dist/utils.js +26 -9
  52. package/package.json +3 -3
@@ -34,8 +34,7 @@ export interface paths {
34
34
  * @description Creates an Actor with the settings specified in an `Actor` object passed as
35
35
  * JSON in the POST payload.
36
36
  *
37
- * Returns the full `Actor` object, the same as the
38
- * [Get Actor](https://docs.apify.com/api/v2/actor-get) endpoint.
37
+ * Returns the created `Actor` object.
39
38
  *
40
39
  * In the HTTP request, set the `Content-Type` header to `application/json`.
41
40
  *
@@ -44,12 +43,10 @@ export interface paths {
44
43
  * An Actor must specify at least one version of the source code.
45
44
  * For details, see [Actor versions](https://docs.apify.com/api/v2/actors-actor-versions).
46
45
  *
47
- * ### Create a public Actor
46
+ * ### Publish an Actor
48
47
  *
49
- * To make your Actor [public](https://docs.apify.com/platform/actors/publishing):
50
- * - Set `isPublic` to `true`.
51
- * - Provide `title` and `categories`. For reference, see [constants from the `apify-shared-js`
52
- * package](https://github.com/apify/apify-shared-js/blob/2d43ebc41ece9ad31cd6525bd523fb86939bf860/packages/consts/src/consts.ts#L452-L471)
48
+ * To make your Actor [public](https://docs.apify.com/platform/actors/publishing),
49
+ * use the [Update Actor](https://docs.apify.com/api/v2/actor-put) endpoint.
53
50
  */
54
51
  post: operations["actors_post"];
55
52
  delete?: never;
@@ -709,11 +706,11 @@ export interface paths {
709
706
  put?: never;
710
707
  /**
711
708
  * Validate Actor input
712
- * @description Validates the provided input against the Actor's input schema for the specified build.
709
+ * @description Validates the JSON payload against the Actor's
710
+ * [input schema](https://docs.apify.com/actors/development/actor-definition/input-schema)
711
+ * defined in the specified build.
713
712
  *
714
- * The endpoint checks whether the JSON payload conforms to the input schema
715
- * defined in the Actor's build. If no `build` query parameter is provided,
716
- * the `latest` build tag is used by default.
713
+ * If the specified build has no input schema, any input is considered valid.
717
714
  */
718
715
  post: operations["actor_validateInput_post"];
719
716
  delete?: never;
@@ -1513,6 +1510,20 @@ export interface paths {
1513
1510
  *
1514
1511
  * If the object does not define a specific property, its value is not updated.
1515
1512
  *
1513
+ * The `publicConfig` field carries the display configuration of the task's public
1514
+ * landing page, and `isPublic` publishes or unpublishes the task itself. Both require
1515
+ * write permission to the task's Actor.
1516
+ *
1517
+ * To publish a task, its Actor must be public, `publicConfig.inputSchemaFields` and
1518
+ * `publicConfig.datasetView` must be set, and the Actor must have fewer than 50 published
1519
+ * tasks. If the task isn't ready to be published, the whole update fails and none of it
1520
+ * is applied.
1521
+ *
1522
+ * Publishing lists the task among the Actor's examples and makes its input public, so anyone
1523
+ * can view and copy it. The landing page itself is shown only while `publicConfig` still
1524
+ * validates against the Actor's current build, so a new build can stop the page from being
1525
+ * offered while the task stays published and copyable.
1526
+ *
1516
1527
  * The response is the full task object as returned by the
1517
1528
  * [Get task](https://docs.apify.com/api/v2/actor-task-get) endpoint.
1518
1529
  *
@@ -4750,7 +4761,7 @@ export interface components {
4750
4761
  * @description Machine-processable error type identifier.
4751
4762
  * @enum {string}
4752
4763
  */
4753
- ErrorType: "3d-secure-auth-failed" | "access-right-already-exists" | "action-not-found" | "actor-already-rented" | "actor-can-not-be-rented" | "actor-disabled" | "actor-is-not-rented" | "actor-memory-limit-exceeded" | "actor-name-exists-new-owner" | "actor-name-not-unique" | "actor-not-found" | "actor-not-github-actor" | "actor-not-public" | "actor-permission-level-not-supported-for-agentic-payments" | "actor-review-already-exists" | "actor-run-failed" | "actor-standby-not-supported-for-agentic-payments" | "actor-task-name-not-unique" | "agentic-payment-info-retrieval-error" | "agentic-payment-information-missing" | "agentic-payment-insufficient-amount" | "agentic-payment-provider-internal-error" | "agentic-payment-provider-unauthorized" | "airtable-webhook-deprecated" | "already-subscribed-to-paid-actor" | "apify-plan-required-to-use-paid-actor" | "apify-signup-not-allowed" | "auth-method-not-supported" | "authorization-server-not-found" | "auto-issue-date-invalid" | "background-check-required" | "billing-system-error" | "black-friday-plan-expired" | "braintree-error" | "braintree-not-linked" | "braintree-operation-timed-out" | "braintree-unsupported-currency" | "build-not-found" | "build-outdated" | "cannot-add-apify-events-to-ppe-actor" | "cannot-add-multiple-pricing-infos" | "cannot-add-pricing-info-that-alters-past" | "cannot-add-second-future-pricing-info" | "cannot-build-actor-from-webhook" | "cannot-change-billing-interval" | "cannot-change-owner" | "cannot-charge-apify-event" | "cannot-charge-non-pay-per-event-actor" | "cannot-comment-as-other-user" | "cannot-copy-actor-task" | "cannot-create-payout" | "cannot-create-public-actor" | "cannot-create-tax-transaction" | "cannot-delete-critical-actor" | "cannot-delete-invoice" | "cannot-delete-paid-actor" | "cannot-disable-one-time-event-for-apify-start-event" | "cannot-disable-organization-with-enabled-members" | "cannot-disable-user-with-subscription" | "cannot-link-oauth-to-unverified-email" | "cannot-metamorph-to-pay-per-result-actor" | "cannot-modify-actor-pricing-too-frequently" | "cannot-modify-actor-pricing-with-immediate-effect" | "cannot-monetize-without-payout-billing-info" | "cannot-override-paid-actor-trial" | "cannot-permanently-delete-subscription" | "cannot-publish-actor" | "cannot-reduce-last-full-token" | "cannot-reimburse-more-than-original-charge" | "cannot-reimburse-non-rental-charge" | "cannot-remove-own-actor-from-recently-used" | "cannot-remove-payment-method" | "cannot-remove-pricing-info" | "cannot-remove-running-run" | "cannot-remove-user-with-public-actors" | "cannot-remove-user-with-subscription" | "cannot-remove-user-with-unpaid-invoice" | "cannot-rename-env-var" | "cannot-rent-paid-actor" | "cannot-review-own-actor" | "cannot-set-access-rights-for-owner" | "cannot-set-is-status-message-terminal" | "cannot-unpublish-critical-actor" | "cannot-unpublish-paid-actor" | "cannot-unpublish-profile" | "cannot-update-invoice-field" | "concurrent-runs-limit-exceeded" | "concurrent-update-detected" | "conference-token-not-found" | "content-encoding-forbidden-for-html" | "coupon-already-redeemed" | "coupon-expired" | "coupon-for-new-customers" | "coupon-for-subscribed-users" | "coupon-limits-are-in-conflict-with-current-limits" | "coupon-max-number-of-redemptions-reached" | "coupon-not-found" | "coupon-not-unique" | "coupons-disabled" | "create-github-issue-not-allowed" | "creator-plan-not-available" | "cron-expression-invalid" | "daily-ai-token-limit-exceeded" | "daily-publication-limit-exceeded" | "dataset-does-not-have-fields-schema" | "dataset-does-not-have-schema" | "dataset-locked" | "dataset-schema-invalid" | "dcr-not-supported" | "default-dataset-not-found" | "deleting-default-build" | "deleting-unfinished-build" | "email-already-taken" | "email-already-taken-removed-user" | "email-domain-not-allowed-for-coupon" | "email-invalid" | "email-not-allowed" | "email-not-valid" | "email-update-too-soon" | "elevated-permissions-needed" | "env-var-already-exists" | "exchange-rate-fetch-failed" | "expired-conference-token" | "failed-to-charge-user" | "final-invoice-negative" | "full-permission-actor-blocked-for-admin" | "full-permission-actor-not-approved" | "github-branch-empty" | "github-issue-already-exists" | "github-public-key-not-found" | "github-repository-not-found" | "github-signature-does-not-match-payload" | "github-user-not-authorized-for-issues" | "gmail-not-allowed" | "id-does-not-match" | "incompatible-billing-interval" | "incomplete-payout-billing-info" | "inconsistent-currencies" | "incorrect-pricing-modifier-prefix" | "input-json-invalid-characters" | "input-json-not-object" | "input-json-too-long" | "input-update-collision" | "insufficient-permissions" | "insufficient-permissions-to-change-field" | "insufficient-security-measures" | "insufficient-tax-country-evidence" | "integration-auth-error" | "internal-server-error" | "invalid-billing-info" | "invalid-billing-period-for-payout" | "invalid-build" | "invalid-client-key" | "invalid-collection" | "invalid-conference-login-password" | "invalid-content-type-header" | "invalid-credentials" | "invalid-git-auth-token" | "invalid-github-issue-url" | "invalid-header" | "invalid-id" | "invalid-idempotency-key" | "invalid-input" | "invalid-input-schema" | "invalid-invoice" | "invalid-invoice-type" | "invalid-issue-date" | "invalid-label-params" | "invalid-main-account-user-id" | "invalid-oauth-app" | "invalid-oauth-scope" | "invalid-one-time-invoice" | "invalid-parameter" | "invalid-payout-status" | "invalid-picture-url" | "invalid-record-key" | "invalid-request" | "invalid-resource-type" | "invalid-signature" | "invalid-subscription-plan" | "invalid-tax-number" | "invalid-tax-number-format" | "invalid-token" | "invalid-token-type" | "invalid-two-factor-code" | "invalid-two-factor-code-or-recovery-code" | "invalid-two-factor-recovery-code" | "invalid-username" | "invalid-value" | "invitation-invalid-resource-type" | "invitation-no-longer-valid" | "invoice-canceled" | "invoice-cannot-be-refunded-due-to-too-high-amount" | "invoice-incomplete" | "invoice-is-draft" | "invoice-locked" | "invoice-must-be-buffer" | "invoice-not-canceled" | "invoice-not-draft" | "invoice-not-found" | "invoice-outdated" | "invoice-paid-already" | "issue-already-connected-to-github" | "issue-not-found" | "issues-bad-request" | "issuer-not-registered" | "job-finished" | "label-already-linked" | "last-api-token" | "limit-reached" | "max-items-must-be-greater-than-zero" | "max-metamorphs-exceeded" | "max-total-charge-usd-below-minimum" | "max-total-charge-usd-must-be-greater-than-zero" | "method-not-allowed" | "migration-disabled" | "missing-actor-rights" | "missing-api-token" | "missing-billing-info" | "missing-line-items" | "missing-payment-date" | "missing-payout-billing-info" | "missing-proxy-password" | "missing-reporting-fields" | "missing-resource-name" | "missing-settings" | "missing-username" | "monthly-usage-limit-too-low" | "more-than-one-update-not-allowed" | "multiple-records-found" | "must-be-admin" | "name-not-unique" | "next-runtime-computation-failed" | "no-columns-in-exported-dataset" | "no-payment-attempt-for-refund-found" | "no-payment-method-available" | "no-team-account-seats-available" | "non-temporary-email" | "not-enough-usage-to-run-paid-actor" | "not-implemented" | "not-supported-currencies" | "o-auth-service-already-connected" | "o-auth-service-not-connected" | "oauth-resource-access-failed" | "one-time-invoice-already-marked-paid" | "only-drafts-can-be-deleted" | "operation-canceled" | "operation-not-allowed" | "operation-timed-out" | "organization-cannot-own-itself" | "organization-role-not-found" | "overlapping-payout-billing-periods" | "own-token-required" | "page-not-found" | "param-not-one-of" | "parameter-required" | "parameters-mismatched" | "password-reset-email-already-sent" | "password-reset-token-expired" | "pay-as-you-go-without-monthly-interval" | "payment-attempt-status-message-required" | "payout-already-paid" | "payout-canceled" | "payout-invalid-state" | "payout-must-be-approved-to-be-marked-paid" | "payout-not-found" | "payout-number-already-exists" | "phone-number-invalid" | "phone-number-landline" | "phone-number-opted-out" | "phone-verification-disabled" | "platform-feature-disabled" | "price-overrides-validation-failed" | "pricing-model-not-supported" | "promotional-plan-not-available" | "proxy-auth-ip-not-unique" | "public-actor-disabled" | "query-timeout" | "quoted-price-outdated" | "rate-limit-exceeded" | "recaptcha-invalid" | "recaptcha-required" | "record-not-found" | "record-not-public" | "record-or-token-not-found" | "record-too-large" | "redirect-uri-mismatch" | "reduced-plan-not-available" | "rental-charge-already-reimbursed" | "rental-not-allowed" | "request-aborted-prematurely" | "request-handled-or-locked" | "request-id-invalid" | "request-queue-duplicate-requests" | "request-too-large" | "requested-dataset-view-does-not-exist" | "resume-token-expired" | "run-failed" | "run-input-body-not-valid-json" | "run-timeout-exceeded" | "russia-is-evil" | "same-user" | "schedule-actor-not-found" | "schedule-actor-task-not-found" | "schedule-name-not-unique" | "schema-validation" | "schema-validation-error" | "schema-validation-failed" | "service-worker-registration-not-allowed" | "sign-up-method-not-allowed" | "slack-integration-not-custom" | "socket-closed" | "socket-destroyed" | "store-schema-invalid" | "store-terms-not-accepted" | "stripe-enabled" | "stripe-generic-decline" | "stripe-not-enabled" | "stripe-not-enabled-for-user" | "tagged-build-required" | "tax-country-invalid" | "tax-number-invalid" | "tax-number-validation-failed" | "taxamo-call-failed" | "taxamo-request-failed" | "testing-error" | "token-not-provided" | "too-few-versions" | "too-many-actor-tasks" | "too-many-actors" | "too-many-labels-on-resource" | "too-many-mcp-connectors" | "too-many-o-auth-apps" | "too-many-organizations" | "too-many-requests" | "too-many-schedules" | "too-many-ui-access-keys" | "too-many-user-labels" | "too-many-values" | "too-many-versions" | "too-many-webhooks" | "unexpected-route" | "unknown-build-tag" | "unknown-payment-provider" | "unsubscribe-token-invalid" | "unsupported-actor-pricing-model-for-agentic-payments" | "unsupported-content-encoding" | "unsupported-file-type-for-issue" | "unsupported-file-type-image-expected" | "unsupported-file-type-text-or-json-expected" | "unsupported-permission" | "upcoming-subscription-bill-not-up-to-date" | "user-already-exists" | "user-already-verified" | "user-creates-organizations-too-fast" | "user-disabled" | "user-email-is-disposable" | "user-email-not-set" | "user-email-not-verified" | "user-has-no-subscription" | "user-integration-not-found" | "user-is-already-invited" | "user-is-already-organization-member" | "user-is-not-member-of-organization" | "user-is-not-organization" | "user-is-organization" | "user-is-organization-owner" | "user-is-removed" | "user-not-found" | "user-not-logged-in" | "user-not-verified" | "user-or-token-not-found" | "user-plan-not-allowed-for-coupon" | "user-problem-with-card" | "user-record-not-found" | "username-already-taken" | "username-missing" | "username-not-allowed" | "username-removal-forbidden" | "username-required" | "verification-email-already-sent" | "verification-token-expired" | "version-already-exists" | "versions-size-exceeded" | "weak-password" | "x402-agentic-payment-already-finalized" | "x402-agentic-payment-insufficient-amount" | "x402-agentic-payment-malformed-token" | "x402-agentic-payment-settlement-failed" | "x402-agentic-payment-settlement-in-progress" | "x402-agentic-payment-settlement-stuck" | "x402-agentic-payment-unauthorized" | "x402-payment-required" | "zero-invoice";
4764
+ ErrorType: "3d-secure-auth-failed" | "access-right-already-exists" | "action-not-found" | "actor-already-rented" | "actor-can-not-be-rented" | "actor-disabled" | "actor-is-not-rented" | "actor-memory-limit-exceeded" | "actor-name-exists-new-owner" | "actor-name-not-unique" | "actor-not-found" | "actor-not-github-actor" | "actor-not-public" | "actor-permission-level-not-supported-for-agentic-payments" | "actor-review-already-exists" | "actor-run-failed" | "actor-standby-not-supported-for-agentic-payments" | "actor-task-name-not-unique" | "agentic-payment-info-retrieval-error" | "agentic-payment-information-missing" | "agentic-payment-insufficient-amount" | "agentic-payment-provider-internal-error" | "agentic-payment-provider-unauthorized" | "airtable-webhook-deprecated" | "already-subscribed-to-paid-actor" | "apify-plan-required-to-use-paid-actor" | "apify-signup-not-allowed" | "auth-method-not-supported" | "authorization-server-not-found" | "auto-issue-date-invalid" | "background-check-required" | "billing-system-error" | "black-friday-plan-expired" | "braintree-error" | "braintree-not-linked" | "braintree-operation-timed-out" | "braintree-unsupported-currency" | "build-not-found" | "build-outdated" | "cannot-add-apify-events-to-ppe-actor" | "cannot-add-multiple-pricing-infos" | "cannot-add-pricing-info-that-alters-past" | "cannot-add-second-future-pricing-info" | "cannot-build-actor-from-webhook" | "cannot-change-billing-interval" | "cannot-change-owner" | "cannot-charge-apify-event" | "cannot-charge-non-pay-per-event-actor" | "cannot-comment-as-other-user" | "cannot-copy-actor-task" | "cannot-create-payout" | "cannot-create-public-actor" | "cannot-create-tax-transaction" | "cannot-delete-critical-actor" | "cannot-delete-invoice" | "cannot-delete-paid-actor" | "cannot-disable-one-time-event-for-apify-start-event" | "cannot-disable-organization-with-enabled-members" | "cannot-disable-user-with-subscription" | "cannot-link-oauth-to-unverified-email" | "cannot-metamorph-to-pay-per-result-actor" | "cannot-modify-actor-pricing-too-frequently" | "cannot-modify-actor-pricing-with-immediate-effect" | "cannot-monetize-without-payout-billing-info" | "cannot-override-paid-actor-trial" | "cannot-permanently-delete-subscription" | "cannot-publish-actor" | "cannot-publish-actor-task" | "cannot-reduce-last-full-token" | "cannot-reimburse-more-than-original-charge" | "cannot-reimburse-non-rental-charge" | "cannot-remove-own-actor-from-recently-used" | "cannot-remove-payment-method" | "cannot-remove-pricing-info" | "cannot-remove-running-run" | "cannot-remove-user-with-public-actors" | "cannot-remove-user-with-subscription" | "cannot-remove-user-with-unpaid-invoice" | "cannot-rename-env-var" | "cannot-rent-paid-actor" | "cannot-review-own-actor" | "cannot-set-access-rights-for-owner" | "cannot-set-is-status-message-terminal" | "cannot-unpublish-critical-actor" | "cannot-unpublish-paid-actor" | "cannot-unpublish-profile" | "cannot-update-invoice-field" | "concurrent-runs-limit-exceeded" | "concurrent-update-detected" | "conference-token-not-found" | "content-encoding-forbidden-for-html" | "coupon-already-redeemed" | "coupon-expired" | "coupon-for-new-customers" | "coupon-for-subscribed-users" | "coupon-limits-are-in-conflict-with-current-limits" | "coupon-max-number-of-redemptions-reached" | "coupon-not-found" | "coupon-not-unique" | "coupons-disabled" | "create-github-issue-not-allowed" | "creator-plan-not-available" | "cron-expression-invalid" | "daily-ai-token-limit-exceeded" | "daily-publication-limit-exceeded" | "dataset-does-not-have-fields-schema" | "dataset-does-not-have-schema" | "dataset-locked" | "dataset-schema-invalid" | "dcr-not-supported" | "default-dataset-not-found" | "deleting-default-build" | "deleting-unfinished-build" | "email-already-taken" | "email-already-taken-removed-user" | "email-domain-not-allowed-for-coupon" | "email-invalid" | "email-not-allowed" | "email-not-valid" | "email-update-too-soon" | "elevated-permissions-needed" | "env-var-already-exists" | "exchange-rate-fetch-failed" | "expired-conference-token" | "failed-to-charge-user" | "final-invoice-negative" | "full-permission-actor-blocked-for-admin" | "full-permission-actor-not-approved" | "github-branch-empty" | "github-issue-already-exists" | "github-public-key-not-found" | "github-repository-not-found" | "github-signature-does-not-match-payload" | "github-user-not-authorized-for-issues" | "gmail-not-allowed" | "id-does-not-match" | "incompatible-billing-interval" | "incomplete-payout-billing-info" | "inconsistent-currencies" | "incorrect-pricing-modifier-prefix" | "input-json-invalid-characters" | "input-json-not-object" | "input-json-too-long" | "input-update-collision" | "insufficient-permissions" | "insufficient-permissions-to-change-field" | "insufficient-security-measures" | "insufficient-tax-country-evidence" | "integration-auth-error" | "internal-server-error" | "invalid-billing-info" | "invalid-billing-period-for-payout" | "invalid-build" | "invalid-client-key" | "invalid-collection" | "invalid-conference-login-password" | "invalid-content-type-header" | "invalid-credentials" | "invalid-git-auth-token" | "invalid-github-issue-url" | "invalid-header" | "invalid-id" | "invalid-idempotency-key" | "invalid-input" | "invalid-input-schema" | "invalid-invoice" | "invalid-invoice-type" | "invalid-issue-date" | "invalid-label-params" | "invalid-main-account-user-id" | "invalid-oauth-app" | "invalid-oauth-scope" | "invalid-one-time-invoice" | "invalid-parameter" | "invalid-payout-status" | "invalid-picture-url" | "invalid-record-key" | "invalid-request" | "invalid-resource-type" | "invalid-signature" | "invalid-subscription-plan" | "invalid-tax-number" | "invalid-tax-number-format" | "invalid-token" | "invalid-token-type" | "invalid-two-factor-code" | "invalid-two-factor-code-or-recovery-code" | "invalid-two-factor-recovery-code" | "invalid-username" | "invalid-value" | "invitation-invalid-resource-type" | "invitation-no-longer-valid" | "invoice-canceled" | "invoice-cannot-be-refunded-due-to-too-high-amount" | "invoice-incomplete" | "invoice-is-draft" | "invoice-locked" | "invoice-must-be-buffer" | "invoice-not-canceled" | "invoice-not-draft" | "invoice-not-found" | "invoice-outdated" | "invoice-paid-already" | "issue-already-connected-to-github" | "issue-not-found" | "issues-bad-request" | "issuer-not-registered" | "job-finished" | "label-already-linked" | "last-api-token" | "limit-reached" | "max-items-must-be-greater-than-zero" | "max-metamorphs-exceeded" | "max-total-charge-usd-below-minimum" | "max-total-charge-usd-must-be-greater-than-zero" | "method-not-allowed" | "migration-disabled" | "missing-actor-rights" | "missing-api-token" | "missing-billing-info" | "missing-line-items" | "missing-payment-date" | "missing-payout-billing-info" | "missing-proxy-password" | "missing-reporting-fields" | "missing-resource-name" | "missing-settings" | "missing-username" | "monthly-usage-limit-too-low" | "more-than-one-update-not-allowed" | "multiple-records-found" | "must-be-admin" | "name-not-unique" | "next-runtime-computation-failed" | "no-columns-in-exported-dataset" | "no-payment-attempt-for-refund-found" | "no-payment-method-available" | "no-team-account-seats-available" | "non-temporary-email" | "not-enough-usage-to-run-paid-actor" | "not-implemented" | "not-supported-currencies" | "o-auth-service-already-connected" | "o-auth-service-not-connected" | "oauth-resource-access-failed" | "one-time-invoice-already-marked-paid" | "only-drafts-can-be-deleted" | "operation-canceled" | "operation-not-allowed" | "operation-timed-out" | "organization-cannot-own-itself" | "organization-role-not-found" | "overlapping-payout-billing-periods" | "own-token-required" | "page-not-found" | "param-not-one-of" | "parameter-required" | "parameters-mismatched" | "password-reset-email-already-sent" | "password-reset-token-expired" | "pay-as-you-go-without-monthly-interval" | "payment-attempt-status-message-required" | "payout-already-paid" | "payout-canceled" | "payout-invalid-state" | "payout-must-be-approved-to-be-marked-paid" | "payout-not-found" | "payout-number-already-exists" | "phone-number-invalid" | "phone-number-landline" | "phone-number-opted-out" | "phone-verification-disabled" | "platform-feature-disabled" | "price-overrides-validation-failed" | "pricing-model-not-supported" | "promotional-plan-not-available" | "proxy-auth-ip-not-unique" | "public-actor-disabled" | "query-timeout" | "quoted-price-outdated" | "rate-limit-exceeded" | "recaptcha-invalid" | "recaptcha-required" | "record-not-found" | "record-not-public" | "record-or-token-not-found" | "record-too-large" | "redirect-uri-mismatch" | "reduced-plan-not-available" | "rental-charge-already-reimbursed" | "rental-not-allowed" | "request-aborted-prematurely" | "request-handled-or-locked" | "request-id-invalid" | "request-queue-duplicate-requests" | "request-too-large" | "requested-dataset-view-does-not-exist" | "resume-token-expired" | "run-failed" | "run-input-body-not-valid-json" | "run-timeout-exceeded" | "russia-is-evil" | "same-user" | "schedule-actor-not-found" | "schedule-actor-task-not-found" | "schedule-name-not-unique" | "schema-validation" | "schema-validation-error" | "schema-validation-failed" | "service-worker-registration-not-allowed" | "sign-up-method-not-allowed" | "slack-integration-not-custom" | "socket-closed" | "socket-destroyed" | "store-schema-invalid" | "store-terms-not-accepted" | "stripe-enabled" | "stripe-generic-decline" | "stripe-not-enabled" | "stripe-not-enabled-for-user" | "tagged-build-required" | "tax-country-invalid" | "tax-number-invalid" | "tax-number-validation-failed" | "taxamo-call-failed" | "taxamo-request-failed" | "testing-error" | "token-not-provided" | "too-few-versions" | "too-many-actor-tasks" | "too-many-actors" | "too-many-labels-on-resource" | "too-many-mcp-connectors" | "too-many-o-auth-apps" | "too-many-organizations" | "too-many-requests" | "too-many-schedules" | "too-many-ui-access-keys" | "too-many-user-labels" | "too-many-values" | "too-many-versions" | "too-many-webhooks" | "unexpected-route" | "unknown-build-tag" | "unknown-payment-provider" | "unsubscribe-token-invalid" | "unsupported-actor-pricing-model-for-agentic-payments" | "unsupported-content-encoding" | "unsupported-file-type-for-issue" | "unsupported-file-type-image-expected" | "unsupported-file-type-text-or-json-expected" | "unsupported-permission" | "upcoming-subscription-bill-not-up-to-date" | "user-already-exists" | "user-already-verified" | "user-creates-organizations-too-fast" | "user-disabled" | "user-email-is-disposable" | "user-email-not-set" | "user-email-not-verified" | "user-has-no-subscription" | "user-integration-not-found" | "user-is-already-invited" | "user-is-already-organization-member" | "user-is-not-member-of-organization" | "user-is-not-organization" | "user-is-organization" | "user-is-organization-owner" | "user-is-removed" | "user-not-found" | "user-not-logged-in" | "user-not-verified" | "user-or-token-not-found" | "user-plan-not-allowed-for-coupon" | "user-problem-with-card" | "user-record-not-found" | "username-already-taken" | "username-missing" | "username-not-allowed" | "username-removal-forbidden" | "username-required" | "verification-email-already-sent" | "verification-token-expired" | "version-already-exists" | "versions-size-exceeded" | "weak-password" | "x402-agentic-payment-already-finalized" | "x402-agentic-payment-insufficient-amount" | "x402-agentic-payment-malformed-token" | "x402-agentic-payment-settlement-failed" | "x402-agentic-payment-settlement-in-progress" | "x402-agentic-payment-settlement-stuck" | "x402-agentic-payment-unauthorized" | "x402-payment-required" | "zero-invoice";
4754
4765
  /** ErrorDetail */
4755
4766
  ErrorDetail: {
4756
4767
  type?: components["schemas"]["ErrorType"];
@@ -4856,9 +4867,133 @@ export interface components {
4856
4867
  /** @description URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`. */
4857
4868
  gitHubGistUrl?: string | null;
4858
4869
  };
4870
+ /**
4871
+ * @description Determines the permission level that the Actor requires to run. For details, see [Actor permissions](https://docs.apify.com/platform/actors/development/permissions).
4872
+ * @example LIMITED_PERMISSIONS
4873
+ * @enum {string}
4874
+ */
4875
+ ActorPermissionLevel: "LIMITED_PERMISSIONS" | "FULL_PERMISSIONS";
4876
+ /**
4877
+ * DefaultRunOptions
4878
+ * @description The default settings applied to an Actor run. Can be overridden elsewhere.
4879
+ */
4880
+ DefaultRunOptions: {
4881
+ /**
4882
+ * @description Which build to run. Either a build tag or a version number.
4883
+ * @example latest
4884
+ */
4885
+ build?: string;
4886
+ /**
4887
+ * @description Timeout in seconds. 0 if no timeout.
4888
+ * @example 3600
4889
+ */
4890
+ timeoutSecs?: number;
4891
+ /**
4892
+ * @description In MB, the amount of memory allocated to the run.
4893
+ * @example 2048
4894
+ */
4895
+ memoryMbytes?: number;
4896
+ /**
4897
+ * @description Whether to automatically restart the run if it fails.
4898
+ * @example false
4899
+ */
4900
+ restartOnError?: boolean;
4901
+ /** @description Maximum number of items the run might produce. */
4902
+ maxItems?: number | null;
4903
+ forcePermissionLevel?: components["schemas"]["ActorPermissionLevel"] | null;
4904
+ };
4905
+ /** ActorStandby */
4906
+ ActorStandby: {
4907
+ /** @description Whether standby mode is enabled for the Actor. */
4908
+ isEnabled?: boolean | null;
4909
+ /** @description Target number of concurrent HTTP requests a single run is configured to handle. */
4910
+ desiredRequestsPerActorRun?: number | null;
4911
+ /** @description Maximum number of concurrent HTTP requests that can be routed to a single run. */
4912
+ maxRequestsPerActorRun?: number | null;
4913
+ /** @description In seconds, how long a run can stay idle without incoming requests before it's terminated. */
4914
+ idleTimeoutSecs?: number | null;
4915
+ /** @description Which build to run in standby mode. Either a build tag or a version number. */
4916
+ build?: string | null;
4917
+ /** @description In MB, the amount of memory allocated to the run. */
4918
+ memoryMbytes?: number | null;
4919
+ /** @description If `true`, prevents the standby mode configuration from being overridden elsewhere. */
4920
+ disableStandbyFieldsOverride?: boolean | null;
4921
+ /** @description Whether to pass the Actor's input to the standby run. If `false`, the standby runs start with no input. */
4922
+ shouldPassActorInput?: boolean | null;
4923
+ };
4924
+ /** ExampleRunInput */
4925
+ ExampleRunInput: {
4926
+ /**
4927
+ * @description Sample input, serialized as a string.
4928
+ * @example { "helloWorld": 123 }
4929
+ */
4930
+ body?: string;
4931
+ /**
4932
+ * @description MIME type of `body`.
4933
+ * @example application/json; charset=utf-8
4934
+ */
4935
+ contentType?: string;
4936
+ };
4937
+ /** CreateActorRequest */
4938
+ CreateActorRequest: {
4939
+ /**
4940
+ * @description The identifier of the Actor. Use lowercase letters, numbers, and hyphens. Spaces or special characters aren't allowed. Must be unique across your account.
4941
+ * @example instagram-scraper
4942
+ */
4943
+ name?: string | null;
4944
+ /**
4945
+ * @description Short description of the Actor, displayed in Apify Store and Console.
4946
+ * @example This scraper extracts posts and comments from Instagram.
4947
+ */
4948
+ description?: string | null;
4949
+ /**
4950
+ * @description Human-readable name of the Actor, displayed in Apify Store and Console. Can contain spaces and capital letters. Recommended length is 40-50 characters. You can change this title without affecting the Actor's URL or SEO.
4951
+ * @example Instagram scraper
4952
+ */
4953
+ title?: string | null;
4954
+ /**
4955
+ * @description Whether the Actor is available to users in Apify Store. If `false`, the Actor is private and only visible to you.
4956
+ * @example false
4957
+ */
4958
+ isPublic?: boolean | null;
4959
+ /**
4960
+ * @description Name of the Actor to display by search engines such as Google. Can be different from the Actor's name displayed in Apify Store and Console. Recommended length is 40-50 characters.
4961
+ * @example Free Instagram scraper
4962
+ */
4963
+ seoTitle?: string | null;
4964
+ /**
4965
+ * @description Description of the Actor to display by search engines such as Google. Recommended length is 140-156 characters.
4966
+ * @example The best scraper for Instagram
4967
+ */
4968
+ seoDescription?: string | null;
4969
+ /**
4970
+ * @deprecated
4971
+ * @example false
4972
+ */
4973
+ restartOnError?: boolean;
4974
+ /** @description An array of `Version` objects. Each object represents a specific version of the Actor's source code: its location, builds, and environment configuration. */
4975
+ versions?: components["schemas"]["Version"][] | null;
4976
+ /**
4977
+ * @description A list of categories that best define the Actor. Reflected in Apify Store's search and filtering options.
4978
+ * @example [
4979
+ * "SOCIAL_MEDIA"
4980
+ * ]
4981
+ */
4982
+ categories?: string[] | null;
4983
+ defaultRunOptions?: components["schemas"]["DefaultRunOptions"];
4984
+ /** @description The configuration of the Actor's standby mode. For details, see [Standby mode](https://docs.apify.com/platform/actors/development/programming-interface/standby). */
4985
+ actorStandby?: components["schemas"]["ActorStandby"] | null;
4986
+ /** @description Sample input payload that demonstrates what a typical run input for an Actor looks like. Used when no explicit input for a run is provided. */
4987
+ exampleRunInput?: components["schemas"]["ExampleRunInput"] | null;
4988
+ /** @description Whether the Actor is deprecated. */
4989
+ isDeprecated?: boolean | null;
4990
+ };
4859
4991
  /** CommonActorPricingInfo */
4860
4992
  CommonActorPricingInfo: {
4861
- /** @description In [0, 1], fraction of pricePerUnitUsd that goes to Apify */
4993
+ /**
4994
+ * @description Apify's share of the revenue generated under this pricing info record, as a fraction between 0 and 1. Set by the Apify platform.
4995
+ * @example 0.2
4996
+ */
4862
4997
  apifyMarginPercentage: number;
4863
4998
  /**
4864
4999
  * Format: date-time
@@ -4992,128 +5127,6 @@ export interface components {
4992
5127
  };
4993
5128
  /** ActorRunPricingInfo */
4994
5129
  ActorRunPricingInfo: components["schemas"]["PayPerEventActorPricingInfo"] | components["schemas"]["PricePerDatasetItemActorPricingInfo"] | components["schemas"]["FlatPricePerMonthActorPricingInfo"] | components["schemas"]["FreeActorPricingInfo"];
4995
- /**
4996
- * @description Determines the permission level that the Actor requires to run. For details, see [Actor permissions](https://docs.apify.com/platform/actors/development/permissions).
4997
- * @example LIMITED_PERMISSIONS
4998
- * @enum {string}
4999
- */
5000
- ActorPermissionLevel: "LIMITED_PERMISSIONS" | "FULL_PERMISSIONS";
5001
- /**
5002
- * DefaultRunOptions
5003
- * @description The default settings applied to an Actor run. Can be overridden elsewhere.
5004
- */
5005
- DefaultRunOptions: {
5006
- /**
5007
- * @description Which build to run. Either a build tag or a version number.
5008
- * @example latest
5009
- */
5010
- build?: string;
5011
- /**
5012
- * @description Timeout in seconds. 0 if no timeout.
5013
- * @example 3600
5014
- */
5015
- timeoutSecs?: number;
5016
- /**
5017
- * @description In MB, the amount of memory allocated to the run.
5018
- * @example 2048
5019
- */
5020
- memoryMbytes?: number;
5021
- /**
5022
- * @description Whether to automatically restart the run if it fails.
5023
- * @example false
5024
- */
5025
- restartOnError?: boolean;
5026
- /** @description Maximum number of items the run might produce. */
5027
- maxItems?: number | null;
5028
- forcePermissionLevel?: components["schemas"]["ActorPermissionLevel"] | null;
5029
- };
5030
- /** ActorStandby */
5031
- ActorStandby: {
5032
- /** @description Whether standby mode is enabled for the Actor. */
5033
- isEnabled?: boolean | null;
5034
- /** @description Target number of concurrent HTTP requests a single run is configured to handle. */
5035
- desiredRequestsPerActorRun?: number | null;
5036
- /** @description Maximum number of concurrent HTTP requests that can be routed to a single run. */
5037
- maxRequestsPerActorRun?: number | null;
5038
- /** @description In seconds, how long a run can stay idle without incoming requests before it's terminated. */
5039
- idleTimeoutSecs?: number | null;
5040
- /** @description Which build to run in standby mode. Either a build tag or a version number. */
5041
- build?: string | null;
5042
- /** @description In MB, the amount of memory allocated to the run. */
5043
- memoryMbytes?: number | null;
5044
- /** @description If `true`, prevents the standby mode configuration from being overridden elsewhere. */
5045
- disableStandbyFieldsOverride?: boolean | null;
5046
- /** @description Whether to pass the Actor's input to the standby run. If `false`, the standby runs start with no input. */
5047
- shouldPassActorInput?: boolean | null;
5048
- };
5049
- /** ExampleRunInput */
5050
- ExampleRunInput: {
5051
- /**
5052
- * @description Sample input, serialized as a string.
5053
- * @example { "helloWorld": 123 }
5054
- */
5055
- body?: string;
5056
- /**
5057
- * @description MIME type of `body`.
5058
- * @example application/json; charset=utf-8
5059
- */
5060
- contentType?: string;
5061
- };
5062
- /** CreateActorRequest */
5063
- CreateActorRequest: {
5064
- /**
5065
- * @description The identifier of the Actor. Use lowercase letters, numbers, and hyphens. Spaces or special characters aren't allowed. Must be unique across your account.
5066
- * @example instagram-scraper
5067
- */
5068
- name?: string | null;
5069
- /**
5070
- * @description Short description of the Actor, displayed in Apify Store and Console.
5071
- * @example This scraper extracts posts and comments from Instagram.
5072
- */
5073
- description?: string | null;
5074
- /**
5075
- * @description Human-readable name of the Actor, displayed in Apify Store and Console. Can contain spaces and capital letters. Recommended length is 40-50 characters. You can change this title without affecting the Actor's URL or SEO.
5076
- * @example Instagram scraper
5077
- */
5078
- title?: string | null;
5079
- /**
5080
- * @description Whether the Actor is available to users in Apify Store. If `false`, the Actor is private and only visible to you.
5081
- * @example false
5082
- */
5083
- isPublic?: boolean | null;
5084
- /**
5085
- * @description Name of the Actor to display by search engines such as Google. Can be different from the Actor's name displayed in Apify Store and Console. Recommended length is 40-50 characters.
5086
- * @example Free Instagram scraper
5087
- */
5088
- seoTitle?: string | null;
5089
- /**
5090
- * @description Description of the Actor to display by search engines such as Google. Recommended length is 140-156 characters.
5091
- * @example The best scraper for Instagram
5092
- */
5093
- seoDescription?: string | null;
5094
- /**
5095
- * @deprecated
5096
- * @example false
5097
- */
5098
- restartOnError?: boolean;
5099
- /** @description An array of `Version` objects. Each object represents a specific version of the Actor's source code: its location, builds, and environment configuration. */
5100
- versions?: components["schemas"]["Version"][] | null;
5101
- pricingInfos?: components["schemas"]["ActorRunPricingInfo"][];
5102
- /**
5103
- * @description A list of categories that best define the Actor. Reflected in Apify Store's search and filtering options.
5104
- * @example [
5105
- * "SOCIAL_MEDIA"
5106
- * ]
5107
- */
5108
- categories?: string[] | null;
5109
- defaultRunOptions?: components["schemas"]["DefaultRunOptions"];
5110
- /** @description The configuration of the Actor's standby mode. For details, see [Standby mode](https://docs.apify.com/platform/actors/development/programming-interface/standby). */
5111
- actorStandby?: components["schemas"]["ActorStandby"] | null;
5112
- /** @description Sample input payload that demonstrates what a typical run input for an Actor looks like. Used when no explicit input for a run is provided. */
5113
- exampleRunInput?: components["schemas"]["ExampleRunInput"] | null;
5114
- /** @description Whether the Actor is deprecated. */
5115
- isDeprecated?: boolean | null;
5116
- };
5117
5130
  /**
5118
5131
  * TaggedBuildInfo
5119
5132
  * @description Information about a tagged build.
@@ -5433,7 +5446,7 @@ export interface components {
5433
5446
  data: components["schemas"]["ListOfEnvVars"];
5434
5447
  };
5435
5448
  /** EnvVarRequest */
5436
- EnvVarRequest: components["schemas"]["EnvVar"] & unknown;
5449
+ EnvVarRequest: WithRequired<components["schemas"]["EnvVar"], "value">;
5437
5450
  /** EnvVarResponse */
5438
5451
  EnvVarResponse: {
5439
5452
  data: components["schemas"]["EnvVar"];
@@ -5643,11 +5656,11 @@ export interface components {
5643
5656
  /** @description The path to the directory used as the Docker context when building the Actor. */
5644
5657
  dockerContextDir?: string;
5645
5658
  /** @description The path to the README file for the Actor. */
5646
- readme?: string;
5659
+ readme?: string | null;
5647
5660
  /** @description The input schema object, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/input-schema) */
5648
- input?: Record<string, unknown>;
5661
+ input?: Record<string, unknown> | null;
5649
5662
  /** @description The path to the CHANGELOG file displayed in the Actor's information tab. */
5650
- changelog?: string;
5663
+ changelog?: string | null;
5651
5664
  storages?: {
5652
5665
  /** @description Defines the schema of items in your dataset, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema) */
5653
5666
  dataset?: Record<string, unknown>;
@@ -6145,7 +6158,7 @@ export interface components {
6145
6158
  */
6146
6159
  exitCode?: number | null;
6147
6160
  /** @description General access level for the Actor run. */
6148
- generalAccess: components["schemas"]["GeneralAccess"];
6161
+ generalAccess?: components["schemas"]["GeneralAccess"] | null;
6149
6162
  /**
6150
6163
  * @description ID of the default key-value store for this run.
6151
6164
  * @example eJNzqsbPiopwJcgGQ
@@ -6323,7 +6336,7 @@ export interface components {
6323
6336
  itemsPublicUrl?: string;
6324
6337
  /** @description A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the dataset. */
6325
6338
  urlSigningSecretKey?: string | null;
6326
- generalAccess?: components["schemas"]["GeneralAccess"];
6339
+ generalAccess?: components["schemas"]["GeneralAccess"] | null;
6327
6340
  stats?: components["schemas"]["DatasetStats"];
6328
6341
  };
6329
6342
  /**
@@ -6529,7 +6542,7 @@ export interface components {
6529
6542
  schema?: Record<string, unknown> | null;
6530
6543
  /** @description A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the key-value store. */
6531
6544
  urlSigningSecretKey?: string | null;
6532
- generalAccess?: components["schemas"]["GeneralAccess"];
6545
+ generalAccess?: components["schemas"]["GeneralAccess"] | null;
6533
6546
  stats?: components["schemas"]["KeyValueStoreStats"];
6534
6547
  };
6535
6548
  /**
@@ -6737,7 +6750,7 @@ export interface components {
6737
6750
  */
6738
6751
  consoleUrl: string;
6739
6752
  stats?: components["schemas"]["RequestQueueStats"];
6740
- generalAccess?: components["schemas"]["GeneralAccess"];
6753
+ generalAccess?: components["schemas"]["GeneralAccess"] | null;
6741
6754
  };
6742
6755
  /**
6743
6756
  * RequestQueueResponse
@@ -6792,8 +6805,8 @@ export interface components {
6792
6805
  };
6793
6806
  /** RequestBase */
6794
6807
  RequestBase: {
6795
- uniqueKey?: components["schemas"]["UniqueKey"];
6796
- url?: components["schemas"]["RequestUrl"];
6808
+ uniqueKey: components["schemas"]["UniqueKey"];
6809
+ url: components["schemas"]["RequestUrl"];
6797
6810
  method?: components["schemas"]["HttpMethod"];
6798
6811
  retryCount?: components["schemas"]["RetryCount"];
6799
6812
  /**
@@ -6838,7 +6851,7 @@ export interface components {
6838
6851
  * Request
6839
6852
  * @description A request stored in the request queue, including its metadata and processing state.
6840
6853
  */
6841
- Request: WithRequired<components["schemas"]["RequestBase"], "uniqueKey" | "url"> & {
6854
+ Request: components["schemas"]["RequestBase"] & {
6842
6855
  id: components["schemas"]["RequestId"];
6843
6856
  };
6844
6857
  /**
@@ -6919,6 +6932,11 @@ export interface components {
6919
6932
  ListOfRequestsResponse: {
6920
6933
  data: components["schemas"]["ListOfRequests"];
6921
6934
  };
6935
+ /**
6936
+ * RequestWithoutId
6937
+ * @description A request stored in the request queue, including its metadata and processing state, without the assigned ID.
6938
+ */
6939
+ RequestWithoutId: components["schemas"]["RequestBase"];
6922
6940
  /**
6923
6941
  * @description Indicates whether a request with the same unique key already existed in the request queue. If true, no new request was created.
6924
6942
  * @example false
@@ -7327,6 +7345,46 @@ export interface components {
7327
7345
  TaskInput: {
7328
7346
  [key: string]: unknown;
7329
7347
  };
7348
+ /**
7349
+ * TaskPublicConfig
7350
+ * @description Public-facing configuration of a published task, used by the task's public landing page.
7351
+ * The task's publication state is determined by `publishedAt` - a task is published when
7352
+ * `publishedAt` is set and unpublished when it is `null`.
7353
+ */
7354
+ TaskPublicConfig: {
7355
+ /**
7356
+ * Format: date-time
7357
+ * @description Time when the task was published, or `null` if the task isn't published.
7358
+ * This field is server-controlled. To publish or unpublish a task, use the
7359
+ * [Update task](https://docs.apify.com/api/v2/actor-task-put) endpoint and set `isPublic`.
7360
+ * @example 2025-06-16T09:20:45.777Z
7361
+ */
7362
+ readonly publishedAt?: Date | null;
7363
+ /**
7364
+ * @description Name of the Actor task to display by search engines such as Google. Defaults to the task
7365
+ * title. At most 60 characters.
7366
+ * @example Scrape data from a website
7367
+ */
7368
+ seoTitle?: string | null;
7369
+ /**
7370
+ * @description Description of the Actor task to display by search engines such as Google. Defaults to the
7371
+ * task description. At most 160 characters.
7372
+ */
7373
+ seoDescription?: string | null;
7374
+ /** @description Names of the task input fields displayed on the public task page. */
7375
+ inputSchemaFields?: string[] | null;
7376
+ /**
7377
+ * @description Name of the dataset from the Actor's dataset schema whose results are displayed. When
7378
+ * `null`, the Actor's default dataset is used. That is, the only dataset the Actor declares,
7379
+ * or the one named `default` when it declares several.
7380
+ */
7381
+ datasetName?: string | null;
7382
+ /**
7383
+ * @description Key of the dataset view from the Actor's dataset schema used to display results. Must be
7384
+ * one of the views declared on the resolved dataset. You can't publish a task without it.
7385
+ */
7386
+ datasetView?: string | null;
7387
+ };
7330
7388
  /** CreateTaskRequest */
7331
7389
  CreateTaskRequest: {
7332
7390
  /** @example asADASadYvn4mBZmm */
@@ -7334,9 +7392,14 @@ export interface components {
7334
7392
  /** @example my-task */
7335
7393
  name?: string;
7336
7394
  options?: components["schemas"]["TaskOptions"] | null;
7337
- input?: components["schemas"]["TaskInput"] | null;
7395
+ input?: components["schemas"]["TaskInput"] | components["schemas"]["TaskInput"][] | null;
7338
7396
  title?: string | null;
7339
7397
  actorStandby?: components["schemas"]["ActorStandby"] | null;
7398
+ /**
7399
+ * @description Configuration that controls how the published task appears on its public landing page.
7400
+ * Editing this object requires write permission to the Actor that the task belongs to.
7401
+ */
7402
+ publicConfig?: components["schemas"]["TaskPublicConfig"];
7340
7403
  };
7341
7404
  /** Task */
7342
7405
  Task: {
@@ -7364,11 +7427,17 @@ export interface components {
7364
7427
  removedAt?: Date | null;
7365
7428
  stats?: components["schemas"]["TaskStats"] | null;
7366
7429
  options?: components["schemas"]["TaskOptions"] | null;
7367
- input?: components["schemas"]["TaskInput"] | null;
7430
+ input?: components["schemas"]["TaskInput"] | components["schemas"]["TaskInput"][] | null;
7368
7431
  title?: string | null;
7369
7432
  actorStandby?: components["schemas"]["ActorStandby"] | null;
7370
7433
  /** Format: uri */
7371
7434
  standbyUrl?: string | null;
7435
+ /**
7436
+ * @description Whether the task is published. Based on the `publicConfig.publishedAt` field.
7437
+ * @example false
7438
+ */
7439
+ isPublic?: boolean;
7440
+ publicConfig?: components["schemas"]["TaskPublicConfig"] | null;
7372
7441
  };
7373
7442
  /**
7374
7443
  * TaskResponse
@@ -7405,9 +7474,24 @@ export interface components {
7405
7474
  /** @example my-task */
7406
7475
  name?: string;
7407
7476
  options?: components["schemas"]["TaskOptions"] | null;
7408
- input?: components["schemas"]["TaskInput"] | null;
7477
+ input?: components["schemas"]["TaskInput"] | components["schemas"]["TaskInput"][] | null;
7409
7478
  title?: string | null;
7410
7479
  actorStandby?: components["schemas"]["ActorStandby"] | null;
7480
+ /**
7481
+ * @description Configuration that controls how the published task appears on its public landing page.
7482
+ * Editing this object requires write permission to the Actor that the task belongs to.
7483
+ *
7484
+ * The fields you send are merged into the stored configuration, so you only need to include
7485
+ * the ones you're changing. To clear a field, set it to `null`. Sending `publicConfig: null`
7486
+ * is rejected, so the object as a whole can't be cleared.
7487
+ */
7488
+ publicConfig?: components["schemas"]["TaskPublicConfig"];
7489
+ /**
7490
+ * @description Set to `true` to publish the task on its public landing page, or `false` to unpublish it.
7491
+ * Sending the value the task already has does nothing.
7492
+ * @example true
7493
+ */
7494
+ isPublic?: boolean;
7411
7495
  };
7412
7496
  /** Webhook */
7413
7497
  Webhook: {
@@ -7525,7 +7609,7 @@ export interface components {
7525
7609
  title?: string | null;
7526
7610
  /** @example janedoe */
7527
7611
  username?: string;
7528
- generalAccess?: components["schemas"]["GeneralAccess"];
7612
+ generalAccess?: components["schemas"]["GeneralAccess"] | null;
7529
7613
  stats?: components["schemas"]["DatasetStats"];
7530
7614
  };
7531
7615
  /** ListOfDatasets */
@@ -7575,7 +7659,7 @@ export interface components {
7575
7659
  /** @description The ID of the Actor run that created this request queue. */
7576
7660
  actRunId?: string | null;
7577
7661
  hadMultipleClients: components["schemas"]["HadMultipleClients"];
7578
- generalAccess?: components["schemas"]["GeneralAccess"];
7662
+ generalAccess?: components["schemas"]["GeneralAccess"] | null;
7579
7663
  stats?: components["schemas"]["RequestQueueStats"];
7580
7664
  };
7581
7665
  /**
@@ -7934,7 +8018,10 @@ export interface components {
7934
8018
  CurrentPricingInfo: {
7935
8019
  /** @example FREE */
7936
8020
  pricingModel: string;
7937
- /** @example 0.2 */
8021
+ /**
8022
+ * @description Apify's share of the revenue generated under this pricing info record, as a fraction between 0 and 1. Set by the Apify platform.
8023
+ * @example 0.2
8024
+ */
7938
8025
  apifyMarginPercentage?: number;
7939
8026
  /**
7940
8027
  * Format: date-time
@@ -7999,10 +8086,7 @@ export interface components {
7999
8086
  */
8000
8087
  categories?: string[];
8001
8088
  notice?: components["schemas"]["ActorNotice"];
8002
- /**
8003
- * Format: uri
8004
- * @example https://...
8005
- */
8089
+ /** @example https://... */
8006
8090
  pictureUrl?: string | null;
8007
8091
  /**
8008
8092
  * Format: uri
@@ -8268,15 +8352,15 @@ export interface components {
8268
8352
  */
8269
8353
  email?: string;
8270
8354
  proxy?: components["schemas"]["Proxy"];
8271
- plan: components["schemas"]["Plan"];
8272
- effectivePlatformFeatures: components["schemas"]["EffectivePlatformFeatures"];
8355
+ plan?: components["schemas"]["Plan"];
8356
+ effectivePlatformFeatures?: components["schemas"]["EffectivePlatformFeatures"];
8273
8357
  /**
8274
8358
  * Format: date-time
8275
8359
  * @example 2022-11-29T14:48:29.381Z
8276
8360
  */
8277
8361
  createdAt?: Date;
8278
8362
  /** @example true */
8279
- isPaying: boolean;
8363
+ isPaying?: boolean;
8280
8364
  };
8281
8365
  /** PrivateUserDataResponse */
8282
8366
  PrivateUserDataResponse: {
@@ -8345,8 +8429,11 @@ export interface components {
8345
8429
  };
8346
8430
  /** DailyServiceUsages */
8347
8431
  DailyServiceUsages: {
8348
- /** @example 2022-10-02T00:00:00.000Z */
8349
- date: string;
8432
+ /**
8433
+ * Format: date-time
8434
+ * @example 2022-10-02T00:00:00.000Z
8435
+ */
8436
+ date: Date;
8350
8437
  serviceUsage: components["schemas"]["ServiceUsage"];
8351
8438
  /** @example 0.0474385791970591 */
8352
8439
  totalUsageCreditsUsd: number;
@@ -9174,12 +9261,13 @@ export interface operations {
9174
9261
  * "data": {
9175
9262
  * "id": "zdc3Pyhyz3m8vjDeM",
9176
9263
  * "userId": "wRsJZtadYvn4mBZmm",
9177
- * "name": "MyActor",
9264
+ * "name": "instagram-scraper",
9178
9265
  * "username": "jane35",
9179
- * "description": "My favourite Actor!",
9266
+ * "description": "This scraper extracts posts and comments from Instagram.",
9180
9267
  * "isPublic": false,
9181
9268
  * "createdAt": "2019-07-08T11:27:57.401Z",
9182
9269
  * "modifiedAt": "2019-07-08T14:01:05.546Z",
9270
+ * "taggedBuilds": {},
9183
9271
  * "stats": {
9184
9272
  * "totalBuilds": 9,
9185
9273
  * "totalRuns": 16,
@@ -9187,41 +9275,16 @@ export interface operations {
9187
9275
  * "totalUsers7Days": 2,
9188
9276
  * "totalUsers30Days": 6,
9189
9277
  * "totalUsers90Days": 6,
9190
- * "totalMetamorphs": 2,
9191
- * "lastRunStartedAt": "2019-07-08T14:01:05.546Z"
9278
+ * "totalMetamorphs": 2
9192
9279
  * },
9193
9280
  * "versions": [
9194
9281
  * {
9195
- * "versionNumber": "0.1",
9282
+ * "versionNumber": "0.0",
9196
9283
  * "envVars": null,
9197
9284
  * "sourceType": "SOURCE_FILES",
9198
9285
  * "applyEnvVarsToBuild": false,
9199
9286
  * "buildTag": "latest",
9200
9287
  * "sourceFiles": []
9201
- * },
9202
- * {
9203
- * "versionNumber": "0.2",
9204
- * "sourceType": "GIT_REPO",
9205
- * "envVars": null,
9206
- * "applyEnvVarsToBuild": false,
9207
- * "buildTag": "latest",
9208
- * "gitRepoUrl": "https://github.com/jane35/my-actor"
9209
- * },
9210
- * {
9211
- * "versionNumber": "0.3",
9212
- * "sourceType": "TARBALL",
9213
- * "envVars": null,
9214
- * "applyEnvVarsToBuild": false,
9215
- * "buildTag": "latest",
9216
- * "tarballUrl": "https://github.com/jane35/my-actor/archive/master.zip"
9217
- * },
9218
- * {
9219
- * "versionNumber": "0.4",
9220
- * "sourceType": "GITHUB_GIST",
9221
- * "envVars": null,
9222
- * "applyEnvVarsToBuild": false,
9223
- * "buildTag": "latest",
9224
- * "gitHubGistUrl": "https://gist.github.com/jane35/e51feb784yu89"
9225
9288
  * }
9226
9289
  * ],
9227
9290
  * "defaultRunOptions": {
@@ -9234,16 +9297,16 @@ export interface operations {
9234
9297
  * "body": "{ \"helloWorld\": 123 }",
9235
9298
  * "contentType": "application/json; charset=utf-8"
9236
9299
  * },
9300
+ * "categories": [],
9237
9301
  * "isDeprecated": false,
9238
- * "deploymentKey": "ssh-rsa AAAA ...",
9239
9302
  * "title": "My Actor",
9240
- * "taggedBuilds": {
9241
- * "latest": {
9242
- * "buildId": "z2EryhbfhgSyqj6Hn",
9243
- * "buildNumber": "0.0.2",
9244
- * "finishedAt": "2019-06-10T11:15:49.286Z"
9245
- * }
9246
- * }
9303
+ * "notice": "NONE",
9304
+ * "isCritical": false,
9305
+ * "isGeneric": false,
9306
+ * "hasNoDataset": false,
9307
+ * "isSourceCodeHidden": true,
9308
+ * "standbyUrl": null,
9309
+ * "actorPermissionLevel": "LIMITED_PERMISSIONS"
9247
9310
  * }
9248
9311
  * }
9249
9312
  */
@@ -11110,8 +11173,8 @@ export interface operations {
11110
11173
  parameters: {
11111
11174
  query?: {
11112
11175
  /**
11113
- * @description Optional tag or number of the Actor build to use for input schema validation.
11114
- * By default, the `latest` build tag is used.
11176
+ * @description Actor build whose input schema is used for validation. Can be a build tag or build number.
11177
+ * Defaults to the `latest` build tag.
11115
11178
  */
11116
11179
  build?: string;
11117
11180
  };
@@ -11122,7 +11185,12 @@ export interface operations {
11122
11185
  };
11123
11186
  cookie?: never;
11124
11187
  };
11125
- /** @description JSON input to validate against the Actor's input schema. */
11188
+ /**
11189
+ * @description The Actor input as a JSON object.
11190
+ *
11191
+ * You can omit fields that have a `default` in the input schema. They're
11192
+ * filled in before validation.
11193
+ */
11126
11194
  requestBody: {
11127
11195
  content: {
11128
11196
  "application/json": Record<string, unknown>;
@@ -11135,7 +11203,10 @@ export interface operations {
11135
11203
  };
11136
11204
  content: {
11137
11205
  "application/json": {
11138
- /** @description Whether the input is valid according to the Actor's input schema. */
11206
+ /**
11207
+ * @description Always `true`. The endpoint responds with `200` only when the input
11208
+ * passes validation. Invalid input returns a `400` error.
11209
+ */
11139
11210
  valid: boolean;
11140
11211
  };
11141
11212
  };
@@ -12169,7 +12240,7 @@ export interface operations {
12169
12240
  };
12170
12241
  requestBody: {
12171
12242
  content: {
12172
- "application/json": components["schemas"]["RequestBase"];
12243
+ "application/json": components["schemas"]["RequestWithoutId"];
12173
12244
  };
12174
12245
  };
12175
12246
  responses: {
@@ -12223,7 +12294,7 @@ export interface operations {
12223
12294
  };
12224
12295
  requestBody: {
12225
12296
  content: {
12226
- "application/json": components["schemas"]["RequestBase"][];
12297
+ "application/json": components["schemas"]["RequestWithoutId"][];
12227
12298
  };
12228
12299
  };
12229
12300
  responses: {
@@ -12410,7 +12481,7 @@ export interface operations {
12410
12481
  };
12411
12482
  requestBody: {
12412
12483
  content: {
12413
- "application/json": components["schemas"]["RequestBase"];
12484
+ "application/json": components["schemas"]["RequestWithoutId"];
12414
12485
  };
12415
12486
  };
12416
12487
  responses: {
@@ -15557,7 +15628,7 @@ export interface operations {
15557
15628
  };
15558
15629
  requestBody: {
15559
15630
  content: {
15560
- "application/json": components["schemas"]["RequestBase"];
15631
+ "application/json": components["schemas"]["RequestWithoutId"];
15561
15632
  };
15562
15633
  };
15563
15634
  responses: {
@@ -15611,7 +15682,7 @@ export interface operations {
15611
15682
  };
15612
15683
  requestBody: {
15613
15684
  content: {
15614
- "application/json": components["schemas"]["RequestBase"][];
15685
+ "application/json": components["schemas"]["RequestWithoutId"][];
15615
15686
  };
15616
15687
  };
15617
15688
  responses: {
@@ -15798,7 +15869,7 @@ export interface operations {
15798
15869
  };
15799
15870
  requestBody: {
15800
15871
  content: {
15801
- "application/json": components["schemas"]["RequestBase"];
15872
+ "application/json": components["schemas"]["RequestWithoutId"];
15802
15873
  };
15803
15874
  };
15804
15875
  responses: {
@@ -17241,7 +17312,7 @@ export interface operations {
17241
17312
  };
17242
17313
  requestBody: {
17243
17314
  content: {
17244
- "application/json": components["schemas"]["RequestBase"];
17315
+ "application/json": components["schemas"]["RequestWithoutId"];
17245
17316
  };
17246
17317
  };
17247
17318
  responses: {
@@ -17291,7 +17362,7 @@ export interface operations {
17291
17362
  };
17292
17363
  requestBody: {
17293
17364
  content: {
17294
- "application/json": components["schemas"]["RequestBase"][];
17365
+ "application/json": components["schemas"]["RequestWithoutId"][];
17295
17366
  };
17296
17367
  };
17297
17368
  responses: {
@@ -17461,7 +17532,7 @@ export interface operations {
17461
17532
  };
17462
17533
  requestBody: {
17463
17534
  content: {
17464
- "application/json": components["schemas"]["RequestBase"];
17535
+ "application/json": components["schemas"]["RequestWithoutId"];
17465
17536
  };
17466
17537
  };
17467
17538
  responses: {
@@ -19133,7 +19204,7 @@ export interface operations {
19133
19204
  };
19134
19205
  requestBody: {
19135
19206
  content: {
19136
- "application/json": components["schemas"]["RequestBase"][];
19207
+ "application/json": components["schemas"]["RequestWithoutId"][];
19137
19208
  };
19138
19209
  };
19139
19210
  responses: {
@@ -19321,7 +19392,7 @@ export interface operations {
19321
19392
  };
19322
19393
  requestBody: {
19323
19394
  content: {
19324
- "application/json": components["schemas"]["RequestBase"];
19395
+ "application/json": components["schemas"]["RequestWithoutId"];
19325
19396
  };
19326
19397
  };
19327
19398
  responses: {
@@ -19404,7 +19475,7 @@ export interface operations {
19404
19475
  };
19405
19476
  requestBody: {
19406
19477
  content: {
19407
- "application/json": components["schemas"]["RequestBase"];
19478
+ "application/json": components["schemas"]["RequestWithoutId"];
19408
19479
  };
19409
19480
  };
19410
19481
  responses: {
@@ -20037,6 +20108,7 @@ export interface operations {
20037
20108
  403: components["responses"]["Forbidden"];
20038
20109
  404: components["responses"]["NotFound"];
20039
20110
  405: components["responses"]["MethodNotAllowed"];
20111
+ 409: components["responses"]["Conflict"];
20040
20112
  413: components["responses"]["PayloadTooLarge"];
20041
20113
  415: components["responses"]["UnsupportedMediaType"];
20042
20114
  429: components["responses"]["TooManyRequests"];
@@ -20238,6 +20310,7 @@ export interface operations {
20238
20310
  };
20239
20311
  };
20240
20312
  400: components["responses"]["BadRequest"];
20313
+ 401: components["responses"]["Unauthorized"];
20241
20314
  404: components["responses"]["NotFound"];
20242
20315
  405: components["responses"]["MethodNotAllowed"];
20243
20316
  429: components["responses"]["TooManyRequests"];