From 71169fefa67c1508ecb9bc2929785fb359827054 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 16 Jun 2026 13:37:16 +0000 Subject: [PATCH 1/2] docs(api): unify Actor API reference URLs from act-* to actor-* Rename the legacy `act_*`/`acts_*` operationIds in the OpenAPI source to `actor_*`/`actors_*` so the generated doc page slugs become `/api/v2/actor-*`, matching the canonical `/v2/actors/` naming. operationId only drives doc-slug generation and client method hints; the live API at api.apify.com/v2 is unchanged (paths, methods, parameters, and request/response schemas untouched). - 63 operations renamed; matching `code_samples/*` files renamed to keep their samples attached. - 7 deprecated actor-scoped build/run duplicates (act-build-get, act-builds-get, act-build-abort-post, act-run-get, act-runs-get, act-run-abort-post, act-run-metamorph-post) keep their operationIds; their legacy URLs 301-redirect to the canonical standalone actor-build*/actor-run* pages. - nginx: add 301 redirects `/api/v2/act-*` -> `/api/v2/actor-*` and `/api/v2/acts-*` -> `/api/v2/actors-*` covering every old slug. - Update internal doc links and the llms.txt index exclusion patterns. https://claude.ai/code/session_01Q4HrVBuRKYG46ztwLXQkHz --- ...ct_builds_post.sh => actor_builds_post.sh} | 0 .../curl/{act_delete.sh => actor_delete.sh} | 0 .../curl/{act_get.sh => actor_get.sh} | 0 ...ct_post.sh => actor_run_resurrect_post.sh} | 0 .../{act_runs_post.sh => actor_runs_post.sh} | 0 .../curl/{acts_get.sh => actors_get.sh} | 0 .../curl/{acts_post.sh => actors_post.sh} | 0 ...ct_builds_post.js => actor_builds_post.js} | 0 .../{act_delete.js => actor_delete.js} | 0 .../javascript/{act_get.js => actor_get.js} | 0 .../javascript/{act_put.js => actor_put.js} | 0 ...uns_last_get.js => actor_runs_last_get.js} | 0 .../{act_runs_post.js => actor_runs_post.js} | 0 ...sion_delete.js => actor_version_delete.js} | 0 ...lete.js => actor_version_envVar_delete.js} | 0 ...Var_get.js => actor_version_envVar_get.js} | 0 ...Var_put.js => actor_version_envVar_put.js} | 0 ...rs_get.js => actor_version_envVars_get.js} | 0 ..._post.js => actor_version_envVars_post.js} | 0 ...ct_version_get.js => actor_version_get.js} | 0 ...ct_version_put.js => actor_version_put.js} | 0 ..._versions_get.js => actor_versions_get.js} | 0 ...ersions_post.js => actor_versions_post.js} | 0 ..._webhooks_get.js => actor_webhooks_get.js} | 0 .../javascript/{acts_get.js => actors_get.js} | 0 .../{acts_post.js => actors_post.js} | 0 .../components/objects/actor-runs/abort.yaml | 2 +- .../objects/actor-runs/metamorph.yaml | 2 +- .../components/objects/actor-runs/reboot.yaml | 2 +- .../objects/actor-runs/resurrect.yaml | 2 +- ...rsionNumber}@env-vars@{envVarName}put.yaml | 4 ++-- ...{actorId}@versions@{versionNumber}put.yaml | 4 ++-- .../objects/datasets/dataset-items.yaml | 4 ++-- .../objects/datasets/dataset-statistics.yaml | 2 +- .../components/objects/datasets/dataset.yaml | 6 +++--- .../key-value-store-keys.yaml | 2 +- .../key-value-store-record.yaml | 8 ++++---- .../key-value-store-records.yaml | 2 +- .../key-value-stores/key-value-store.yaml | 6 +++--- .../openapi/components/objects/logs/log.yaml | 2 +- .../request-queue-head-lock.yaml | 2 +- .../request-queues/request-queue-head.yaml | 2 +- .../request-queue-request-lock.yaml | 4 ++-- .../request-queues/request-queue-request.yaml | 6 +++--- .../request-queue-requests-batch.yaml | 4 ++-- .../request-queue-requests-unlock.yaml | 2 +- .../request-queue-requests.yaml | 4 ++-- .../objects/request-queues/request-queue.yaml | 6 +++--- .../actor-builds@{buildId}@openapi.json.yaml | 4 ++-- apify-api/openapi/paths/actors/acts.yaml | 4 ++-- .../openapi/paths/actors/acts@{actorId}.yaml | 6 +++--- .../paths/actors/acts@{actorId}@builds.yaml | 2 +- .../actors/acts@{actorId}@builds@default.yaml | 2 +- ...ctorId}@builds@{buildId}@openapi.json.yaml | 4 ++-- ...@{actorId}@run-sync-get-dataset-items.yaml | 4 ++-- .../paths/actors/acts@{actorId}@run-sync.yaml | 4 ++-- .../paths/actors/acts@{actorId}@runs.yaml | 2 +- .../actors/acts@{actorId}@runs@last.yaml | 2 +- .../actors/acts@{actorId}@validate-input.yaml | 2 +- .../paths/actors/acts@{actorId}@versions.yaml | 4 ++-- ...ts@{actorId}@versions@{versionNumber}.yaml | 4 ++-- ...Id}@versions@{versionNumber}@env-vars.yaml | 4 ++-- ...{versionNumber}@env-vars@{envVarName}.yaml | 4 ++-- .../paths/actors/acts@{actorId}@webhooks.yaml | 2 +- nginx.conf | 9 +++++++++ scripts/joinLlmsFiles.mjs | 19 +++++++++++++++---- .../platform/getting_started/apify_api.md | 4 ++-- .../platform/getting_started/apify_client.md | 2 +- .../run_actor_and_retrieve_data_via_api.md | 6 +++--- .../tutorials/api/using_apify_from_php.md | 2 +- .../development/builds_and_runs/runs.md | 2 +- .../publishing/monetize/pay_per_event.mdx | 2 +- sources/platform/actors/running/index.md | 4 ++-- .../actors/running/runs_and_builds.md | 4 ++-- .../integrations/ai/agent-onboarding.md | 10 +++++----- .../integrations/integrate_with_apify.md | 4 ++-- .../workflows-and-notifications/bubble.md | 16 ++++++++-------- .../workflows-and-notifications/dify.md | 2 +- 78 files changed, 119 insertions(+), 99 deletions(-) rename apify-api/openapi/code_samples/curl/{act_builds_post.sh => actor_builds_post.sh} (100%) rename apify-api/openapi/code_samples/curl/{act_delete.sh => actor_delete.sh} (100%) rename apify-api/openapi/code_samples/curl/{act_get.sh => actor_get.sh} (100%) rename apify-api/openapi/code_samples/curl/{act_run_resurrect_post.sh => actor_run_resurrect_post.sh} (100%) rename apify-api/openapi/code_samples/curl/{act_runs_post.sh => actor_runs_post.sh} (100%) rename apify-api/openapi/code_samples/curl/{acts_get.sh => actors_get.sh} (100%) rename apify-api/openapi/code_samples/curl/{acts_post.sh => actors_post.sh} (100%) rename apify-api/openapi/code_samples/javascript/{act_builds_post.js => actor_builds_post.js} (100%) rename apify-api/openapi/code_samples/javascript/{act_delete.js => actor_delete.js} (100%) rename apify-api/openapi/code_samples/javascript/{act_get.js => actor_get.js} (100%) rename apify-api/openapi/code_samples/javascript/{act_put.js => actor_put.js} (100%) rename apify-api/openapi/code_samples/javascript/{act_runs_last_get.js => actor_runs_last_get.js} (100%) rename apify-api/openapi/code_samples/javascript/{act_runs_post.js => actor_runs_post.js} (100%) rename apify-api/openapi/code_samples/javascript/{act_version_delete.js => actor_version_delete.js} (100%) rename apify-api/openapi/code_samples/javascript/{act_version_envVar_delete.js => actor_version_envVar_delete.js} (100%) rename apify-api/openapi/code_samples/javascript/{act_version_envVar_get.js => actor_version_envVar_get.js} (100%) rename apify-api/openapi/code_samples/javascript/{act_version_envVar_put.js => actor_version_envVar_put.js} (100%) rename apify-api/openapi/code_samples/javascript/{act_version_envVars_get.js => actor_version_envVars_get.js} (100%) rename apify-api/openapi/code_samples/javascript/{act_version_envVars_post.js => actor_version_envVars_post.js} (100%) rename apify-api/openapi/code_samples/javascript/{act_version_get.js => actor_version_get.js} (100%) rename apify-api/openapi/code_samples/javascript/{act_version_put.js => actor_version_put.js} (100%) rename apify-api/openapi/code_samples/javascript/{act_versions_get.js => actor_versions_get.js} (100%) rename apify-api/openapi/code_samples/javascript/{act_versions_post.js => actor_versions_post.js} (100%) rename apify-api/openapi/code_samples/javascript/{act_webhooks_get.js => actor_webhooks_get.js} (100%) rename apify-api/openapi/code_samples/javascript/{acts_get.js => actors_get.js} (100%) rename apify-api/openapi/code_samples/javascript/{acts_post.js => actors_post.js} (100%) diff --git a/apify-api/openapi/code_samples/curl/act_builds_post.sh b/apify-api/openapi/code_samples/curl/actor_builds_post.sh similarity index 100% rename from apify-api/openapi/code_samples/curl/act_builds_post.sh rename to apify-api/openapi/code_samples/curl/actor_builds_post.sh diff --git a/apify-api/openapi/code_samples/curl/act_delete.sh b/apify-api/openapi/code_samples/curl/actor_delete.sh similarity index 100% rename from apify-api/openapi/code_samples/curl/act_delete.sh rename to apify-api/openapi/code_samples/curl/actor_delete.sh diff --git a/apify-api/openapi/code_samples/curl/act_get.sh b/apify-api/openapi/code_samples/curl/actor_get.sh similarity index 100% rename from apify-api/openapi/code_samples/curl/act_get.sh rename to apify-api/openapi/code_samples/curl/actor_get.sh diff --git a/apify-api/openapi/code_samples/curl/act_run_resurrect_post.sh b/apify-api/openapi/code_samples/curl/actor_run_resurrect_post.sh similarity index 100% rename from apify-api/openapi/code_samples/curl/act_run_resurrect_post.sh rename to apify-api/openapi/code_samples/curl/actor_run_resurrect_post.sh diff --git a/apify-api/openapi/code_samples/curl/act_runs_post.sh b/apify-api/openapi/code_samples/curl/actor_runs_post.sh similarity index 100% rename from apify-api/openapi/code_samples/curl/act_runs_post.sh rename to apify-api/openapi/code_samples/curl/actor_runs_post.sh diff --git a/apify-api/openapi/code_samples/curl/acts_get.sh b/apify-api/openapi/code_samples/curl/actors_get.sh similarity index 100% rename from apify-api/openapi/code_samples/curl/acts_get.sh rename to apify-api/openapi/code_samples/curl/actors_get.sh diff --git a/apify-api/openapi/code_samples/curl/acts_post.sh b/apify-api/openapi/code_samples/curl/actors_post.sh similarity index 100% rename from apify-api/openapi/code_samples/curl/acts_post.sh rename to apify-api/openapi/code_samples/curl/actors_post.sh diff --git a/apify-api/openapi/code_samples/javascript/act_builds_post.js b/apify-api/openapi/code_samples/javascript/actor_builds_post.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/act_builds_post.js rename to apify-api/openapi/code_samples/javascript/actor_builds_post.js diff --git a/apify-api/openapi/code_samples/javascript/act_delete.js b/apify-api/openapi/code_samples/javascript/actor_delete.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/act_delete.js rename to apify-api/openapi/code_samples/javascript/actor_delete.js diff --git a/apify-api/openapi/code_samples/javascript/act_get.js b/apify-api/openapi/code_samples/javascript/actor_get.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/act_get.js rename to apify-api/openapi/code_samples/javascript/actor_get.js diff --git a/apify-api/openapi/code_samples/javascript/act_put.js b/apify-api/openapi/code_samples/javascript/actor_put.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/act_put.js rename to apify-api/openapi/code_samples/javascript/actor_put.js diff --git a/apify-api/openapi/code_samples/javascript/act_runs_last_get.js b/apify-api/openapi/code_samples/javascript/actor_runs_last_get.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/act_runs_last_get.js rename to apify-api/openapi/code_samples/javascript/actor_runs_last_get.js diff --git a/apify-api/openapi/code_samples/javascript/act_runs_post.js b/apify-api/openapi/code_samples/javascript/actor_runs_post.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/act_runs_post.js rename to apify-api/openapi/code_samples/javascript/actor_runs_post.js diff --git a/apify-api/openapi/code_samples/javascript/act_version_delete.js b/apify-api/openapi/code_samples/javascript/actor_version_delete.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/act_version_delete.js rename to apify-api/openapi/code_samples/javascript/actor_version_delete.js diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js b/apify-api/openapi/code_samples/javascript/actor_version_envVar_delete.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js rename to apify-api/openapi/code_samples/javascript/actor_version_envVar_delete.js diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js b/apify-api/openapi/code_samples/javascript/actor_version_envVar_get.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/act_version_envVar_get.js rename to apify-api/openapi/code_samples/javascript/actor_version_envVar_get.js diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js b/apify-api/openapi/code_samples/javascript/actor_version_envVar_put.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/act_version_envVar_put.js rename to apify-api/openapi/code_samples/javascript/actor_version_envVar_put.js diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVars_get.js b/apify-api/openapi/code_samples/javascript/actor_version_envVars_get.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/act_version_envVars_get.js rename to apify-api/openapi/code_samples/javascript/actor_version_envVars_get.js diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js b/apify-api/openapi/code_samples/javascript/actor_version_envVars_post.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/act_version_envVars_post.js rename to apify-api/openapi/code_samples/javascript/actor_version_envVars_post.js diff --git a/apify-api/openapi/code_samples/javascript/act_version_get.js b/apify-api/openapi/code_samples/javascript/actor_version_get.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/act_version_get.js rename to apify-api/openapi/code_samples/javascript/actor_version_get.js diff --git a/apify-api/openapi/code_samples/javascript/act_version_put.js b/apify-api/openapi/code_samples/javascript/actor_version_put.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/act_version_put.js rename to apify-api/openapi/code_samples/javascript/actor_version_put.js diff --git a/apify-api/openapi/code_samples/javascript/act_versions_get.js b/apify-api/openapi/code_samples/javascript/actor_versions_get.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/act_versions_get.js rename to apify-api/openapi/code_samples/javascript/actor_versions_get.js diff --git a/apify-api/openapi/code_samples/javascript/act_versions_post.js b/apify-api/openapi/code_samples/javascript/actor_versions_post.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/act_versions_post.js rename to apify-api/openapi/code_samples/javascript/actor_versions_post.js diff --git a/apify-api/openapi/code_samples/javascript/act_webhooks_get.js b/apify-api/openapi/code_samples/javascript/actor_webhooks_get.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/act_webhooks_get.js rename to apify-api/openapi/code_samples/javascript/actor_webhooks_get.js diff --git a/apify-api/openapi/code_samples/javascript/acts_get.js b/apify-api/openapi/code_samples/javascript/actors_get.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/acts_get.js rename to apify-api/openapi/code_samples/javascript/actors_get.js diff --git a/apify-api/openapi/code_samples/javascript/acts_post.js b/apify-api/openapi/code_samples/javascript/actors_post.js similarity index 100% rename from apify-api/openapi/code_samples/javascript/acts_post.js rename to apify-api/openapi/code_samples/javascript/actors_post.js diff --git a/apify-api/openapi/components/objects/actor-runs/abort.yaml b/apify-api/openapi/components/objects/actor-runs/abort.yaml index 9c6ea44610..93da57e11a 100644 --- a/apify-api/openapi/components/objects/actor-runs/abort.yaml +++ b/apify-api/openapi/components/objects/actor-runs/abort.yaml @@ -85,7 +85,7 @@ lastRunByActor: 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. - operationId: act_runs_last_abort_post + operationId: actor_runs_last_abort_post parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" diff --git a/apify-api/openapi/components/objects/actor-runs/metamorph.yaml b/apify-api/openapi/components/objects/actor-runs/metamorph.yaml index be3cffff4a..88921d5ba6 100644 --- a/apify-api/openapi/components/objects/actor-runs/metamorph.yaml +++ b/apify-api/openapi/components/objects/actor-runs/metamorph.yaml @@ -122,7 +122,7 @@ lastRunByActor: This endpoint is a shortcut for [Metamorph run](#/reference/actor-runs/metamorph-run/metamorph-run) on the Actor's last run. - operationId: act_runs_last_metamorph_post + operationId: actor_runs_last_metamorph_post parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" diff --git a/apify-api/openapi/components/objects/actor-runs/reboot.yaml b/apify-api/openapi/components/objects/actor-runs/reboot.yaml index 1928d0145f..63d9c1233b 100644 --- a/apify-api/openapi/components/objects/actor-runs/reboot.yaml +++ b/apify-api/openapi/components/objects/actor-runs/reboot.yaml @@ -61,7 +61,7 @@ lastRunByActor: 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. - operationId: act_runs_last_reboot_post + operationId: actor_runs_last_reboot_post parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" diff --git a/apify-api/openapi/components/objects/actor-runs/resurrect.yaml b/apify-api/openapi/components/objects/actor-runs/resurrect.yaml index ffc76f0d0f..1bc39830e2 100644 --- a/apify-api/openapi/components/objects/actor-runs/resurrect.yaml +++ b/apify-api/openapi/components/objects/actor-runs/resurrect.yaml @@ -73,7 +73,7 @@ byActorRunId: For more information, see the [Actor docs](https://docs.apify.com/platform/actors/running/runs-and-builds#resurrection-of-finished-run). - operationId: act_run_resurrect_post + operationId: actor_run_resurrect_post parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/runId" diff --git a/apify-api/openapi/components/objects/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}put.yaml b/apify-api/openapi/components/objects/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}put.yaml index e1139c30fe..2d11bc6f66 100644 --- a/apify-api/openapi/components/objects/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}put.yaml +++ b/apify-api/openapi/components/objects/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}put.yaml @@ -77,7 +77,7 @@ put: The response is the [EnvVar object](#/reference/actors/environment-variable-object) as returned by the [Get environment variable](#/reference/actors/environment-variable-object/get-environment-variable) endpoint. - operationId: act_version_envVar_put + operationId: actor_version_envVar_put x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable - https://docs.apify.com/api/v2#/reference/actors/update-environment-variable @@ -91,7 +91,7 @@ post: object](#/reference/actors/environment-variable-object) passed as JSON in the POST payload. This endpoint is an alias for the [`PUT` update environment variable](#tag/ActorsEnvironment-variable-object/operation/act_version_envVar_put) method and behaves identically. - operationId: act_version_envVar_post + operationId: actor_version_envVar_post x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable - https://docs.apify.com/api/v2#/reference/actors/update-environment-variable diff --git a/apify-api/openapi/components/objects/actors/acts@{actorId}@versions@{versionNumber}put.yaml b/apify-api/openapi/components/objects/actors/acts@{actorId}@versions@{versionNumber}put.yaml index 019439446d..d27decd93e 100644 --- a/apify-api/openapi/components/objects/actors/acts@{actorId}@versions@{versionNumber}put.yaml +++ b/apify-api/openapi/components/objects/actors/acts@{actorId}@versions@{versionNumber}put.yaml @@ -71,7 +71,7 @@ put: The response is the [Version object](#/reference/actors/version-object) as returned by the [Get version](#/reference/actors/version-object/get-version) endpoint. - operationId: act_version_put + operationId: actor_version_put x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/version-object/update-version - https://docs.apify.com/api/v2#/reference/actors/update-version @@ -83,7 +83,7 @@ post: description: | Updates Actor version using values specified by a [Version object](#/reference/actors/version-object) passed as JSON in the POST payload. This endpoint is an alias for the [`PUT` update version](#tag/ActorsVersion-object/operation/act_version_put) method and behaves identically. - operationId: act_version_post + operationId: actor_version_post x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/version-object/update-version - https://docs.apify.com/api/v2#/reference/actors/update-version diff --git a/apify-api/openapi/components/objects/datasets/dataset-items.yaml b/apify-api/openapi/components/objects/datasets/dataset-items.yaml index 1ca700ecd6..235491ab85 100644 --- a/apify-api/openapi/components/objects/datasets/dataset-items.yaml +++ b/apify-api/openapi/components/objects/datasets/dataset-items.yaml @@ -304,7 +304,7 @@ listLastRun: This endpoint is a shortcut that resolves the last run's `defaultDatasetId` and proxies to the [Get dataset items](/api/v2/dataset-items-get) endpoint. - operationId: act_runs_last_dataset_items_get + operationId: actor_runs_last_dataset_items_get parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" @@ -475,7 +475,7 @@ postLastRun: This endpoint is a shortcut that resolves the last run's `defaultDatasetId` and proxies to the [Store items](/api/v2/dataset-items-post) endpoint. - operationId: act_runs_last_dataset_items_post + operationId: actor_runs_last_dataset_items_post parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" diff --git a/apify-api/openapi/components/objects/datasets/dataset-statistics.yaml b/apify-api/openapi/components/objects/datasets/dataset-statistics.yaml index e9232d181e..a7f1619959 100644 --- a/apify-api/openapi/components/objects/datasets/dataset-statistics.yaml +++ b/apify-api/openapi/components/objects/datasets/dataset-statistics.yaml @@ -57,7 +57,7 @@ getLastRun: This endpoint is a shortcut that resolves the last run's `defaultDatasetId` and proxies to the [Get dataset statistics](/api/v2/dataset-statistics-get) endpoint. - operationId: act_runs_last_dataset_statistics_get + operationId: actor_runs_last_dataset_statistics_get parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" diff --git a/apify-api/openapi/components/objects/datasets/dataset.yaml b/apify-api/openapi/components/objects/datasets/dataset.yaml index 5729c6b63b..82249f3803 100644 --- a/apify-api/openapi/components/objects/datasets/dataset.yaml +++ b/apify-api/openapi/components/objects/datasets/dataset.yaml @@ -99,7 +99,7 @@ getLastRun: This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the [Get dataset](/api/v2/dataset-get) endpoint. - operationId: act_runs_last_dataset_get + operationId: actor_runs_last_dataset_get getTaskLastRun: <<: [*sharedGet, *sharedTaskLastRun] @@ -165,7 +165,7 @@ putLastRun: This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the [Update dataset](/api/v2/dataset-put) endpoint. - operationId: act_runs_last_dataset_put + operationId: actor_runs_last_dataset_put putTaskLastRun: <<: [*sharedPut, *sharedTaskLastRun] @@ -215,7 +215,7 @@ deleteLastRun: This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the [Delete dataset](/api/v2/dataset-delete) endpoint. - operationId: act_runs_last_dataset_delete + operationId: actor_runs_last_dataset_delete deleteTaskLastRun: <<: [*sharedDelete, *sharedTaskLastRun] diff --git a/apify-api/openapi/components/objects/key-value-stores/key-value-store-keys.yaml b/apify-api/openapi/components/objects/key-value-stores/key-value-store-keys.yaml index bd59786920..4b535130b0 100644 --- a/apify-api/openapi/components/objects/key-value-stores/key-value-store-keys.yaml +++ b/apify-api/openapi/components/objects/key-value-stores/key-value-store-keys.yaml @@ -93,7 +93,7 @@ listLastRun: This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the [Get list of keys](/api/v2/key-value-store-keys-get) endpoint. - operationId: act_runs_last_keyValueStore_keys_get + operationId: actor_runs_last_keyValueStore_keys_get parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" diff --git a/apify-api/openapi/components/objects/key-value-stores/key-value-store-record.yaml b/apify-api/openapi/components/objects/key-value-stores/key-value-store-record.yaml index 6c21a887c3..db0dcb1af5 100644 --- a/apify-api/openapi/components/objects/key-value-stores/key-value-store-record.yaml +++ b/apify-api/openapi/components/objects/key-value-stores/key-value-store-record.yaml @@ -152,7 +152,7 @@ getLastRun: This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the [Get record](/api/v2/key-value-store-record-get) endpoint. - operationId: act_runs_last_keyValueStore_record_get + operationId: actor_runs_last_keyValueStore_record_get parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" @@ -257,7 +257,7 @@ putLastRun: This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the [Store record](/api/v2/key-value-store-record-put) endpoint. - operationId: act_runs_last_keyValueStore_record_put + operationId: actor_runs_last_keyValueStore_record_put parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" @@ -318,7 +318,7 @@ postLastRun: This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the [Store record](/api/v2/key-value-store-record-post) endpoint. - operationId: act_runs_last_keyValueStore_record_post + operationId: actor_runs_last_keyValueStore_record_post parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" @@ -380,7 +380,7 @@ deleteLastRun: This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the [Delete record](/api/v2/key-value-store-record-delete) endpoint. - operationId: act_runs_last_keyValueStore_record_delete + operationId: actor_runs_last_keyValueStore_record_delete parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" diff --git a/apify-api/openapi/components/objects/key-value-stores/key-value-store-records.yaml b/apify-api/openapi/components/objects/key-value-stores/key-value-store-records.yaml index 35a1779e09..7dc2973bc8 100644 --- a/apify-api/openapi/components/objects/key-value-stores/key-value-store-records.yaml +++ b/apify-api/openapi/components/objects/key-value-stores/key-value-store-records.yaml @@ -81,7 +81,7 @@ listLastRun: This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the [Download records](/api/v2/key-value-store-records-get) endpoint. - operationId: act_runs_last_keyValueStore_records_get + operationId: actor_runs_last_keyValueStore_records_get parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" diff --git a/apify-api/openapi/components/objects/key-value-stores/key-value-store.yaml b/apify-api/openapi/components/objects/key-value-stores/key-value-store.yaml index e128e504a4..47220d1475 100644 --- a/apify-api/openapi/components/objects/key-value-stores/key-value-store.yaml +++ b/apify-api/openapi/components/objects/key-value-stores/key-value-store.yaml @@ -91,7 +91,7 @@ getLastRun: This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the [Get store](/api/v2/key-value-store-get) endpoint. - operationId: act_runs_last_keyValueStore_get + operationId: actor_runs_last_keyValueStore_get getTaskLastRun: <<: [*sharedGet, *sharedTaskLastRun] @@ -164,7 +164,7 @@ putLastRun: This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the [Update store](/api/v2/key-value-store-put) endpoint. - operationId: act_runs_last_keyValueStore_put + operationId: actor_runs_last_keyValueStore_put putTaskLastRun: <<: [*sharedPut, *sharedTaskLastRun] @@ -216,7 +216,7 @@ deleteLastRun: This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the [Delete store](/api/v2/key-value-store-delete) endpoint. - operationId: act_runs_last_keyValueStore_delete + operationId: actor_runs_last_keyValueStore_delete deleteTaskLastRun: <<: [*sharedDelete, *sharedTaskLastRun] diff --git a/apify-api/openapi/components/objects/logs/log.yaml b/apify-api/openapi/components/objects/logs/log.yaml index e374123e23..15d4052525 100644 --- a/apify-api/openapi/components/objects/logs/log.yaml +++ b/apify-api/openapi/components/objects/logs/log.yaml @@ -97,7 +97,7 @@ getLastRun: Retrieves last Actor run's logs. This endpoint is a shortcut for getting last Actor run's log. Same as [Get log](/api/v2/log-get) endpoint. - operationId: act_runs_last_log_get + operationId: actor_runs_last_log_get parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/logParameters.yaml#/stream" diff --git a/apify-api/openapi/components/objects/request-queues/request-queue-head-lock.yaml b/apify-api/openapi/components/objects/request-queues/request-queue-head-lock.yaml index e5643f5a1a..5550c5d2e4 100644 --- a/apify-api/openapi/components/objects/request-queues/request-queue-head-lock.yaml +++ b/apify-api/openapi/components/objects/request-queues/request-queue-head-lock.yaml @@ -85,7 +85,7 @@ postLastRun: This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the [Get head and lock](/api/v2/request-queue-head-lock-post) endpoint. - operationId: act_runs_last_requestQueue_head_lock_post + operationId: actor_runs_last_requestQueue_head_lock_post parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" diff --git a/apify-api/openapi/components/objects/request-queues/request-queue-head.yaml b/apify-api/openapi/components/objects/request-queues/request-queue-head.yaml index e86d8e92e0..6a0d3cd35a 100644 --- a/apify-api/openapi/components/objects/request-queues/request-queue-head.yaml +++ b/apify-api/openapi/components/objects/request-queues/request-queue-head.yaml @@ -90,7 +90,7 @@ listLastRun: This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the [Get head](/api/v2/request-queue-head-get) endpoint. - operationId: act_runs_last_requestQueue_head_get + operationId: actor_runs_last_requestQueue_head_get parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" diff --git a/apify-api/openapi/components/objects/request-queues/request-queue-request-lock.yaml b/apify-api/openapi/components/objects/request-queues/request-queue-request-lock.yaml index 2f0f5e7174..f90f0b2c94 100644 --- a/apify-api/openapi/components/objects/request-queues/request-queue-request-lock.yaml +++ b/apify-api/openapi/components/objects/request-queues/request-queue-request-lock.yaml @@ -92,7 +92,7 @@ putLastRun: This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the [Prolong request lock](/api/v2/request-queue-request-lock-put) endpoint. - operationId: act_runs_last_requestQueue_request_lock_put + operationId: actor_runs_last_requestQueue_request_lock_put parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" @@ -175,7 +175,7 @@ deleteLastRun: This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the [Delete request lock](/api/v2/request-queue-request-lock-delete) endpoint. - operationId: act_runs_last_requestQueue_request_lock_delete + operationId: actor_runs_last_requestQueue_request_lock_delete parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" diff --git a/apify-api/openapi/components/objects/request-queues/request-queue-request.yaml b/apify-api/openapi/components/objects/request-queues/request-queue-request.yaml index 0c3b1b283b..70ca73d69a 100644 --- a/apify-api/openapi/components/objects/request-queues/request-queue-request.yaml +++ b/apify-api/openapi/components/objects/request-queues/request-queue-request.yaml @@ -80,7 +80,7 @@ getLastRun: This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the [Get request](/api/v2/request-queue-request-get) endpoint. - operationId: act_runs_last_requestQueue_request_get + operationId: actor_runs_last_requestQueue_request_get parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" @@ -170,7 +170,7 @@ putLastRun: This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the [Update request](/api/v2/request-queue-request-put) endpoint. - operationId: act_runs_last_requestQueue_request_put + operationId: actor_runs_last_requestQueue_request_put parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" @@ -240,7 +240,7 @@ deleteLastRun: This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the [Delete request](/api/v2/request-queue-request-delete) endpoint. - operationId: act_runs_last_requestQueue_request_delete + operationId: actor_runs_last_requestQueue_request_delete parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" diff --git a/apify-api/openapi/components/objects/request-queues/request-queue-requests-batch.yaml b/apify-api/openapi/components/objects/request-queues/request-queue-requests-batch.yaml index 7e89302790..06245f1162 100644 --- a/apify-api/openapi/components/objects/request-queues/request-queue-requests-batch.yaml +++ b/apify-api/openapi/components/objects/request-queues/request-queue-requests-batch.yaml @@ -106,7 +106,7 @@ postLastRun: This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the [Add requests](/api/v2/request-queue-requests-batch-post) endpoint. - operationId: act_runs_last_requestQueue_requests_batch_post + operationId: actor_runs_last_requestQueue_requests_batch_post parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" @@ -206,7 +206,7 @@ deleteLastRun: This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the [Delete requests](/api/v2/request-queue-requests-batch-delete) endpoint. - operationId: act_runs_last_requestQueue_requests_batch_delete + operationId: actor_runs_last_requestQueue_requests_batch_delete parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" diff --git a/apify-api/openapi/components/objects/request-queues/request-queue-requests-unlock.yaml b/apify-api/openapi/components/objects/request-queues/request-queue-requests-unlock.yaml index a5a77f49f1..7a30812d26 100644 --- a/apify-api/openapi/components/objects/request-queues/request-queue-requests-unlock.yaml +++ b/apify-api/openapi/components/objects/request-queues/request-queue-requests-unlock.yaml @@ -79,7 +79,7 @@ postLastRun: This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the [Unlock requests](/api/v2/request-queue-requests-unlock-post) endpoint. - operationId: act_runs_last_requestQueue_requests_unlock_post + operationId: actor_runs_last_requestQueue_requests_unlock_post parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" diff --git a/apify-api/openapi/components/objects/request-queues/request-queue-requests.yaml b/apify-api/openapi/components/objects/request-queues/request-queue-requests.yaml index db3781cb0f..272b2ed6a8 100644 --- a/apify-api/openapi/components/objects/request-queues/request-queue-requests.yaml +++ b/apify-api/openapi/components/objects/request-queues/request-queue-requests.yaml @@ -90,7 +90,7 @@ listLastRun: This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the [List requests](/api/v2/request-queue-requests-get) endpoint. - operationId: act_runs_last_requestQueue_requests_get + operationId: actor_runs_last_requestQueue_requests_get parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" @@ -188,7 +188,7 @@ postLastRun: This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the [Add request](/api/v2/request-queue-requests-post) endpoint. - operationId: act_runs_last_requestQueue_requests_post + operationId: actor_runs_last_requestQueue_requests_post parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" diff --git a/apify-api/openapi/components/objects/request-queues/request-queue.yaml b/apify-api/openapi/components/objects/request-queues/request-queue.yaml index a8f9c1bae7..f5f88cf59e 100644 --- a/apify-api/openapi/components/objects/request-queues/request-queue.yaml +++ b/apify-api/openapi/components/objects/request-queues/request-queue.yaml @@ -86,7 +86,7 @@ getLastRun: This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the [Get request queue](/api/v2/request-queue-get) endpoint. - operationId: act_runs_last_requestQueue_get + operationId: actor_runs_last_requestQueue_get getTaskLastRun: <<: [*sharedGet, *sharedTaskLastRun] @@ -158,7 +158,7 @@ putLastRun: This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the [Update request queue](/api/v2/request-queue-put) endpoint. - operationId: act_runs_last_requestQueue_put + operationId: actor_runs_last_requestQueue_put putTaskLastRun: <<: [*sharedPut, *sharedTaskLastRun] @@ -208,7 +208,7 @@ deleteLastRun: This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the [Delete request queue](/api/v2/request-queue-delete) endpoint. - operationId: act_runs_last_requestQueue_delete + operationId: actor_runs_last_requestQueue_delete deleteTaskLastRun: <<: [*sharedDelete, *sharedTaskLastRun] diff --git a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml index 2a4c13ec7f..f6e6bef402 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml @@ -5,7 +5,7 @@ get: description: | Get the OpenAPI definition for Actor builds. Two similar endpoints are available: - - [First endpoint](/api/v2/act-openapi-json-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build. + - [First endpoint](/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](/api/v2/actor-build-openapi-json-get): Requires only `buildId`. Get the OpenAPI definition for a specific Actor build. @@ -13,7 +13,7 @@ get: :::note - You can also use the [`/api/v2/act-openapi-json-get`](/api/v2/act-openapi-json-get) endpoint to get the OpenAPI definition for a build. + You can also use the [`/api/v2/actor-openapi-json-get`](/api/v2/actor-openapi-json-get) endpoint to get the OpenAPI definition for a build. ::: operationId: actorBuild_openapi_json_get diff --git a/apify-api/openapi/paths/actors/acts.yaml b/apify-api/openapi/paths/actors/acts.yaml index da7ad1249b..6b4fc7fdf6 100644 --- a/apify-api/openapi/paths/actors/acts.yaml +++ b/apify-api/openapi/paths/actors/acts.yaml @@ -18,7 +18,7 @@ get: You can also sort by your last run by using the `sortBy=stats.lastRunStartedAt` query parameter. In this case, descending order means the most recently run Actor appears first. - operationId: acts_get + operationId: actors_get parameters: - name: my in: query @@ -109,7 +109,7 @@ post: under which that Actor will be classified in Apify Store. For this, it's best to use the [constants from our `apify-shared-js` package](https://github.com/apify/apify-shared-js/blob/2d43ebc41ece9ad31cd6525bd523fb86939bf860/packages/consts/src/consts.ts#L452-L471). - operationId: acts_post + operationId: actors_post requestBody: description: "" content: diff --git a/apify-api/openapi/paths/actors/acts@{actorId}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}.yaml index 0aa034385f..72fbd78809 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}.yaml @@ -3,7 +3,7 @@ get: - Actors summary: Get Actor description: Gets an object that contains all the details about a specific Actor. - operationId: act_get + operationId: actor_get parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" responses: @@ -122,7 +122,7 @@ put: under which that Actor will be classified in Apify Store. For this, it's best to use the [constants from our `apify-shared-js` package](https://github.com/apify/apify-shared-js/blob/2d43ebc41ece9ad31cd6525bd523fb86939bf860/packages/consts/src/consts.ts#L452-L471). - operationId: act_put + operationId: actor_put parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" requestBody: @@ -290,7 +290,7 @@ delete: - Actors summary: Delete Actor description: Deletes an Actor. - operationId: act_delete + operationId: actor_delete parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" responses: diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml index 6529f0df7d..28b64ac963 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml @@ -58,7 +58,7 @@ post: Builds an Actor. The response is the build object as returned by the [Get build](#/reference/actors/build-object/get-build) endpoint. - operationId: act_builds_post + operationId: actor_builds_post parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - name: version diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml index 9a642e2e92..b01e31afa1 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml @@ -10,7 +10,7 @@ get: This endpoint does not require an authentication token. Instead, calls are authenticated using the Actor's unique ID. However, if you access the endpoint without a token, certain attributes (e.g., `usageUsd` and `usageTotalUsd`) will be hidden. - operationId: act_build_default_get + operationId: actor_build_default_get security: [] parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml index 1d02015503..e9c9d57716 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml @@ -5,7 +5,7 @@ get: description: | Get the OpenAPI definition for Actor builds. Two similar endpoints are available: - - [First endpoint](/api/v2/act-openapi-json-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build. + - [First endpoint](/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](/api/v2/actor-build-openapi-json-get): Requires only `buildId`. @@ -19,7 +19,7 @@ get: You can also use the [`/api/v2/actor-build-openapi-json-get`](/api/v2/actor-build-openapi-json-get) endpoint to get the OpenAPI definition for a build. ::: - operationId: act_openapi_json_get + operationId: actor_openapi_json_get security: [] parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" 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 597970874d..bcb6a7fde8 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 @@ -27,7 +27,7 @@ post: To run the Actor asynchronously, use the [Run Actor](#/reference/actors/run-collection/run-actor) API endpoint instead. - operationId: act_runSyncGetDatasetItems_post + operationId: actor_runSyncGetDatasetItems_post parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../components/parameters/runAndBuildParameters.yaml#/timeout" @@ -132,7 +132,7 @@ get: To run the Actor asynchronously, use the [Run Actor](#/reference/actors/run-collection/run-actor) API endpoint instead. - operationId: act_runSyncGetDatasetItems_get + operationId: actor_runSyncGetDatasetItems_get parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../components/parameters/runAndBuildParameters.yaml#/timeout" 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 c98921d222..07fdcadd2d 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml @@ -23,7 +23,7 @@ post: To run the Actor asynchronously, use the [Run Actor](#/reference/actors/run-collection/run-actor) API endpoint instead. - operationId: act_runSync_post + operationId: actor_runSync_post parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../components/parameters/runAndBuildParameters.yaml#/outputRecordKey" @@ -101,7 +101,7 @@ get: To run the Actor asynchronously, use the [Run Actor](#/reference/actors/run-collection/run-actor) API endpoint instead. - operationId: act_runSync_get + operationId: actor_runSync_get parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../components/parameters/runAndBuildParameters.yaml#/outputRecordKey" diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml index ea63847dab..121bc5c0e3 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml @@ -83,7 +83,7 @@ post: 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. - operationId: act_runs_post + operationId: actor_runs_post parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../components/parameters/runAndBuildParameters.yaml#/timeout" diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml index ba9c9c3cad..5e4bc511e6 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml @@ -25,7 +25,7 @@ get: * [Log](/api/v2/last-actor-runs-log) - operationId: act_runs_last_get + operationId: actor_runs_last_get parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../components/parameters/runAndBuildParameters.yaml#/statusLastRun" diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@validate-input.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@validate-input.yaml index c47154af59..c361305bc5 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@validate-input.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@validate-input.yaml @@ -8,7 +8,7 @@ post: 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. - operationId: act_validateInput_post + operationId: actor_validateInput_post parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - name: build diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml index 8524e50722..3d71057676 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml @@ -6,7 +6,7 @@ get: Gets the list of versions of a specific Actor. The response is a JSON object with the list of [Version objects](#/reference/actors/version-object), where each contains basic information about a single version. - operationId: act_versions_get + operationId: actor_versions_get parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" responses: @@ -99,7 +99,7 @@ post: The response is the [Version object](#/reference/actors/version-object) as returned by the [Get version](#/reference/actors/version-object/get-version) endpoint. - operationId: act_versions_post + operationId: actor_versions_post parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" requestBody: diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml index 6c15a2dea4..7db2131c4e 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml @@ -4,7 +4,7 @@ get: summary: Get version description: | Gets a [Version object](#/reference/actors/version-object) that contains all the details about a specific version of an Actor. - operationId: act_version_get + operationId: actor_version_get parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../components/parameters/runAndBuildParameters.yaml#/versionNumber" @@ -46,7 +46,7 @@ delete: summary: Delete version description: | Deletes a specific version of Actor's source code. - operationId: act_version_delete + operationId: actor_version_delete parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../components/parameters/runAndBuildParameters.yaml#/versionNumber" diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml index 77f95fcc59..c533452d90 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml @@ -5,7 +5,7 @@ get: description: | Gets the list of environment variables for a specific version of an Actor. The response is a JSON object with the list of [EnvVar objects](#/reference/actors/environment-variable-object), where each contains basic information about a single environment variable. - operationId: act_version_envVars_get + operationId: actor_version_envVars_get parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../components/parameters/runAndBuildParameters.yaml#/versionNumber" @@ -60,7 +60,7 @@ post: object](#/reference/actors/environment-variable-object) as returned by the [Get environment variable](#/reference/actors/environment-variable-object/get-environment-variable) endpoint. - operationId: act_version_envVars_post + operationId: actor_version_envVars_post parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../components/parameters/runAndBuildParameters.yaml#/versionNumber" diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}.yaml index d13d638749..ae27878cab 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}.yaml @@ -7,7 +7,7 @@ get: contains all the details about a specific environment variable of an Actor. If `isSecret` is set to `true`, then `value` will never be returned. - operationId: act_version_envVar_get + operationId: actor_version_envVar_get parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../components/parameters/runAndBuildParameters.yaml#/versionNumber" @@ -61,7 +61,7 @@ delete: - Actors/Actor versions summary: Delete environment variable description: Deletes a specific environment variable. - operationId: act_version_envVar_delete + operationId: actor_version_envVar_delete parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../components/parameters/runAndBuildParameters.yaml#/versionNumber" diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@webhooks.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@webhooks.yaml index 60f3e2cf07..7d7108b5c8 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@webhooks.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@webhooks.yaml @@ -11,7 +11,7 @@ get: 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. - operationId: act_webhooks_get + operationId: actor_webhooks_get parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - $ref: "../../components/parameters/paginationParameters.yaml#/offset" diff --git a/nginx.conf b/nginx.conf index 83dcfaabf5..04fea105f3 100644 --- a/nginx.conf +++ b/nginx.conf @@ -790,6 +790,15 @@ server { rewrite ^/api/v2/users-monthly-usage$ /api/v2/users permanent; rewrite ^/api/v2/users-account-and-usage-limits$ /api/v2/users permanent; + # Actor API reference operation pages: legacy `act-*`/`acts-*` slugs -> `actor-*`/`actors-*`. + # Each page slug is kebab-case(operationId); the `act_*`/`acts_*` operationIds were renamed to + # `actor_*`/`actors_*` to match the canonical `/v2/actors/` naming. The deprecated actor-scoped + # build/run duplicates (act-build-get, act-builds-get, act-build-abort-post, act-run-get, + # act-runs-get, act-run-abort-post, act-run-metamorph-post) resolve to their canonical + # standalone actor-build*/actor-run* pages via the same act- -> actor- rewrite. + rewrite ^/api/v2/acts-(.*)$ /api/v2/actors-$1 permanent; + rewrite ^/api/v2/act-(.*)$ /api/v2/actor-$1 permanent; + # api/v2-new to api/v2 rewrite ^/api/v2-new(.*)$ /api/v2$1 permanent; rewrite ^/api/v2-old(.*)$ /api/v2$1 permanent; diff --git a/scripts/joinLlmsFiles.mjs b/scripts/joinLlmsFiles.mjs index caf10d8a88..ecdc0bfe91 100644 --- a/scripts/joinLlmsFiles.mjs +++ b/scripts/joinLlmsFiles.mjs @@ -13,22 +13,33 @@ const CURATED_FILE = path.resolve('scripts/llms-external-curated.txt'); // Do NOT add these to the plugin's `excludeRoutes` in docusaurus.config.js - // that would also drop the generated .md file from the build output. const LLMS_INDEX_EXCLUDE_PATTERNS = [ - // API: drop deprecated act-* endpoints + // API: drop deprecated actor-scoped act-* duplicates (their canonical pages live under + // actor-build*/actor-run*; these legacy slugs 301-redirect there) '/api/v2/act-*', // API: drop individual CRUD endpoint pages (keep Introduction pages) + '/api/v2/actor-get', + '/api/v2/actor-put', + '/api/v2/actor-delete', + '/api/v2/actor-openapi-json-get', + '/api/v2/actor-validate-input-post', + '/api/v2/actor-webhooks-get', + '/api/v2/actor-version-*', + '/api/v2/actor-versions-*', '/api/v2/actor-build-abort-post', + '/api/v2/actor-build-default-get', '/api/v2/actor-build-delete', '/api/v2/actor-build-get', '/api/v2/actor-build-log-get', '/api/v2/actor-build-openapi-json-get', '/api/v2/actor-builds-get', + '/api/v2/actor-builds-post', '/api/v2/actor-run-*', - '/api/v2/actor-runs-get', + '/api/v2/actor-runs-*', '/api/v2/actor-task-*', '/api/v2/actor-tasks-get', '/api/v2/actor-tasks-post', - '/api/v2/acts-get', - '/api/v2/acts-post', + '/api/v2/actors-get', + '/api/v2/actors-post', '/api/v2/dataset-*', '/api/v2/datasets-*', '/api/v2/key-value-store-*', diff --git a/sources/academy/platform/getting_started/apify_api.md b/sources/academy/platform/getting_started/apify_api.md index 56ceb5cf6c..2eb659801d 100644 --- a/sources/academy/platform/getting_started/apify_api.md +++ b/sources/academy/platform/getting_started/apify_api.md @@ -47,7 +47,7 @@ Let's say we want to run our **adding-actor** via API and view its results in CS https://api.apify.com/v2/actors/YOUR_USERNAME~adding-actor/run-sync-get-dataset-items?token=YOUR_TOKEN_HERE&format=csv ``` -Additional parameters can be passed to this endpoint. You can learn about them in our [API documentation](/api/v2/act-run-sync-get-dataset-items-post) +Additional parameters can be passed to this endpoint. You can learn about them in our [API documentation](/api/v2/actor-run-sync-get-dataset-items-post) :::caution Token security @@ -71,7 +71,7 @@ And there it is! The Actor was run with our inputs of **num1** and **num2**, the ## Apify API's many features {#api-many-features} -What we've done in this lesson only scratches the surface of what the Apify API can do. Right from Insomnia, or from any HTTP client, you can manage [datasets](/api/v2/storage-datasets) and [key-value stores](/api/v2/storage-key-value-stores), add to [request queues](/api/v2/storage-request-queues), [update Actors](/api/v2/act-put), and much more! Basically, whatever you can do on the platform's web interface, you also do through the API. +What we've done in this lesson only scratches the surface of what the Apify API can do. Right from Insomnia, or from any HTTP client, you can manage [datasets](/api/v2/storage-datasets) and [key-value stores](/api/v2/storage-key-value-stores), add to [request queues](/api/v2/storage-request-queues), [update Actors](/api/v2/actor-put), and much more! Basically, whatever you can do on the platform's web interface, you also do through the API. ## Next up {#next} diff --git a/sources/academy/platform/getting_started/apify_client.md b/sources/academy/platform/getting_started/apify_client.md index 14edeaa771..fad2d17fab 100644 --- a/sources/academy/platform/getting_started/apify_client.md +++ b/sources/academy/platform/getting_started/apify_client.md @@ -226,7 +226,7 @@ print(items) If you check the **Settings** tab within your **adding-actor**, you'll notice that the default timeout being set to the Actor is **360 seconds**. This is a bit overkill considering the fact that the Actor is only adding two numbers together - the run should never take more than 20 seconds (even this is a generous number). The default memory being allocated to the Actor is **256 MB**, which is reasonable for our purposes. -Let's change these two Actor settings via the Apify client using the [`actor.update()`](/api/client/js/reference/class/ActorClient#update) function. This function will call the **update Actor** endpoint, which can take `defaultRunOptions` as an input property. You can find the shape of the `defaultRunOptions` in the [API documentation](/api/v2/act-put). Perfect! +Let's change these two Actor settings via the Apify client using the [`actor.update()`](/api/client/js/reference/class/ActorClient#update) function. This function will call the **update Actor** endpoint, which can take `defaultRunOptions` as an input property. You can find the shape of the `defaultRunOptions` in the [API documentation](/api/v2/actor-put). Perfect! First, we'll create a pointer to our Actor, similar to before (except this time, we won't be using `.call()` at the end): diff --git a/sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md b/sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md index 06ba1119d0..3e120069da 100644 --- a/sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md +++ b/sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md @@ -85,7 +85,7 @@ If we press **Send**, it will immediately return some info about the run. The `s ![Actor run info in Postman](./images/run-info-postman.png) -We will later use this **run info** JSON to retrieve the run's output data. This info about the run can also be retrieved with another call to the [**Get run**](/api/v2/act-run-get) endpoint. +We will later use this **run info** JSON to retrieve the run's output data. This info about the run can also be retrieved with another call to the [**Get run**](/api/v2/actor-run-get) endpoint. ## JavaScript and Python client {#javascript-and-python-client} @@ -149,7 +149,7 @@ If your synchronous run exceeds the 5-minute time limit, the response will be a ### Synchronous runs with dataset output {#synchronous-runs-with-dataset-output} -Most Actor runs will store their data in the default [dataset](/platform/storage/dataset). The Apify API provides **run-sync-get-dataset-items** endpoints for [Actors](/api/v2/act-run-sync-get-dataset-items-post) and [tasks](/api/v2/actor-task-run-sync-get-dataset-items-post), which allow you to run an Actor and receive the items from the default dataset once the run has finished. +Most Actor runs will store their data in the default [dataset](/platform/storage/dataset). The Apify API provides **run-sync-get-dataset-items** endpoints for [Actors](/api/v2/actor-run-sync-get-dataset-items-post) and [tasks](/api/v2/actor-task-run-sync-get-dataset-items-post), which allow you to run an Actor and receive the items from the default dataset once the run has finished. Here is a Node.js example of calling a task via the API and logging the dataset items to the console: @@ -186,7 +186,7 @@ items.forEach((item) => { ### Synchronous runs with key-value store output {#synchronous-runs-with-key-value-store-output} -[Key-value stores](/platform/storage/key-value-store) are useful for storing files like images, HTML snapshots, or JSON data. The Apify API provides **run-sync** endpoints for [Actors](/api/v2/act-run-sync-post) and [tasks](/api/v2/actor-task-run-sync-post), which allow you to run a specific task and receive the output. By default, they return the `OUTPUT` record from the default key-value store. +[Key-value stores](/platform/storage/key-value-store) are useful for storing files like images, HTML snapshots, or JSON data. The Apify API provides **run-sync** endpoints for [Actors](/api/v2/actor-run-sync-post) and [tasks](/api/v2/actor-task-run-sync-post), which allow you to run a specific task and receive the output. By default, they return the `OUTPUT` record from the default key-value store. ## Asynchronous flow {#asynchronous-flow} diff --git a/sources/academy/tutorials/api/using_apify_from_php.md b/sources/academy/tutorials/api/using_apify_from_php.md index 43bae729df..90917bb972 100644 --- a/sources/academy/tutorials/api/using_apify_from_php.md +++ b/sources/academy/tutorials/api/using_apify_from_php.md @@ -52,7 +52,7 @@ If, instead of data, you see an error saying `Authentication token is not valid` Now that we have our guzzle client ready to go, we can run some Actors. Let's try the **Contact Details Scraper** ([vdrmota/contact-info-scraper](https://apify.com/vdrmota/contact-info-scraper)). -The [API reference](/api/v2/act-runs-post) states that an Actor's input should be passed as JSON in the request body. Other options are passed as query parameters. +The [API reference](/api/v2/actor-runs-post) states that an Actor's input should be passed as JSON in the request body. Other options are passed as query parameters. ```php // To run the Actor, we make a POST request to its run's endpoint diff --git a/sources/platform/actors/development/builds_and_runs/runs.md b/sources/platform/actors/development/builds_and_runs/runs.md index 5c949873d2..609d66fb90 100644 --- a/sources/platform/actors/development/builds_and_runs/runs.md +++ b/sources/platform/actors/development/builds_and_runs/runs.md @@ -12,7 +12,7 @@ When you start an Actor, you create a run. A run is a single execution of your A You can start an Actor in several ways: - Manually from the [Apify Console](https://console.apify.com/actors) UI -- Via the [Apify API](/api/v2/act-runs-post) +- Via the [Apify API](/api/v2/actor-runs-post) - Using the [Scheduler](../../../schedules.md) provided by the Apify platform - By one of the available [integrations](../../../integrations/index.mdx) diff --git a/sources/platform/actors/publishing/monetize/pay_per_event.mdx b/sources/platform/actors/publishing/monetize/pay_per_event.mdx index de1a85afb9..3e6e4e2c75 100644 --- a/sources/platform/actors/publishing/monetize/pay_per_event.mdx +++ b/sources/platform/actors/publishing/monetize/pay_per_event.mdx @@ -436,7 +436,7 @@ The platform usage costs are just examples, but you can see the actual costs in ## Event names -If you need to know your event names, you can retrieve the list of available pricing event names using the [Get Actor](https://apify.com/docs/api/v2/act-get) API endpoint. +If you need to know your event names, you can retrieve the list of available pricing event names using the [Get Actor](https://apify.com/docs/api/v2/actor-get) API endpoint. ## Next steps diff --git a/sources/platform/actors/running/index.md b/sources/platform/actors/running/index.md index f5eea28382..b798785381 100644 --- a/sources/platform/actors/running/index.md +++ b/sources/platform/actors/running/index.md @@ -59,7 +59,7 @@ Now you can go back to the **Input** tab and try again with different settings, ## Run Actors with the Apify API -To invoke Actors with the Apify API, send an HTTP POST request to the [Run Actor](/api/v2/act-runs-post) endpoint. For example: +To invoke Actors with the Apify API, send an HTTP POST request to the [Run Actor](/api/v2/actor-runs-post) endpoint. For example: ```text https://api.apify.com/v2/actors/compass~crawler-google-places/runs?token= @@ -120,4 +120,4 @@ print(dataset_items) The newly started Actor runs under the account associated with the provided `token`, so all consumed resources are charged to this user account. -Internally, the `call()` function invokes the [Run Actor](/api/v2/act-runs-post) API endpoint, waits for the Actor to finish, and reads its output using the [Get dataset items](/api/v2/dataset-items-get) API endpoint. +Internally, the `call()` function invokes the [Run Actor](/api/v2/actor-runs-post) API endpoint, waits for the Actor to finish, and reads its output using the [Get dataset items](/api/v2/dataset-items-get) API endpoint. diff --git a/sources/platform/actors/running/runs_and_builds.md b/sources/platform/actors/running/runs_and_builds.md index aab1249697..e830d49442 100644 --- a/sources/platform/actors/running/runs_and_builds.md +++ b/sources/platform/actors/running/runs_and_builds.md @@ -32,7 +32,7 @@ Each build might have different features, input, or output. By fixing the build On top of the number, some builds are also tagged. For example, _latest_ or _beta_. -Tags make it easier to specify which build to use when running an Actor. To reassign a tag to a different build, use the [Actor update](/api/v2/act-put) API endpoint. +Tags make it easier to specify which build to use when running an Actor. To reassign a tag to a different build, use the [Actor update](/api/v2/actor-put) API endpoint. ## Runs @@ -127,7 +127,7 @@ The whole process of resurrection looks as follows: - Updated duration will not include the time when the Actor was not running. - Timeout will be counted from the point when this Actor run was resurrected. -Resurrection can be performed in Apify Console using the **resurrect** button or via API using the [Resurrect run](/api/v2/act-run-resurrect-post) API endpoint. +Resurrection can be performed in Apify Console using the **resurrect** button or via API using the [Resurrect run](/api/v2/actor-run-resurrect-post) API endpoint. :::info Settings adjustments You can also adjust timeout and memory or change Actor build before the resurrection. This is especially helpful in case of an error in the Actor's source code as it enables you to: diff --git a/sources/platform/integrations/ai/agent-onboarding.md b/sources/platform/integrations/ai/agent-onboarding.md index edffdfdb6f..ce0d7b159e 100644 --- a/sources/platform/integrations/ai/agent-onboarding.md +++ b/sources/platform/integrations/ai/agent-onboarding.md @@ -86,7 +86,7 @@ The pattern is the same across every integration method: pick an Actor, send inp :::caution Cost controls -When an agent calls Actors automatically, set run limits to prevent surprise bills. Pass these as query parameters on the [run Actor endpoint](/api/v2/act-runs-post): +When an agent calls Actors automatically, set run limits to prevent surprise bills. Pass these as query parameters on the [run Actor endpoint](/api/v2/actor-runs-post): - `memory` (MB) - power of 2, minimum 128. Lower memory means lower cost per second. - `timeout` (seconds) - cap how long a single run can last. @@ -253,13 +253,13 @@ For HTTP-native integrations or languages without a dedicated client. Base URL: | Action | Method | Endpoint | | :--- | :--- | :--- | | [Search Actors in Store](/api/v2/store-get) | `GET` | `/v2/store` | -| [Get Actor details](/api/v2/act-get) | `GET` | `/v2/acts/{actorId}` | -| [Run an Actor](/api/v2/act-runs-post) | `POST` | `/v2/acts/{actorId}/runs` | -| [Run Actor (sync, get results)](/api/v2/act-run-sync-get-dataset-items-post) | `POST` | `/v2/acts/{actorId}/run-sync-get-dataset-items` | +| [Get Actor details](/api/v2/actor-get) | `GET` | `/v2/acts/{actorId}` | +| [Run an Actor](/api/v2/actor-runs-post) | `POST` | `/v2/acts/{actorId}/runs` | +| [Run Actor (sync, get results)](/api/v2/actor-run-sync-get-dataset-items-post) | `POST` | `/v2/acts/{actorId}/run-sync-get-dataset-items` | | [Get run status](/api/v2/actor-run-get) | `GET` | `/v2/actor-runs/{runId}` | | [Get dataset items](/api/v2/dataset-items-get) | `GET` | `/v2/datasets/{datasetId}/items` | -The sync endpoint ([`run-sync-get-dataset-items`](/api/v2/act-run-sync-get-dataset-items-post)) runs an Actor and returns results in a single request (waits up to 5 minutes). Use [async endpoints](/api/v2/act-runs-post) for longer runs. +The sync endpoint ([`run-sync-get-dataset-items`](/api/v2/actor-run-sync-get-dataset-items-post)) runs an Actor and returns results in a single request (waits up to 5 minutes). Use [async endpoints](/api/v2/actor-runs-post) for longer runs. For runs that take longer than the sync timeout, prefer [webhooks](/platform/integrations/webhooks) over polling - Apify will POST a notification to your URL when the run finishes, avoiding wasted requests. diff --git a/sources/platform/integrations/integrate_with_apify.md b/sources/platform/integrations/integrate_with_apify.md index ede30afa0e..d123ea28cf 100644 --- a/sources/platform/integrations/integrate_with_apify.md +++ b/sources/platform/integrations/integrate_with_apify.md @@ -74,7 +74,7 @@ Triggers the execution of any Apify Actor by ID, allowing users to start custom Recommended features: -- Select Actor: The Actor list will be pre-populated with Actors that the user created or used, using the [List of Actors API](https://docs.apify.com/api/v2/acts-get) and enriched with Actors from the store, which the user has not run already using [API](https://docs.apify.com/api/v2/store-get). +- Select Actor: The Actor list will be pre-populated with Actors that the user created or used, using the [List of Actors API](https://docs.apify.com/api/v2/actors-get) and enriched with Actors from the store, which the user has not run already using [API](https://docs.apify.com/api/v2/store-get). - Synchronous vs. asynchronous run: flow will wait until the run/task finishes (consider a timeout on your platform side) - Input UI: upon selecting an Actor, dynamically display specific Actor input and preload default example values based on the Actor Input schema. Alternatively, allow users to insert a JSON input for the Actor. - Additionally, it should include the option to choose [Actor build](https://docs.apify.com/platform/actors/running/runs-and-builds), [memory](https://docs.apify.com/platform/actors/running/usage-and-resources#memory), and [timeout](https://docs.apify.com/platform/actors/running/usage-and-resources#memory). @@ -133,7 +133,7 @@ Monitors the status of an Actor run by ID, useful for triggering follow-up steps Recommended features: -- _Select Actor runs to watch_: Dropdown (list of user's Actors). Populated via [List Actors API](https://docs.apify.com/api/v2/acts-get) +- _Select Actor runs to watch_: Dropdown (list of user's Actors). Populated via [List Actors API](https://docs.apify.com/api/v2/actors-get) ##### Watch task runs diff --git a/sources/platform/integrations/workflows-and-notifications/bubble.md b/sources/platform/integrations/workflows-and-notifications/bubble.md index 2b2f1e8e1a..4c48b23a7a 100644 --- a/sources/platform/integrations/workflows-and-notifications/bubble.md +++ b/sources/platform/integrations/workflows-and-notifications/bubble.md @@ -249,12 +249,12 @@ The Apify plugin provides two main types of operations: - [Get Record As File](https://docs.apify.com/api/v2/key-value-store-record-get) - [Get Record As Image File](https://docs.apify.com/api/v2/key-value-store-record-get) - [List Store Actors](https://docs.apify.com/api/v2/store-get) -- [List User Actors](https://docs.apify.com/api/v2/acts-get) +- [List User Actors](https://docs.apify.com/api/v2/actors-get) - [List User Tasks](https://docs.apify.com/api/v2/actor-tasks-get) -- [Scrape Single URL As File As Data](https://docs.apify.com/api/v2/act-run-sync-get-dataset-items-post) -- [Scrape Single URL As Json As Data](https://docs.apify.com/api/v2/act-run-sync-get-dataset-items-post) -- [List Actor Runs](https://docs.apify.com/api/v2/act-runs-get) -- [List Specific Actor Runs](https://docs.apify.com/api/v2/act-runs-get) +- [Scrape Single URL As File As Data](https://docs.apify.com/api/v2/actor-run-sync-get-dataset-items-post) +- [Scrape Single URL As Json As Data](https://docs.apify.com/api/v2/actor-run-sync-get-dataset-items-post) +- [List Actor Runs](https://docs.apify.com/api/v2/actor-runs-get) +- [List Specific Actor Runs](https://docs.apify.com/api/v2/actor-runs-get) - [List Webhooks](https://docs.apify.com/api/v2/webhooks-get) **Actions** (workflow steps): @@ -262,9 +262,9 @@ The Apify plugin provides two main types of operations: - [Fetch Data From Dataset Text As Action](https://docs.apify.com/api/v2/dataset-items-get) - [Fetch Data From Dataset File As Action](https://docs.apify.com/api/v2/dataset-items-get) - [Get Record As Text](https://docs.apify.com/api/v2/key-value-store-record-get) -- [Scrape Single URL As File As Action](https://docs.apify.com/api/v2/act-run-sync-get-dataset-items-post) -- [Scrape Single URL As Json As Action](https://docs.apify.com/api/v2/act-run-sync-get-dataset-items-post) -- [Run Actor](https://docs.apify.com/api/v2/act-runs-post) +- [Scrape Single URL As File As Action](https://docs.apify.com/api/v2/actor-run-sync-get-dataset-items-post) +- [Scrape Single URL As Json As Action](https://docs.apify.com/api/v2/actor-run-sync-get-dataset-items-post) +- [Run Actor](https://docs.apify.com/api/v2/actor-runs-post) - [Run Actor Task](https://docs.apify.com/api/v2/actor-task-runs-post) - [Create Webhook](https://docs.apify.com/api/v2/webhooks-post) - [Delete Webhook](https://docs.apify.com/api/v2/webhook-delete) diff --git a/sources/platform/integrations/workflows-and-notifications/dify.md b/sources/platform/integrations/workflows-and-notifications/dify.md index 231a41547a..d363c744f6 100644 --- a/sources/platform/integrations/workflows-and-notifications/dify.md +++ b/sources/platform/integrations/workflows-and-notifications/dify.md @@ -160,7 +160,7 @@ When triggering a Chatflow, you must provide a **Payload template** in the Apify ### Access Apify Data in Dify -When an Apify Actor run completes and triggers your Dify workflow, Apify sends a [JSON response object](https://docs.apify.com/api/v2/act-runs-post#responses) containing information about the completed run. This includes details like the run ID, Actor ID, dataset ID, and status. +When an Apify Actor run completes and triggers your Dify workflow, Apify sends a [JSON response object](https://docs.apify.com/api/v2/actor-runs-post#responses) containing information about the completed run. This includes details like the run ID, Actor ID, dataset ID, and status. #### Understand nested data access From 99ae0b9b6f71c28e71f5afc5dc6aa253dc9959c0 Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 17 Jun 2026 13:14:24 +0000 Subject: [PATCH 2/2] fix(nginx): exclude still-live act-* build/run pages from actor-* redirect The act-(.*) catch-all also matched 7 Actor-scoped build/run pages that were intentionally not renamed and still exist: it stripped the deprecation notice from the 5 deprecated pages (silent 301) and, worse, 301'd the two non-deprecated Actor-scoped list pages (act-builds-get, act-runs-get) to the account-wide actor-builds-get/actor-runs-get, which have a different scope and no equivalent. Add an exact-match guard that serves those 7 via `break`; every other moved act-* slug (incl. prefix-sharing ones like act-build-default-get) still 301s. Co-Authored-By: Claude Opus 4.8 (1M context) Claude-Session: https://claude.ai/code/session_01Q4HrVBuRKYG46ztwLXQkHz --- nginx.conf | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/nginx.conf b/nginx.conf index 04fea105f3..01d385cb05 100644 --- a/nginx.conf +++ b/nginx.conf @@ -792,11 +792,18 @@ server { # Actor API reference operation pages: legacy `act-*`/`acts-*` slugs -> `actor-*`/`actors-*`. # Each page slug is kebab-case(operationId); the `act_*`/`acts_*` operationIds were renamed to - # `actor_*`/`actors_*` to match the canonical `/v2/actors/` naming. The deprecated actor-scoped - # build/run duplicates (act-build-get, act-builds-get, act-build-abort-post, act-run-get, - # act-runs-get, act-run-abort-post, act-run-metamorph-post) resolve to their canonical - # standalone actor-build*/actor-run* pages via the same act- -> actor- rewrite. + # `actor_*`/`actors_*` to match the canonical `/v2/actors/` naming. No `acts-*` pages remain, so + # that rule is a plain catch-all. rewrite ^/api/v2/acts-(.*)$ /api/v2/actors-$1 permanent; + # These 7 Actor-scoped build/run pages still exist and must NOT be redirected: + # - 5 are deprecated (act-build-get, act-build-abort-post, act-run-get, act-run-abort-post, + # act-run-metamorph-post) and keep their own page so the deprecation notice + canonical link + # stay visible instead of a silent 301; + # - 2 are not deprecated, Actor-scoped list endpoints (act-builds-get = GET /v2/acts/{id}/builds, + # act-runs-get = GET /v2/acts/{id}/runs) with no account-wide actor-* equivalent. + # The guard rewrites them to themselves and breaks, so the catch-all below is skipped; every other + # moved act-* slug (incl. prefix-sharing ones like act-build-default-get) still 301s. + rewrite ^/api/v2/act-(build-get|builds-get|build-abort-post|run-get|runs-get|run-abort-post|run-metamorph-post)$ /api/v2/act-$1 break; rewrite ^/api/v2/act-(.*)$ /api/v2/actor-$1 permanent; # api/v2-new to api/v2