From 6604ddef77465b6eac86c3072e2fb980c65577d6 Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 19 Oct 2026 12:21:00 +0000 Subject: [PATCH 1/6] docs: replace "(More info)." links with "Learn more" Drop the parentheses and trailing period around "More info" links in the OpenAPI spec and platform docs, and point the API authentication links to the Get started page, since the old #/introduction/authentication anchor did not resolve on individual endpoint pages. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01Y6QEzb6KwtQKFiG83nzg5J --- ...d}@versions@{versionNumber}@env-vars@{envVarName}put.yaml | 4 ++-- .../actors/acts@{actorId}@versions@{versionNumber}put.yaml | 4 ++-- apify-api/openapi/components/securitySchemes/httpBearer.yaml | 2 +- apify-api/openapi/openapi.yaml | 5 ++--- .../paths/actor-tasks/actor-tasks@{actorTaskId}@input.yaml | 4 ++-- apify-api/openapi/paths/schedules/schedules.yaml | 4 ++-- .../openapi/paths/schedules/schedules@{scheduleId}.yaml | 4 ++-- apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml | 4 ++-- sources/platform/actors/running/schedules.md | 2 +- sources/platform/proxy/index.md | 2 +- 10 files changed, 17 insertions(+), 18 deletions(-) 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 2d11bc6f66..5a6c078035 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 @@ -71,8 +71,8 @@ put: header! When providing your API authentication token, we recommend using the - request's `Authorization` header, rather than the URL. ([More - info](#/introduction/authentication)). + request's `Authorization` header, rather than the URL. + [Learn more](/api/v2/getting-started#authentication) 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) 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 d27decd93e..feab92705f 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 @@ -66,8 +66,8 @@ put: header! When providing your API authentication token, we recommend using the - request's `Authorization` header, rather than the URL. ([More - info](#/introduction/authentication)). + request's `Authorization` header, rather than the URL. + [Learn more](/api/v2/getting-started#authentication) The response is the [Version object](#/reference/actors/version-object) as returned by the [Get version](#/reference/actors/version-object/get-version) endpoint. diff --git a/apify-api/openapi/components/securitySchemes/httpBearer.yaml b/apify-api/openapi/components/securitySchemes/httpBearer.yaml index 78800babc7..43d9be5d81 100644 --- a/apify-api/openapi/components/securitySchemes/httpBearer.yaml +++ b/apify-api/openapi/components/securitySchemes/httpBearer.yaml @@ -1,7 +1,7 @@ type: http scheme: bearer description: |- - Bearer token provided in the `Authorization` header (e.g., `Authorization: Bearer your_token`—recommended). [More info](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization). + Bearer token provided in the `Authorization` header (e.g., `Authorization: Bearer your_token`—recommended). [Learn more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) Use your API token to authenticate requests. You can find it on the [Integrations page](https://console.apify.com/account#/integrations) in Apify Console. This method is more secure than query parameters, as headers are not logged in browser history or server logs. diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index cc92e754e2..37d820b4e5 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -53,10 +53,9 @@ info: To use your token in a request, either: - - Add the token to your request's `Authorization` header as `Bearer `. + - Add the token to your request's `Authorization` header as `Bearer ` (recommended). E.g., `Authorization: Bearer xxxxxxx`. - [More info](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization). - (Recommended). + [Learn more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) - Add it as the `token` parameter to your request URL. (Less secure). Using your token in the request header is more secure than using it as a URL diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@input.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@input.yaml index 90370d56f5..4a46520539 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@input.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@input.yaml @@ -58,8 +58,8 @@ put: header! When providing your API authentication token, we recommend using the - request's `Authorization` header, rather than the URL. ([More - info](#/introduction/authentication)). + request's `Authorization` header, rather than the URL. + [Learn more](/api/v2/getting-started#authentication) operationId: actorTask_input_put parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorTaskId" diff --git a/apify-api/openapi/paths/schedules/schedules.yaml b/apify-api/openapi/paths/schedules/schedules.yaml index 5931ccccc0..51ec616891 100644 --- a/apify-api/openapi/paths/schedules/schedules.yaml +++ b/apify-api/openapi/paths/schedules/schedules.yaml @@ -56,8 +56,8 @@ post: The request needs to specify the `Content-Type: application/json` HTTP header! When providing your API authentication token, we recommend using the - request's `Authorization` header, rather than the URL. ([More - info](#/introduction/authentication)). + request's `Authorization` header, rather than the URL. + [Learn more](/api/v2/getting-started#authentication) operationId: schedules_post requestBody: description: "" diff --git a/apify-api/openapi/paths/schedules/schedules@{scheduleId}.yaml b/apify-api/openapi/paths/schedules/schedules@{scheduleId}.yaml index 37026eac78..56867395b0 100644 --- a/apify-api/openapi/paths/schedules/schedules@{scheduleId}.yaml +++ b/apify-api/openapi/paths/schedules/schedules@{scheduleId}.yaml @@ -53,8 +53,8 @@ put: header!** When providing your API authentication token, we recommend using the - request's `Authorization` header, rather than the URL. ([More - info](#/introduction/authentication)). + request's `Authorization` header, rather than the URL. + [Learn more](/api/v2/getting-started#authentication) operationId: schedule_put parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/scheduleId" diff --git a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml index cf5a2971a7..5360a48120 100644 --- a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml +++ b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml @@ -54,8 +54,8 @@ put: header! When providing your API authentication token, we recommend using the - request's `Authorization` header, rather than the URL. ([More - info](#/introduction/authentication)). + request's `Authorization` header, rather than the URL. + [Learn more](/api/v2/getting-started#authentication) operationId: webhook_put parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/webhookId" diff --git a/sources/platform/actors/running/schedules.md b/sources/platform/actors/running/schedules.md index 6dd743ced4..8664891787 100644 --- a/sources/platform/actors/running/schedules.md +++ b/sources/platform/actors/running/schedules.md @@ -75,7 +75,7 @@ To create a new [schedule](/api/v2/schedules) using the Apify API, send a `POST` You can find your [secret API token](/integrations) under the [API & Integrations](https://console.apify.com/settings/integrations) tab of your Apify account settings. :::caution API authentication recommendations -When providing your API authentication token, we recommend using the request's `Authorization` header, rather than the URL ([more info](/api/v2#authentication)). +When providing your API authentication token, we recommend using the request's `Authorization` header, rather than the URL. [Learn more](/api/v2/getting-started#authentication) ::: In the `POST` request's payload should be a JSON object specifying the schedule's name, your [user ID](https://console.apify.com/settings/integrations), and the schedule's _actions_. diff --git a/sources/platform/proxy/index.md b/sources/platform/proxy/index.md index dad87cd46b..a250edc4e9 100644 --- a/sources/platform/proxy/index.md +++ b/sources/platform/proxy/index.md @@ -240,7 +240,7 @@ Sessions allow you to use the same IP address for multiple connections. When you To set a new session, pass the `session` parameter in your [username](#username-parameters) field when connecting to a proxy. This will serve as the session's ID and an IP address will be assigned to it. To [use that IP address in other requests](/proxy/datacenter-proxy#connecting-to-datacenter-proxies), pass that same session ID in the username field. We recommend the [SessionPool](https://crawlee.dev/api/core/class/SessionPool) abstraction for managing sessions. The created session will then store information such as cookies and can be used to generate [browser fingerprints](/academy/anti-scraping/mitigation/generating-fingerprints). You can also assign custom user data such as authorization tokens and specific headers. -Sessions are available for [datacenter](./datacenter_proxy.md) and [residential](./residential_proxy.md#session-persistence) proxies. For datacenter proxies, a session persists for **26 hours** ([more info](./datacenter_proxy.md)). For residential proxies, it persists for around **30 minutes** ([more info](./residential_proxy.md#session-persistence)). Google SERP proxies do not support sessions. +Sessions are available for [datacenter](./datacenter_proxy.md) and [residential](./residential_proxy.md#session-persistence) proxies. For datacenter proxies, a session persists for **26 hours**. For residential proxies, it persists for around **30 minutes**. Google SERP proxies do not support sessions. ## Proxy groups From a297cdc4d22c9e5715cbbf0562291cf21d612afd Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 20 Oct 2026 13:38:15 +0000 Subject: [PATCH 2/6] docs: name linked API endpoints by their current summaries Link text pointing to API reference pages now matches each endpoint's current summary (or endpoint group title), across the OpenAPI spec and platform/academy pages. Legacy #/reference/... and #tag/... anchors to endpoints are replaced with /api/v2/ paths, since those anchors only exist on the target page itself. AGENTS.md now states the rule. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01Y6QEzb6KwtQKFiG83nzg5J --- AGENTS.md | 11 +++ .../components/objects/actor-runs/abort.yaml | 4 +- .../objects/actor-runs/metamorph.yaml | 4 +- .../components/objects/actor-runs/reboot.yaml | 4 +- ...rsionNumber}@env-vars@{envVarName}put.yaml | 4 +- ...{actorId}@versions@{versionNumber}put.yaml | 4 +- .../components/objects/datasets/dataset.yaml | 6 +- .../key-value-store-record.yaml | 4 +- .../key-value-store-records.yaml | 14 +-- .../key-value-stores/key-value-store.yaml | 3 +- .../objects/request-queues/request-queue.yaml | 2 +- .../parameters/requestQueueParameters.yaml | 3 +- apify-api/openapi/components/tags.yaml | 6 +- apify-api/openapi/openapi.yaml | 86 ++++++++----------- .../actor-builds@{buildId}@openapi.json.yaml | 6 +- .../paths/actor-runs/actor-runs@{runId}.yaml | 6 +- .../actor-tasks@{actorTaskId}@input.yaml | 2 +- ...torTaskId}@run-sync-get-dataset-items.yaml | 12 +-- .../actor-tasks@{actorTaskId}@run-sync.yaml | 5 +- .../actor-tasks@{actorTaskId}@runs.yaml | 11 ++- .../actor-tasks@{actorTaskId}@runs@last.yaml | 10 +-- .../paths/actors/acts@{actorId}@builds.yaml | 2 +- ...ctorId}@builds@{buildId}@openapi.json.yaml | 6 +- ...@{actorId}@run-sync-get-dataset-items.yaml | 12 +-- .../paths/actors/acts@{actorId}@run-sync.yaml | 6 +- .../paths/actors/acts@{actorId}@runs.yaml | 11 ++- .../actors/acts@{actorId}@runs@last.yaml | 10 +-- .../paths/actors/acts@{actorId}@versions.yaml | 2 +- ...Id}@versions@{versionNumber}@env-vars.yaml | 3 +- .../schedules/schedules@{scheduleId}.yaml | 2 +- apify-api/openapi/paths/store/store.yaml | 3 +- .../paths/webhooks/webhooks@{webhookId}.yaml | 2 +- .../how-to-build/running_a_web_server.md | 2 +- .../platform/getting_started/apify_api.md | 4 +- .../platform/getting_started/apify_client.md | 2 +- .../run_actor_and_retrieve_data_via_api.md | 20 ++--- .../tutorials/api/using_apify_from_php.md | 8 +- .../node_js/apify_free_google_serp_api.md | 2 +- .../collaboration/general-resource-access.md | 6 +- .../development/builds_and_runs/runs.md | 2 +- .../container_web_server.md | 2 +- .../actors/publishing/publish-task.mdx | 2 +- .../actors/running/runs_and_builds.md | 4 +- sources/platform/actors/running/schedules.md | 4 +- sources/platform/actors/running/tasks.md | 4 +- .../platform/get-started/agent-onboarding.md | 14 +-- sources/platform/integrations/actors/index.md | 2 +- sources/platform/integrations/ai/skyfire.md | 10 +-- sources/platform/integrations/ai/x402.md | 2 +- .../integrations/integrate-with-apify.md | 12 +-- .../programming/webhooks/events.md | 2 +- .../storage/dataset/dataset_schema.md | 2 +- sources/platform/storage/dataset/index.md | 4 +- .../storage/dataset/multiple_datasets.mdx | 2 +- sources/platform/storage/index.md | 2 +- .../platform/storage/key_value_store/index.md | 4 +- sources/platform/storage/request_queue.md | 12 +-- 57 files changed, 189 insertions(+), 207 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index ad86ccd119..88f66b8bdb 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -90,6 +90,17 @@ schema: const: "constantValue" ``` +### Links to API endpoints + +Applies to every link to an API reference page, in the OpenAPI spec and in `sources/`: + +- Use the endpoint's current `summary` as the link text, exactly as written in the spec: `[Get dataset items](/api/v2/dataset-items-get)`, not `[List items](…)`, `[API](…)` or `[documentation](…)`. Keep "endpoint" or "API reference" outside the link: `use the [Run Actor](/api/v2/actors-runs-post) endpoint` +- Link to an endpoint group page with that group's current title, for example `[Manage Actor runs](/api/v2/actor-runs)` +- Link to the page path (`/api/v2/`), never to legacy anchors such as `#/reference/...` or `#tag/.../operation/...`. Those anchors only exist on the target page itself, so they lead nowhere from any other page +- When you rename an endpoint's `summary`, update the link text of every link to it across the repo (`grep -rn "/api/v2/"`) +- When two endpoints share a summary, add the path after the link to tell them apart +- Exception: link text that has to match a name in another product, such as Bubble plugin action names, stays as it is + ### Python API client model generation `apify-client-python` generates its Pydantic models from the **published** spec, and it pulls them on its own schedule - this repo does not push anything to it: diff --git a/apify-api/openapi/components/objects/actor-runs/abort.yaml b/apify-api/openapi/components/objects/actor-runs/abort.yaml index 9610dcea9d..ecbddeefc5 100644 --- a/apify-api/openapi/components/objects/actor-runs/abort.yaml +++ b/apify-api/openapi/components/objects/actor-runs/abort.yaml @@ -81,7 +81,7 @@ lastRunByActor: Aborts the last run of the specified Actor and returns an object that contains all the details about the run. - This endpoint is a shortcut for [Abort run](#/reference/actor-runs/abort-run/abort-run) + This endpoint is a shortcut for [Abort Actor run](/api/v2/actor-run-abort-post) 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. @@ -101,7 +101,7 @@ lastRunByActorTask: Aborts the last run of the specified Actor task and returns an object that contains all the details about the run. - This endpoint is a shortcut for [Abort run](#/reference/actor-runs/abort-run/abort-run) + This endpoint is a shortcut for [Abort Actor run](/api/v2/actor-run-abort-post) on the Actor task's last run. Only runs that are starting or running are aborted. For runs with status `FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call does nothing. diff --git a/apify-api/openapi/components/objects/actor-runs/metamorph.yaml b/apify-api/openapi/components/objects/actor-runs/metamorph.yaml index cdf5ec265f..900f1d31a7 100644 --- a/apify-api/openapi/components/objects/actor-runs/metamorph.yaml +++ b/apify-api/openapi/components/objects/actor-runs/metamorph.yaml @@ -120,7 +120,7 @@ lastRunByActor: Transforms the last run of the specified Actor into a run of another Actor with a new input. - This endpoint is a shortcut for [Metamorph run](#/reference/actor-runs/metamorph-run/metamorph-run) + This endpoint is a shortcut for [Metamorph Actor run](/api/v2/actor-run-metamorph-post) on the Actor's last run. operationId: actor_runs_last_metamorph_post parameters: @@ -139,7 +139,7 @@ lastRunByActorTask: Transforms the last run of the specified Actor task into a run of another Actor with a new input. - This endpoint is a shortcut for [Metamorph run](#/reference/actor-runs/metamorph-run/metamorph-run) + This endpoint is a shortcut for [Metamorph Actor run](/api/v2/actor-run-metamorph-post) on the Actor task's last run. operationId: actorTask_runs_last_metamorph_post parameters: diff --git a/apify-api/openapi/components/objects/actor-runs/reboot.yaml b/apify-api/openapi/components/objects/actor-runs/reboot.yaml index da3d4989ec..b0b60d3ced 100644 --- a/apify-api/openapi/components/objects/actor-runs/reboot.yaml +++ b/apify-api/openapi/components/objects/actor-runs/reboot.yaml @@ -57,7 +57,7 @@ lastRunByActor: Reboots the last run of the specified Actor and returns an object that contains all the details about the rebooted run. - This endpoint is a shortcut for [Reboot run](#/reference/actor-runs/reboot-run/reboot-run) + This endpoint is a shortcut for [Reboot Actor run](/api/v2/actor-run-reboot-post) 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. @@ -76,7 +76,7 @@ lastRunByActorTask: Reboots the last run of the specified Actor task and returns an object that contains all the details about the rebooted run. - This endpoint is a shortcut for [Reboot run](#/reference/actor-runs/reboot-run/reboot-run) + This endpoint is a shortcut for [Reboot Actor run](/api/v2/actor-run-reboot-post) on the Actor task's last run. Only runs with status `RUNNING` can be rebooted. The run's container will be restarted, so any data not persisted in the key-value store, dataset, or request queue will be lost. 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 9b34781c9e..c357c21aa2 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 @@ -75,7 +75,7 @@ put: [Learn more](/api/v2/getting-started#authentication) 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) + [Get environment variable of Actor version](/api/v2/actor-version-env-var-get) endpoint. operationId: actor_version_envVar_put x-legacy-doc-urls: @@ -90,7 +90,7 @@ post: Updates Actor environment variable using values specified by a [EnvVar 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. + This endpoint is an alias for the [Update environment variable in Actor version](/api/v2/actor-version-env-var-put) endpoint and behaves identically. operationId: actor_version_envVar_post x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/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 04a81ddc41..e47f3ddbd7 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 @@ -70,7 +70,7 @@ put: [Learn more](/api/v2/getting-started#authentication) The response is the [Version object](#/reference/actors/version-object) as - returned by the [Get version](#/reference/actors/version-object/get-version) endpoint. + returned by the [Get Actor version](/api/v2/actor-version-get) endpoint. operationId: actor_version_put x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/version-object/update-version @@ -82,7 +82,7 @@ post: summary: Update Actor version (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. + This endpoint is an alias for the [Update Actor version](/api/v2/actor-version-put) endpoint and behaves identically. operationId: actor_version_post x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/version-object/update-version diff --git a/apify-api/openapi/components/objects/datasets/dataset.yaml b/apify-api/openapi/components/objects/datasets/dataset.yaml index eb1931d53e..1056f3359b 100644 --- a/apify-api/openapi/components/objects/datasets/dataset.yaml +++ b/apify-api/openapi/components/objects/datasets/dataset.yaml @@ -63,7 +63,7 @@ getById: Returns dataset object for given dataset ID. This does not return dataset items, only information about the storage itself. - To retrieve dataset items, use the [List dataset items](/api/v2/dataset-items-get) endpoint. + To retrieve dataset items, use the [Get dataset items](/api/v2/dataset-items-get) endpoint. :::note @@ -157,7 +157,7 @@ putDefault: Updates the default dataset associated with an Actor run. This endpoint is a shortcut for getting the run's `defaultDatasetId` and then using the - [Put dataset](/api/v2/dataset-put) endpoint. + [Update dataset](/api/v2/dataset-put) endpoint. operationId: actorRun_dataset_put @@ -208,7 +208,7 @@ deleteDefault: Deletes default dataset associated with an Actor run. This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the - [ Delete dataset ](/api/v2/dataset-delete) endpoint. + [Delete dataset](/api/v2/dataset-delete) endpoint. operationId: actorRun_dataset_delete deleteLastRun: 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 a5905318ee..b698d4674c 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 @@ -102,7 +102,7 @@ getById: Gets a value stored in the key-value store under a specific key. The response body has the same `Content-Encoding` header as it was set in - [Put record](#tag/Key-value-storesRecord/operation/keyValueStore_record_put). + [Set key-value store record](/api/v2/key-value-store-record-put). If the request does not define the `Accept-Encoding` HTTP header with the right encoding, the record will be decompressed. @@ -290,7 +290,7 @@ postById: description: | Stores a value under a specific key to the key-value store. - This endpoint is an alias for the [`PUT` record](#tag/Key-value-storesRecord/operation/keyValueStore_record_put) method and behaves identically. + This endpoint is an alias for the [Set key-value store record](/api/v2/key-value-store-record-put) endpoint and behaves identically. operationId: keyValueStore_record_post parameters: - $ref: "../../parameters/keyValueStoreParameters.yaml#/storeId" 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 266ab2e19f..5bcbd7dfa0 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 @@ -181,7 +181,7 @@ postById: summary: Store record (POST) description: | Stores a value under a specific key to the key-value store. - This endpoint is an alias for the [`PUT` record](#tag/Key-value-storesRecord/operation/keyValueStore_record_put) method and behaves identically. + This endpoint is an alias for the [Set key-value store record](/api/v2/key-value-store-record-put) endpoint and behaves identically. operationId: keyValueStore_record_post parameters: - $ref: "../../parameters/keyValueStoreParameters.yaml#/storeId" @@ -195,7 +195,7 @@ putDefault: Stores a value under a specific key to the key-value store. This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the - [PUT record](/api/v2/key-value-store-record-put) endpoint. + [Set key-value store record](/api/v2/key-value-store-record-put) endpoint. operationId: keyValueStore_record_put parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/runId" @@ -219,7 +219,7 @@ postDefault: Stores a value under a specific key to the key-value store. This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the - [POST record](/api/v2/key-value-store-record-post) endpoint. + [Set key-value store record (POST)](/api/v2/key-value-store-record-post) endpoint. operationId: keyValueStore_record_post parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/runId" @@ -233,7 +233,7 @@ putLastRun: Stores a value under a specific key to the key-value store. This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the - [PUT record](/api/v2/key-value-store-record-put) endpoint. + [Set key-value store record](/api/v2/key-value-store-record-put) endpoint. operationId: keyValueStore_record_put parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" @@ -257,7 +257,7 @@ postLastRun: Stores a value under a specific key to the key-value store. This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the - [POST record](/api/v2/key-value-store-record-post) endpoint. + [Set key-value store record (POST)](/api/v2/key-value-store-record-post) endpoint. operationId: keyValueStore_record_post parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" @@ -271,7 +271,7 @@ putTaskLastRun: Stores a value under a specific key to the default key-value store of the last Actor task run. This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the - [PUT record](/api/v2/key-value-store-record-put) endpoint. + [Set key-value store record](/api/v2/key-value-store-record-put) endpoint. operationId: actorTask_runs_last_keyValueStore_records_put parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId" @@ -285,7 +285,7 @@ postTaskLastRun: Stores a value under a specific key to the default key-value store of the last Actor task run. This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the - [POST record](/api/v2/key-value-store-record-post) endpoint. + [Set key-value store record (POST)](/api/v2/key-value-store-record-post) endpoint. operationId: actorTask_runs_last_keyValueStore_records_post parameters: - $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId" 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 70e014efcd..d54b991980 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 @@ -132,8 +132,7 @@ putById: Updates a key-value store's name and general resource access level using a value specified by a JSON object passed in the PUT payload. - The response is the updated key-value store object, as returned by the [Get - store](#/reference/key-value-stores/store-object/get-store) API endpoint. + The response is the updated key-value store object, as returned by the [Get key-value store](/api/v2/key-value-store-get) API endpoint. operationId: keyValueStore_put x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store 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 2b3bb06228..580b15987b 100644 --- a/apify-api/openapi/components/objects/request-queues/request-queue.yaml +++ b/apify-api/openapi/components/objects/request-queues/request-queue.yaml @@ -131,7 +131,7 @@ putById: passed in the PUT payload. The response is the updated request queue object, as returned by the - [Get request queue](#/reference/request-queues/queue-collection/get-request-queue) API endpoint. + [Get request queue](/api/v2/request-queue-get) API endpoint. operationId: requestQueue_put x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue diff --git a/apify-api/openapi/components/parameters/requestQueueParameters.yaml b/apify-api/openapi/components/parameters/requestQueueParameters.yaml index c0627232af..5307a02aeb 100644 --- a/apify-api/openapi/components/parameters/requestQueueParameters.yaml +++ b/apify-api/openapi/components/parameters/requestQueueParameters.yaml @@ -27,8 +27,7 @@ clientKey: determine whether the queue was accessed by multiple clients. If `clientKey` is not provided, the system considers this API call to come from a new client. For - details, see the `hadMultipleClients` field returned by the [Get - head](#/reference/request-queues/queue-head) operation. + details, see the `hadMultipleClients` field returned by the [Get request queue head](/api/v2/request-queue-head-get) endpoint. style: form explode: true schema: diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index 35b7084f92..fc32ff698c 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -373,7 +373,7 @@ Each schedule is assigned actions for it to perform. Actions can be of two types - `RUN_ACTOR` and `RUN_ACTOR_TASK`. - For details, see the documentation of the [Get schedule](#/reference/schedules/schedule-object/get-schedule) endpoint. + For details, see the documentation of the [Get schedule](/api/v2/schedule-get) endpoint. x-trait: "true" - name: Store x-displayName: Get data from Apify Store @@ -488,7 +488,7 @@ description: | The API endpoint described in this section is convenience endpoint that provides access to last Actor run's log. - Same as of functionality described in: [Logs](/api/v2/logs) + Same as of functionality described in: [Get build and run logs](/api/v2/logs) - name: Last Actor run's abort x-displayName: Last Actor run's abort description: | @@ -512,7 +512,7 @@ description: | The API endpoint described in this section is convenience endpoint that provides access to last Actor task run's log. - Same as of functionality described in: [Logs](/api/v2/logs) + Same as of functionality described in: [Get build and run logs](/api/v2/logs) - name: Last Actor task run's abort x-displayName: Last Actor task run's abort description: | diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index 37d820b4e5..aeec705762 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -81,8 +81,7 @@ info: ## Basic usage - To run an Actor, send a POST request to the [Run - Actor](#/reference/actors/run-collection/run-actor) endpoint using either the + To run an Actor, send a POST request to the [Run Actor](/api/v2/actors-runs-post) endpoint using either the Actor ID code (e.g. `vKg4IjxZbEYTYeW8T`) or its name (e.g. `janedoe~my-actor`): @@ -95,8 +94,7 @@ info: `Authorization` header ([recommended](#/introduction/authentication)) or as a URL query parameter `?token=[your_token]` (less secure). - Optionally, you can include the query parameters described in the [Run - Actor](#/reference/actors/run-collection/run-actor) section to customize your + Optionally, you can include the query parameters described in the [Run Actor](/api/v2/actors-runs-post) section to customize your run. If you're using Node.js, the best way to run an Actor is using the @@ -110,23 +108,20 @@ info: A typical workflow is as follows: - 1. Run an Actor or task using the [Run - Actor](#/reference/actors/run-collection/run-actor) or [Run - task](#/reference/actor-tasks/run-collection/run-task) API endpoints. - 2. Monitor the Actor run by periodically polling its progress using the [Get - run](#/reference/actor-runs/run-object-and-its-storages/get-run) API + 1. Run an Actor or task using the [Run Actor](/api/v2/actors-runs-post) or + [Run Actor task](/api/v2/actor-task-runs-post) API endpoints. + 2. Monitor the Actor run by periodically polling its progress using the [Get Actor run](/api/v2/actor-run-get) API endpoint. - 3. Fetch the results from the [Get - items](#/reference/datasets/item-collection/get-items) API endpoint using the + 3. Fetch the results from the [Get dataset items](/api/v2/dataset-items-get) API endpoint using the `defaultDatasetId`, which you receive in the Run request response. Additional data may be stored in a key-value store. You can fetch them from - the [Get record](#/reference/key-value-stores/record/get-record) API endpoint + the [Get key-value store record](/api/v2/key-value-store-record-get) API endpoint using the `defaultKeyValueStoreId` and the store's `key`. - **Note**: Instead of periodic polling, you can also run your - [Actor](#/reference/actors/run-actor-synchronously) or - [task](#/reference/actor-tasks/runs-collection/run-task-synchronously) - synchronously. This will ensure that the request waits for 300 seconds (5 + **Note**: Instead of periodic polling, you can also run your Actor or task synchronously with the + [Run Actor synchronously and get key-value store record](/api/v2/actor-run-sync-post) or + [Run Actor task synchronously and get key-value store record](/api/v2/actor-task-run-sync-post) + endpoint. This will ensure that the request waits for 300 seconds (5 minutes) for the run to finish and returns its output. If the run takes longer, the request will time out and throw an error. @@ -152,8 +147,8 @@ info: ``` However, there are a few explicitly described exceptions, such as - [Get dataset items](#/reference/datasets/item-collection/get-items) or - Key-value store [Get record](#/reference/key-value-stores/record/get-record) + [Get dataset items](/api/v2/dataset-items-get) or + [Get key-value store record](/api/v2/key-value-store-record-get) API endpoints, which return data in other formats. In case of an error, the response has the HTTP status code in the range of 4xx or 5xx and the `data` property is replaced with `error`. For example: @@ -173,14 +168,13 @@ info: All API endpoints that return a list of records - (e.g. [Get list of - Actors](#/reference/actors/actor-collection/get-list-of-actors)) + (e.g. [Get list of Actors](/api/v2/actors-get)) enforce pagination in order to limit the size of their responses. Most of these API endpoints are paginated using the `offset` and `limit` query parameters. - The only exception is [Get list of - keys](#/reference/key-value-stores/key-collection/get-list-of-keys), + The only exception is + [Get list of key-value store keys](/api/v2/key-value-store-keys-get), which is paginated using the `exclusiveStartKey` query parameter. **IMPORTANT**: Each API endpoint that supports pagination enforces a certain @@ -280,8 +274,8 @@ info: store](https://docs.apify.com/platform/storage/key-value-store) are not ordered based on numerical indexes, but rather by their keys in the UTF-8 binary order. - Therefore the [Get list of - keys](#/reference/key-value-stores/key-collection/get-list-of-keys) + Therefore the + [Get list of key-value store keys](/api/v2/key-value-store-keys-get) API endpoint only supports pagination using the following query parameters: @@ -434,43 +428,37 @@ info: These endpoints have a rate limit of _35 requests per second per resource_: - * Batch ([add](#/reference/request-queues/batch-request-operations/add-requests), - [delete](#/reference/request-queues/batch-request-operations/delete-requests)) - operations on requests in request queues - * [List and lock head](#/reference/request-queues/queue-head-with-locks/list-and-lock-head) of a request queue + * [Batch add requests to request queue](/api/v2/request-queue-requests-batch-post) + * [Batch delete requests from request queue](/api/v2/request-queue-requests-batch-delete) + * [Get and lock request queue head](/api/v2/request-queue-head-lock-post) These endpoints have a rate limit of _100 requests per second per resource_: - * Download records from a key-value store as a ZIP archive + * [Download key-value store records](/api/v2/key-value-store-records-get) (ZIP archive) These endpoints have a rate limit of _200 requests per second per resource_: - * CRUD ([get](#/reference/key-value-stores/record/get-record), - [put](#/reference/key-value-stores/record/put-record), - [delete](#/reference/key-value-stores/record/delete-record)) - operations on key-value store records - * [Get list of keys](#/reference/key-value-stores/key-collection/get-list-of-keys) in a key-value store + * [Get key-value store record](/api/v2/key-value-store-record-get) + * [Set key-value store record](/api/v2/key-value-store-record-put) + * [Delete key-value store record](/api/v2/key-value-store-record-delete) + * [Get list of key-value store keys](/api/v2/key-value-store-keys-get) These endpoints have a rate limit of _350 requests per second per resource_: - * CRUD - ([add](#/reference/request-queues/request-collection/add-request), - [get](#/reference/request-queues/request-collection/get-request), - [update](#/reference/request-queues/request-collection/update-request), - [delete](#/reference/request-queues/request-collection/delete-request)) - operations on requests in request queues - * Request lock operations - ([prolong](#/reference/request-queues/request-lock/prolong-request-lock), - [delete](#/reference/request-queues/request-lock/delete-request-lock)) - in request queues + * [Add request to request queue](/api/v2/request-queue-requests-post) + * [Get request from request queue](/api/v2/request-queue-request-get) + * [Update request in request queue](/api/v2/request-queue-request-put) + * [Delete request from request queue](/api/v2/request-queue-request-delete) + * [Prolong lock on request in request queue](/api/v2/request-queue-request-lock-put) + * [Delete lock on request in request queue](/api/v2/request-queue-request-lock-delete) These endpoints have a rate limit of _400 requests per second per resource_: - * [Run Actor](#/reference/actors/run-collection/run-actor) - * [Run Actor task asynchronously](#/reference/actor-tasks/runs-collection/run-task-asynchronously) - * [Run Actor task synchronously](#/reference/actor-tasks/runs-collection/run-task-synchronously) - * [Metamorph Actor run](#/reference/actors/metamorph-run/metamorph-run) - * [Push items](#/reference/datasets/item-collection/put-items) to dataset + * [Run Actor](/api/v2/actors-runs-post) + * [Run Actor task](/api/v2/actor-task-runs-post) + * [Run Actor task synchronously and get key-value store record](/api/v2/actor-task-run-sync-post) + * [Metamorph Actor run](/api/v2/actor-run-metamorph-post) + * [Store items in dataset](/api/v2/dataset-items-post) ### Rate limit exceeded errors 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 6ec46020ec..33169673d5 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,15 +5,15 @@ get: description: | Get the OpenAPI definition for Actor builds. Two similar endpoints are available: - - [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 OpenAPI definition of Actor build](/api/v2/actor-openapi-json-get) (`/v2/actors/{actorId}/builds/{buildId}/openapi.json`): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build. + - [Get OpenAPI definition of Actor build](/api/v2/actor-build-openapi-json-get) (`/v2/actor-builds/{buildId}/openapi.json`): Requires only `buildId`. Get the OpenAPI definition for a specific Actor build. Authentication is based on the build's unique ID. No authentication token is required. :::note - You can also use the [`/api/v2/actor-openapi-json-get`](/api/v2/actor-openapi-json-get) endpoint to get the OpenAPI definition for a build. + You can also use the [Get OpenAPI definition of Actor build](/api/v2/actor-openapi-json-get) endpoint (`/v2/actors/{actorId}/builds/{buildId}/openapi.json`) to get the OpenAPI definition for a build. ::: operationId: actorBuild_openapi_json_get diff --git a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml index 9fa1d7967e..b559346e0a 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml @@ -8,11 +8,11 @@ get: ##### Convenience endpoints for Actor run default storages - * [Dataset](/api/v2/default-dataset) + * [Default dataset](/api/v2/default-dataset) - * [Key-value store](/api/v2/default-key-value-store) + * [Default key-value store](/api/v2/default-key-value-store) - * [Request queue](/api/v2/default-request-queue) + * [Default request queue](/api/v2/default-request-queue) Gets an object that contains all the details about a specific run of an Actor. diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@input.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@input.yaml index 7493bc2a78..281782351c 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@input.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@input.yaml @@ -52,7 +52,7 @@ put: If the object does not define a specific property, its value is not updated. The response is the full task input as returned by the - [Get task input](#/reference/tasks/task-input-object/get-task-input) endpoint. + [Get Actor task input](/api/v2/actor-task-input-get) endpoint. The request needs to specify the `Content-Type: application/json` HTTP header! diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml index 11d109f38e..f3dca51be4 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml @@ -9,8 +9,7 @@ get: otherwise the HTTP request fails with a timeout error (this won't abort the run itself). - You can send all the same options in parameters as the [Get Dataset - Items](#/reference/datasets/item-collection/get-items) API endpoint. + You can send all the same options in parameters as the [Get dataset items](/api/v2/dataset-items-get) API endpoint. Beware that it might be impossible to maintain an idle HTTP connection for an extended period, due to client timeout or network conditions. Make sure your HTTP client is @@ -19,8 +18,7 @@ get: If the connection breaks, you will not receive any information about the run and its status. - To run the Task asynchronously, use the [Run task - asynchronously](#/reference/actor-tasks/run-collection/run-task) endpoint + To run the Task asynchronously, use the [Run Actor task](/api/v2/actor-task-runs-post) endpoint instead. operationId: actorTask_runSyncGetDatasetItems_get parameters: @@ -102,8 +100,7 @@ post: input property, the Actor run uses the default value defined by the task (or the Actor's input schema if not defined by the task). - You can send all the same options in parameters as the [Get Dataset - Items](#/reference/datasets/item-collection/get-items) API endpoint. + You can send all the same options in parameters as the [Get dataset items](/api/v2/dataset-items-get) API endpoint. Beware that it might be impossible to maintain an idle HTTP connection for an extended period, due to client timeout or network conditions. Make sure your HTTP client is @@ -118,8 +115,7 @@ post: Just make sure to specify the `Content-Type` header as `application/json` and that the input is an object. - To run the task asynchronously, use the [Run - task](#/reference/actor-tasks/run-collection/run-task) API endpoint instead. + To run the task asynchronously, use the [Run Actor task](/api/v2/actor-task-runs-post) API endpoint instead. operationId: actorTask_runSyncGetDatasetItems_post parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorTaskId" diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml index 1b59621378..094e28efa0 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml @@ -24,7 +24,7 @@ get: and its status. To run the Task asynchronously, use the - [Run task asynchronously](#/reference/actor-tasks/run-collection/run-task) + [Run Actor task](/api/v2/actor-task-runs-post) endpoint instead. operationId: actorTask_runSync_get parameters: @@ -103,8 +103,7 @@ post: Just make sure to specify `Content-Type` header to be `application/json` and input to be an object. - To run the task asynchronously, use the [Run - task](#/reference/actor-tasks/run-collection/run-task) API endpoint instead. + To run the task asynchronously, use the [Run Actor task](/api/v2/actor-task-runs-post) API endpoint instead. operationId: actorTask_runSync_post parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorTaskId" diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml index d6acf97118..f1a9533edb 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml @@ -76,18 +76,17 @@ post: input property, the Actor run uses the default value defined by the task (or Actor's input schema if not defined by the task). - The response is the Actor Run object as returned by the [Get - run](#/reference/actor-runs/run-object-and-its-storages/get-run) endpoint. + The response is the Actor Run object as returned by the [Get Actor run](/api/v2/actor-run-get) endpoint. If you want to wait for the run to finish and receive the actual output of - the Actor run as the response, use one of the [Run task - synchronously](#/reference/actor-tasks/run-task-synchronously) API endpoints - instead. + the Actor run as the response, use the [Run Actor task synchronously and get key-value store record](/api/v2/actor-task-run-sync-post) + or [Run Actor task synchronously and get dataset items](/api/v2/actor-task-run-sync-get-dataset-items-post) + endpoint instead. To fetch the Actor run results that are typically stored in the default dataset, you'll need to pass the ID received in the `defaultDatasetId` field received in the response JSON to the - [Get dataset items](#/reference/datasets/item-collection/get-items) API endpoint. + [Get dataset items](/api/v2/dataset-items-get) API endpoint. operationId: actorTask_runs_post parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorTaskId" diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last.yaml index 0c85b8e4f6..f626b430b5 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last.yaml @@ -14,17 +14,17 @@ get: Using the `status` query parameter you can ensure to only get a run with a certain status (e.g. `status=SUCCEEDED`). Similarly, the `origin` query parameter filters runs by the means by which they were started (e.g. `origin=API`). The output of this endpoint and other query - parameters are the same as in the [Run object](/api/v2/actor-run-get) endpoint. + parameters are the same as in the [Get Actor run](/api/v2/actor-run-get) endpoint. ##### Convenience endpoints for last Actor task run - * [Dataset](/api/v2/last-actor-task-runs-default-dataset) + * [Last Actor task run's default dataset](/api/v2/last-actor-task-runs-default-dataset) - * [Key-value store](/api/v2/last-actor-task-runs-default-key-value-store) + * [Last Actor task run's default key-value store](/api/v2/last-actor-task-runs-default-key-value-store) - * [Request queue](/api/v2/last-actor-task-runs-default-request-queue) + * [Last Actor task run's default request queue](/api/v2/last-actor-task-runs-default-request-queue) - * [Log](/api/v2/last-actor-task-runs-log) + * [Last Actor task run's log](/api/v2/last-actor-task-runs-log) operationId: actorTask_runs_last_get parameters: diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml index 817492b6a6..ccbb18b19a 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: description: | Builds an Actor. The response is the build object as returned by the - [Get build](#/reference/actors/build-object/get-build) endpoint. + [Get Actor build](/api/v2/actor-build-get) endpoint. operationId: actors_builds_post 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 9c4c19492d..e4224d60ec 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,9 +5,9 @@ get: description: | Get the OpenAPI definition for Actor builds. Two similar endpoints are available: - - [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. + - [Get OpenAPI definition of Actor build](/api/v2/actor-openapi-json-get) (`/v2/actors/{actorId}/builds/{buildId}/openapi.json`): 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 OpenAPI definition of Actor build](/api/v2/actor-build-openapi-json-get) (`/v2/actor-builds/{buildId}/openapi.json`): Requires only `buildId`. Get the OpenAPI definition for a specific Actor build. @@ -16,7 +16,7 @@ get: :::note - 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. + You can also use the [Get OpenAPI definition of Actor build](/api/v2/actor-build-openapi-json-get) endpoint (`/v2/actor-builds/{buildId}/openapi.json`) to get the OpenAPI definition for a build. ::: operationId: actor_openapi_json_get 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 4ab972f410..99247365ca 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 @@ -10,8 +10,7 @@ post: The HTTP response contains the Actors dataset items, while the format of items depends on specifying dataset items' `format` parameter. - You can send all the same options in parameters as the [Get Dataset - Items](#/reference/datasets/item-collection/get-items) API endpoint. + You can send all the same options in parameters as the [Get dataset items](/api/v2/dataset-items-get) API endpoint. The Actor is started with the default options; you can override them using URL query parameters. @@ -25,8 +24,7 @@ post: If the connection breaks, you will not receive any information about the run and its status. - To run the Actor asynchronously, use the [Run - Actor](#/reference/actors/run-collection/run-actor) API endpoint instead. + To run the Actor asynchronously, use the [Run Actor](/api/v2/actors-runs-post) API endpoint instead. operationId: actor_runSyncGetDatasetItems_post parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" @@ -114,8 +112,7 @@ get: otherwise the API endpoint returns a timeout error. The Actor is not passed any input. - It allows to send all possible options in parameters from [Get Dataset - Items](#/reference/datasets/item-collection/get-items) API endpoint. + It allows to send all possible options in parameters from [Get dataset items](/api/v2/dataset-items-get) API endpoint. Beware that it might be impossible to maintain an idle HTTP connection for a long period of time, @@ -124,8 +121,7 @@ get: If the connection breaks, you will not receive any information about the run and its status. - To run the Actor asynchronously, use the [Run - Actor](#/reference/actors/run-collection/run-actor) API endpoint instead. + To run the Actor asynchronously, use the [Run Actor](/api/v2/actors-runs-post) API endpoint instead. operationId: actor_runSyncGetDatasetItems_get parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" 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 069fe093b6..787e3c103c 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml @@ -26,8 +26,7 @@ post: If the connection breaks, you will not receive any information about the run and its status. - To run the Actor asynchronously, use the [Run - Actor](#/reference/actors/run-collection/run-actor) API endpoint instead. + To run the Actor asynchronously, use the [Run Actor](/api/v2/actors-runs-post) API endpoint instead. operationId: actor_runSync_post parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" @@ -103,8 +102,7 @@ get: If the connection breaks, you will not receive any information about the run and its status. - To run the Actor asynchronously, use the [Run - Actor](#/reference/actors/run-collection/run-actor) API endpoint instead. + To run the Actor asynchronously, use the [Run Actor](/api/v2/actors-runs-post) API endpoint instead. operationId: actor_runSync_get parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml index 14ca21d752..731aee9498 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml @@ -71,18 +71,17 @@ post: The Actor is started with the default options; you can override them using various URL query parameters. - The response is the Run object as returned by the [Get - run](#/reference/actor-runs/run-object-and-its-storages/get-run) API + The response is the Run object as returned by the [Get Actor run](/api/v2/actor-run-get) API endpoint. If you want to wait for the run to finish and receive the actual output of - the Actor as the response, please use one of the [Run Actor - synchronously](#/reference/actors/run-actor-synchronously) API endpoints - instead. + the Actor as the response, please use the [Run Actor synchronously and get key-value store record](/api/v2/actor-run-sync-post) + or [Run Actor synchronously and get dataset items](/api/v2/actor-run-sync-get-dataset-items-post) + endpoint instead. To fetch the Actor run results that are typically stored in the default dataset, you'll need to pass the ID received in the `defaultDatasetId` field - received in the response JSON to the [Get dataset items](#/reference/datasets/item-collection/get-items) + received in the response JSON to the [Get dataset items](/api/v2/dataset-items-get) API endpoint. operationId: actors_runs_post parameters: 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 ed9e67d6b7..a5ba29174f 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml @@ -14,17 +14,17 @@ get: Using the `status` query parameter you can ensure to only get a run with a certain status (e.g. `status=SUCCEEDED`). Similarly, the `origin` query parameter filters runs by the means by which they were started (e.g. `origin=API`). The output of this endpoint and other query - parameters are the same as in the [Run object](#/reference/actors/run-object) endpoint. + parameters are the same as in the [Get Actor run](/api/v2/actor-run-get) endpoint. ##### Convenience endpoints for last Actor run - * [Dataset](/api/v2/last-actor-runs-default-dataset) + * [Last Actor run's default dataset](/api/v2/last-actor-runs-default-dataset) - * [Key-value store](/api/v2/last-actor-runs-default-key-value-store) + * [Last Actor run's default key-value store](/api/v2/last-actor-runs-default-key-value-store) - * [Request queue](/api/v2/last-actor-runs-default-request-queue) + * [Last Actor run's default request queue](/api/v2/last-actor-runs-default-request-queue) - * [Log](/api/v2/last-actor-runs-log) + * [Last Actor run's log](/api/v2/last-actor-runs-log) operationId: actor_runs_last_get parameters: diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml index f102dade01..255290e3ee 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml @@ -98,7 +98,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. + returned by the [Get Actor version](/api/v2/actor-version-get) endpoint. operationId: actor_versions_post parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" 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 1b3092d544..f036ac0e74 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 @@ -57,8 +57,7 @@ post: ``` 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) + object](#/reference/actors/environment-variable-object) as returned by the [Get environment variable of Actor version](/api/v2/actor-version-env-var-get) endpoint. operationId: actor_version_envVars_post parameters: diff --git a/apify-api/openapi/paths/schedules/schedules@{scheduleId}.yaml b/apify-api/openapi/paths/schedules/schedules@{scheduleId}.yaml index 56867395b0..2d6b3a3f6a 100644 --- a/apify-api/openapi/paths/schedules/schedules@{scheduleId}.yaml +++ b/apify-api/openapi/paths/schedules/schedules@{scheduleId}.yaml @@ -47,7 +47,7 @@ put: its value will not be updated. The response is the full schedule object as returned by the - [Get schedule](#/reference/schedules/schedule-object/get-schedule) endpoint. + [Get schedule](/api/v2/schedule-get) endpoint. **The request needs to specify the `Content-Type: application/json` HTTP header!** diff --git a/apify-api/openapi/paths/store/store.yaml b/apify-api/openapi/paths/store/store.yaml index 27f8440c02..08af2b4402 100644 --- a/apify-api/openapi/paths/store/store.yaml +++ b/apify-api/openapi/paths/store/store.yaml @@ -6,8 +6,7 @@ get: Gets the list of public Actors in Apify Store. You can use `search` parameter to search Actors by string in title, name, description, username and readme. - If you need detailed info about a specific Actor, use the [Get - Actor](#/reference/actors/actor-object/get-actor) endpoint. + If you need detailed info about a specific Actor, use the [Get Actor](/api/v2/actor-get) endpoint. The endpoint supports pagination using the `limit` and `offset` parameters. It will not return more than 1,000 records. diff --git a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml index 5360a48120..118599995c 100644 --- a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml +++ b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml @@ -48,7 +48,7 @@ put: updated. The response is the full webhook object as returned by the - [Get webhook](#/reference/webhooks/webhook-object/get-webhook) endpoint. + [Get webhook](/api/v2/webhook-get) endpoint. The request needs to specify the `Content-Type: application/json` HTTP header! diff --git a/sources/academy/build-and-publish/how-to-build/running_a_web_server.md b/sources/academy/build-and-publish/how-to-build/running_a_web_server.md index b1ff2264a1..d05f3d20cc 100644 --- a/sources/academy/build-and-publish/how-to-build/running_a_web_server.md +++ b/sources/academy/build-and-publish/how-to-build/running_a_web_server.md @@ -15,7 +15,7 @@ Sometimes, an Actor needs a channel for communication with other systems (or hum - An API to receive commands. - An HTML page displaying output data. -Running a web server in an Actor is a piece of cake! Each Actor run is available at a unique URL (container URL) which always takes the form `https://CONTAINER-KEY.runs.apify.net`. This URL is available in the [**Actor run** object](/api/v2/actor-run-get) returned by the Apify API, as well as in the Apify console. +Running a web server in an Actor is a piece of cake! Each Actor run is available at a unique URL (container URL) which always takes the form `https://CONTAINER-KEY.runs.apify.net`. This URL is available in the **Actor run** object returned by the [Get Actor run](/api/v2/actor-run-get) endpoint, as well as in the Apify console. If you start a web server on the port defined by the **APIFY_CONTAINER_PORT** environment variable (the default value is **4321**), the container URL becomes available and gets displayed in the **Live View** tab in the Actor run console. diff --git a/sources/academy/platform/getting_started/apify_api.md b/sources/academy/platform/getting_started/apify_api.md index 2eb659801d..e5b9ce1411 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/actor-run-sync-get-dataset-items-post) +Additional parameters can be passed to this endpoint. You can learn about them in the [Run Actor synchronously and get dataset items](/api/v2/actor-run-sync-get-dataset-items-post) API reference :::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/actor-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 with the [Update Actor](/api/v2/actor-put) endpoint, 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 fad2d17fab..bbf4e6c713 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/actor-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](/api/v2/actor-put) endpoint, which can take `defaultRunOptions` as an input property. You can find the shape of the `defaultRunOptions` in that endpoint's API reference. 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 104749a72f..87f0cf29d2 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 @@ -27,7 +27,7 @@ If the Actor being run via API takes 5 minutes or less to complete a typical run > If you are unsure about the differences between an Actor and a task, you can read about them in the [tasks](/actors/running/tasks) documentation. In brief, tasks are pre-configured inputs for Actors. -The API endpoints and usage (for both sync and async) for [Actors](/api/v2/actors-runs-post) and [tasks](/api/v2/actor-task-runs-post) are essentially the same. +The API endpoints and usage (for both sync and async) for Actors ([Run Actor](/api/v2/actors-runs-post)) and tasks ([Run Actor task](/api/v2/actor-task-runs-post)) are essentially the same. To run, or **call**, an Actor/task, you will need a few things: @@ -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 Actor run**](/api/v2/actor-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 Actor 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](/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. +Most Actor runs will store their data in the default [dataset](/storage/dataset). The Apify API provides **run-sync-get-dataset-items** endpoints for Actors ([Run Actor synchronously and get dataset items](/api/v2/actor-run-sync-get-dataset-items-post)) and tasks ([Run Actor task synchronously and get dataset items](/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](/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. +[Key-value stores](/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 ([Run Actor synchronously and get key-value store record](/api/v2/actor-run-sync-post)) and tasks ([Run Actor task synchronously and get key-value store record](/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} @@ -212,7 +212,7 @@ This solution is quite similar to the synchronous flow. To make the POST request https://api.apify.com/v2/actors/apify~web-scraper/runs?token=YOUR_TOKEN&waitForFinish=60 ``` -You can also use the `waitForFinish` parameter with the [**GET Run** endpoint](/api/v2/actor-run-get) to implement a smarter [polling](#polling) system. +You can also use the `waitForFinish` parameter with the [Get Actor run](/api/v2/actor-run-get) endpoint to implement a smarter [polling](#polling) system. Once again, the final response will be the **run info object**; however, now its status should be `SUCCEEDED` or `FAILED`. If the run exceeds the `waitForFinish` duration, the status will still be `RUNNING`. @@ -234,7 +234,7 @@ Once your server receives this request from the webhook, you know that the event What if you don't have a server, and the run you'd like to do is much too long to use a synchronous call? In cases like these, periodic **polling** of the run's status is the solution. -When we run the Actor with the [usual API call](#run-an-actor-or-task) shown above, we will back a response with the **run info** object. From this JSON object, we can then extract the ID of the Actor run that we just started from the `id` field. Then, we can set an interval that will poll the Apify API (let's say every 5 seconds) by calling the [**Get Actor run**](/api/v2/actor-run-get) endpoint to retrieve the run's status. +When we run the Actor with the [usual API call](#run-an-actor-or-task) shown above, we will back a response with the **run info** object. From this JSON object, we can then extract the ID of the Actor run that we just started from the `id` field. Then, we can set an interval that will poll the Apify API (let's say every 5 seconds) by calling the [Get Actor run](/api/v2/actor-run-get) endpoint to retrieve the run's status. Replace the `RUN_ID` in the following URL with the ID you extracted earlier: @@ -254,7 +254,7 @@ The **run info** JSON also contains the IDs of the default [dataset](/storage/da > If you are scraping products, or any list of items with similar fields, the [dataset](/storage/dataset) should be your storage of choice. Don't forget though, that dataset items are immutable. This means that you can only add to the dataset, and not change the content that is already inside it. -To retrieve the data from a dataset, send a GET request to the [**Get dataset items**](/api/v2/dataset-items-get) endpoint and pass the `defaultDatasetId` into the URL. For a GET request to the default dataset, no token is needed. +To retrieve the data from a dataset, send a GET request to the [Get dataset items](/api/v2/dataset-items-get) endpoint and pass the `defaultDatasetId` into the URL. For a GET request to the default dataset, no token is needed. ```cURL https://api.apify.com/v2/datasets/DATASET_ID/items @@ -262,7 +262,7 @@ https://api.apify.com/v2/datasets/DATASET_ID/items By default, it will return the data in JSON format with some metadata. The actual data are in the `items` array. -You can use plenty of additional parameters, to learn more about them, visit our API reference [documentation](/api/v2/dataset-items-get). We will only mention that you can pass a `format` parameter that transforms the response into popular formats like CSV, XML, Excel, RSS, etc. +You can use plenty of additional parameters, to learn more about them, visit the [Get dataset items](/api/v2/dataset-items-get) API reference. We will only mention that you can pass a `format` parameter that transforms the response into popular formats like CSV, XML, Excel, RSS, etc. The items are paginated, which means you can ask only for a subset of the data. Specify this using the `limit` and `offset` parameters. This endpoint has a limit of 250,000 items that it can return per request. To retrieve more, you will need to send more requests incrementing the `offset` parameter. @@ -276,13 +276,13 @@ https://api.apify.com/v2/datasets/DATASET_ID/items?format=csv&offset=250000 When you want to retrieve something from a key-value store, the `defaultKeyValueStoreId` is _not_ enough. You also need to know the name (or **key**) of the record you want to retrieve. -If you have a single output JSON, the convention is to return it as a record named `OUTPUT` to the default key-value store. To retrieve the record's content, call the [**Get key-value store record**](/api/v2/key-value-store-record-get) endpoint. +If you have a single output JSON, the convention is to return it as a record named `OUTPUT` to the default key-value store. To retrieve the record's content, call the [Get key-value store record](/api/v2/key-value-store-record-get) endpoint. ```cURL https://api.apify.com/v2/key-value-stores/STORE_ID/records/RECORD_KEY ``` -If you don't know the keys (names) of the records in advance, you can retrieve just the keys with the [**List keys**](/api/v2/key-value-store-keys-get) endpoint. +If you don't know the keys (names) of the records in advance, you can retrieve just the keys with the [Get list of key-value store keys](/api/v2/key-value-store-keys-get) endpoint. Keep in mind that you can get a maximum of 1000 keys per request, so you will need to paginate over the keys using the `exclusiveStartKey` parameter if you have more than 1000 keys. To do this, after each call, take the last record key and provide it as the `exclusiveStartKey` parameter. You can do this until you get 0 keys back. diff --git a/sources/academy/tutorials/api/using_apify_from_php.md b/sources/academy/tutorials/api/using_apify_from_php.md index 4799b4a26c..e0838ff30c 100644 --- a/sources/academy/tutorials/api/using_apify_from_php.md +++ b/sources/academy/tutorials/api/using_apify_from_php.md @@ -32,7 +32,7 @@ $client = new \GuzzleHttp\Client([ Note that we pass the API token in the header. It can also be passed as a query string `token` parameter, but passing it in the header is preferred and more secure. -To check whether everything works well, we'll try to get information about the [current user](/api/v2/users-me-get). +To check whether everything works well, we'll try to get information about the current user with the [Get private user data](/api/v2/users-me-get) endpoint. ```php // Call the endpoint using our client @@ -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/actors-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 [Run Actor](/api/v2/actors-runs-post) API reference 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 @@ -83,7 +83,7 @@ You should see information about the run, including its ID and the ID of its def ## Getting the results from dataset -An Actor usually stores its results in a default dataset created separately for each run. The [Actor runs endpoint](/api/v2/actor-runs) lets you get overall info about an Actor run's default dataset. +An Actor usually stores its results in a default dataset created separately for each run. The [Manage Actor runs](/api/v2/actor-runs) endpoints let you get overall info about an Actor run's default dataset. ```php // Replace with the run ID you from earlier @@ -121,7 +121,7 @@ $parsedResponse = \json_decode($response->getBody(), true); echo \json_encode($parsedResponse, JSON_PRETTY_PRINT); ``` -All the available parameters are described in [our API reference](/api/v2/dataset-items-get) and work both for all datasets. +All the available parameters are described in the [Get dataset items](/api/v2/dataset-items-get) API reference and work both for all datasets. ## Getting the results from key-value stores diff --git a/sources/academy/tutorials/node_js/apify_free_google_serp_api.md b/sources/academy/tutorials/node_js/apify_free_google_serp_api.md index 2888b054bf..9080888cd6 100644 --- a/sources/academy/tutorials/node_js/apify_free_google_serp_api.md +++ b/sources/academy/tutorials/node_js/apify_free_google_serp_api.md @@ -12,6 +12,6 @@ You need to regularly grab SERP data about your target keywords? Apify provides Hit `Save & Run` and you'll have the downloaded data as soon as the query finishes. To have it run at a regular frequency, you can set up the task to run on an [automatic schedule](/actors/running/schedules#setting-up-a-new-schedule). -To run from the API, send a [synchronous POST request](/api/v2/actor-task-run-sync-get-dataset-items-post) to an endpoint such as `https://api.apify.com/v2/actors/TASK_NAME_OR_ID/runs?token=YOUR_TOKEN`. Include any required input in a JSON object in the request's body. +To run from the API, send a `POST` request to the [Run Actor task synchronously and get dataset items](/api/v2/actor-task-run-sync-get-dataset-items-post) endpoint, such as `https://api.apify.com/v2/actor-tasks/TASK_NAME_OR_ID/run-sync-get-dataset-items?token=YOUR_TOKEN`. Include any required input in a JSON object in the request's body. Keep in mind that, as Google search uses a non-deterministic algorithm, output results may vary even if the input settings are exactly the same. diff --git a/sources/platform/account/collaboration/general-resource-access.md b/sources/platform/account/collaboration/general-resource-access.md index a08b536854..2218242d75 100644 --- a/sources/platform/account/collaboration/general-resource-access.md +++ b/sources/platform/account/collaboration/general-resource-access.md @@ -141,9 +141,9 @@ This allows fine-grained control over what data can be shared without authentica | Resource | Link | Validity | Notes | | ----------- | ----------------------- | ------ | ------- | -| _Datasets_ | [Dataset items](/api/v2/dataset-items-get) (`/v2/datasets/:datasetId/items`) | Temporary or Permanent | The link provides access to all dataset items. | -| _Key-value stores_ | [List of keys](/api/v2/key-value-store-keys-get) (`/v2/key-value-stores/:storeId/keys`) | Temporary or Permanent | Returns the list of keys in a store. | -| _Key-value stores_ | [Single record](/api/v2/key-value-store-record-get) (`/v2/key-value-stores/:storeId/records/:recordKey`) | _Permanent only_ | The public URL for a specific record is always permanent - it stays valid as long as the record exists. | +| _Datasets_ | [Get dataset items](/api/v2/dataset-items-get) (`/v2/datasets/:datasetId/items`) | Temporary or Permanent | The link provides access to all dataset items. | +| _Key-value stores_ | [Get list of key-value store keys](/api/v2/key-value-store-keys-get) (`/v2/key-value-stores/:storeId/keys`) | Temporary or Permanent | Returns the list of keys in a store. | +| _Key-value stores_ | [Get key-value store record](/api/v2/key-value-store-record-get) (`/v2/key-value-stores/:storeId/records/:recordKey`) | _Permanent only_ | The public URL for a specific record is always permanent - it stays valid as long as the record exists. | :::info Automatically generated signed URLs diff --git a/sources/platform/actors/development/builds_and_runs/runs.md b/sources/platform/actors/development/builds_and_runs/runs.md index 1415181ad2..9bae00b391 100644 --- a/sources/platform/actors/development/builds_and_runs/runs.md +++ b/sources/platform/actors/development/builds_and_runs/runs.md @@ -13,7 +13,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/actors-runs-post) +- Via the Apify API, using the [Run Actor](/api/v2/actors-runs-post) endpoint - Using the [Scheduler](/actors/running/schedules) provided by the Apify platform - By one of the available [integrations](../../../integrations/index.mdx) diff --git a/sources/platform/actors/development/programming_interface/container_web_server.md b/sources/platform/actors/development/programming_interface/container_web_server.md index e33fc7244a..395f5bfd1c 100644 --- a/sources/platform/actors/development/programming_interface/container_web_server.md +++ b/sources/platform/actors/development/programming_interface/container_web_server.md @@ -24,7 +24,7 @@ The container web server provides a way how to connect to one specific Actor run You can find the container URL in three locations: - In the web application, on the Actor run details page as the **Container URL** field. -- In the API as the `containerUrl` property of the [Run object](/api/v2/actor-run-get). +- In the API as the `containerUrl` property of the Run object returned by the [Get Actor run](/api/v2/actor-run-get) endpoint. - In the Actor run's container as the `ACTOR_WEB_SERVER_URL` environment variable. ## Set up the web server diff --git a/sources/platform/actors/publishing/publish-task.mdx b/sources/platform/actors/publishing/publish-task.mdx index a91010c8d7..b8177ebcb3 100644 --- a/sources/platform/actors/publishing/publish-task.mdx +++ b/sources/platform/actors/publishing/publish-task.mdx @@ -175,7 +175,7 @@ The requirements above still apply. The agent fills in the display configuration ### Publish with the API -Create the task with [Create task API endpoint](/api/v2/actor-tasks-post), then configure and publish it with [Update task API endpoint](/api/v2/actor-task-put): +Create the task with the [Create Actor task](/api/v2/actor-tasks-post) endpoint, then configure and publish it with the [Update Actor task](/api/v2/actor-task-put) endpoint: ```http PUT /v2/actor-tasks/{actorTaskId} diff --git a/sources/platform/actors/running/runs_and_builds.md b/sources/platform/actors/running/runs_and_builds.md index eef55543ee..ac3ecb8aa6 100644 --- a/sources/platform/actors/running/runs_and_builds.md +++ b/sources/platform/actors/running/runs_and_builds.md @@ -33,7 +33,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/actor-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 [Update Actor](/api/v2/actor-put) API endpoint. ## Runs @@ -57,7 +57,7 @@ To view what's happening while the Actor is running: ### Origin -Both **Actor runs** and **builds** have the **Origin** field indicating how the Actor run or build was invoked, respectively. The origin is displayed in Apify Console and available via [API](https://docs.apify.com/api/v2/actor-run-get) in the `meta.origin` field. +Both **Actor runs** and **builds** have the **Origin** field indicating how the Actor run or build was invoked, respectively. The origin is displayed in Apify Console and available via the [Get Actor run](/api/v2/actor-run-get) endpoint in the `meta.origin` field. |Name|Origin| |:---|:---| diff --git a/sources/platform/actors/running/schedules.md b/sources/platform/actors/running/schedules.md index 8664891787..544d760b64 100644 --- a/sources/platform/actors/running/schedules.md +++ b/sources/platform/actors/running/schedules.md @@ -70,7 +70,7 @@ For integrations, you can also add a [webhook](/integrations/webhooks) to your t ### Apify API -To create a new [schedule](/api/v2/schedules) using the Apify API, send a `POST` request to the [create schedule](/api/v2/schedules-post) endpoint. +To create a new [schedule](/api/v2/schedules) using the Apify API, send a `POST` request to the [Create schedule](/api/v2/schedules-post) endpoint. You can find your [secret API token](/integrations) under the [API & Integrations](https://console.apify.com/settings/integrations) tab of your Apify account settings. @@ -107,7 +107,7 @@ If the request is successful, you will receive a `201` [HTTP response code](http You can add multiple Actor and task runs to a schedule with a single `POST` request. Simply add another object with the run's details to the **actions** array in your `POST` request's payload object. -For more information, refer to the [schedules](/api/v2/schedule-get) section in the API documentation. +For more information, refer to the [Manage schedules](/api/v2/schedules) section in the API documentation. ## Schedule setup diff --git a/sources/platform/actors/running/tasks.md b/sources/platform/actors/running/tasks.md index a4b2752b88..650047522d 100644 --- a/sources/platform/actors/running/tasks.md +++ b/sources/platform/actors/running/tasks.md @@ -6,7 +6,7 @@ slug: /actors/running/tasks sidebar_label: Tasks --- -Actor tasks let you create multiple reusable configurations of a single Actor, adapted for specific use cases. For example, you can create one [_Web Scraper_](https://apify.com/apify/web-scraper) configuration (task) that scrapes the latest reviews from [IMDb](https://www.imdb.com/), another that scrapes nike.com for the latest sneakers, and a third that scrapes your competitor's e-shop. You can then use and reuse these configurations directly from [Apify Console](https://console.apify.com/actors/tasks), [Schedules](/actors/running/schedules), or [API](/api/v2/actor-task-runs-post). +Actor tasks let you create multiple reusable configurations of a single Actor, adapted for specific use cases. For example, you can create one [_Web Scraper_](https://apify.com/apify/web-scraper) configuration (task) that scrapes the latest reviews from [IMDb](https://www.imdb.com/), another that scrapes nike.com for the latest sneakers, and a third that scrapes your competitor's e-shop. You can then use and reuse these configurations directly from [Apify Console](https://console.apify.com/actors/tasks), [Schedules](/actors/running/schedules), or the API, using the [Run Actor task](/api/v2/actor-task-runs-post) endpoint. You can find all your tasks in the [Apify Console](https://console.apify.com/actors/tasks). @@ -43,7 +43,7 @@ Or using the **Start** button positioned following the input configuration. You can also run tasks using: - [Schedules](/actors/running/schedules). -- Directly via the [Apify API](/api/v2/actor-task-runs-post). +- Directly via the Apify API, using the [Run Actor task](/api/v2/actor-task-runs-post) endpoint. - The [JavaScript API client](/api/client/js/reference/class/TaskClient). - The [Python API client](/api/client/python/reference/class/TaskClient). diff --git a/sources/platform/get-started/agent-onboarding.md b/sources/platform/get-started/agent-onboarding.md index 5b7be22443..9c457106f8 100644 --- a/sources/platform/get-started/agent-onboarding.md +++ b/sources/platform/get-started/agent-onboarding.md @@ -90,7 +90,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/actors-runs-post): +When an agent calls Actors automatically, set run limits to prevent surprise bills. Pass these as query parameters on the [Run Actor](/api/v2/actors-runs-post) endpoint: - `maxTotalChargeUsd` - cap the total amount charged for the run. Works for all pricing models. - `maxItems` - cap how many results you pay for on an Actor priced per result. @@ -237,14 +237,14 @@ 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/actor-get) | `GET` | `/v2/actors/{actorId}` | -| [Run an Actor](/api/v2/actors-runs-post) | `POST` | `/v2/actors/{actorId}/runs` | -| [Run Actor (sync, get results)](/api/v2/actor-run-sync-get-dataset-items-post) | `POST` | `/v2/actors/{actorId}/run-sync-get-dataset-items` | -| [Get run status](/api/v2/actor-run-get) | `GET` | `/v2/actor-runs/{runId}` | +| [Get list of Actors in Store](/api/v2/store-get) | `GET` | `/v2/store` | +| [Get Actor](/api/v2/actor-get) | `GET` | `/v2/actors/{actorId}` | +| [Run Actor](/api/v2/actors-runs-post) | `POST` | `/v2/actors/{actorId}/runs` | +| [Run Actor synchronously and get dataset items](/api/v2/actor-run-sync-get-dataset-items-post) | `POST` | `/v2/actors/{actorId}/run-sync-get-dataset-items` | +| [Get Actor run](/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/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/actors-runs-post) for longer runs. +The [Run Actor synchronously and get dataset items](/api/v2/actor-run-sync-get-dataset-items-post) endpoint runs an Actor and returns results in a single request (waits up to 5 minutes). Use the asynchronous [Run Actor](/api/v2/actors-runs-post) endpoint for longer runs. For runs that take longer than the sync timeout, prefer [webhooks](/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/actors/index.md b/sources/platform/integrations/actors/index.md index ad3903e2f6..2e1fd29146 100644 --- a/sources/platform/integrations/actors/index.md +++ b/sources/platform/integrations/actors/index.md @@ -30,7 +30,7 @@ On the setup screen, configure: - **Start when** - Events that trigger the integrated Actor. These match webhook [event types](/integrations/webhooks/events) (`run succeeded`, `build failed`, and so on). - **Actor input** - The input usually has two parts: static fields whose value doesn't change between runs (for example, a database connection string or table name) and dynamic fields specific to the triggering run (for example, a dataset ID). Static fields go in as-is. Dynamic fields are pulled from the implicit `payload` field (the default for most integration-ready Actors) or set with variables. The **Available variables** button in the input panel lists the variables you can interpolate. -- **Available variables** - The same variables as in webhooks. The most common is `{{resource}}`, which holds the Run object in the shape returned by the [API](/api/v2/actor-run-get), or the Build object for build event types. Variables support dot notation, `{{resource.defaultDatasetId}}` and `{{resource.defaultKeyValueStoreId}}` cover most cases. +- **Available variables** - The same variables as in webhooks. The most common is `{{resource}}`, which holds the Run object in the shape returned by the [Get Actor run](/api/v2/actor-run-get) endpoint, or the Build object for build event types. Variables support dot notation, `{{resource.defaultDatasetId}}` and `{{resource.defaultKeyValueStoreId}}` cover most cases. Integration setup screen diff --git a/sources/platform/integrations/ai/skyfire.md b/sources/platform/integrations/ai/skyfire.md index f2a6b4f687..af39544292 100644 --- a/sources/platform/integrations/ai/skyfire.md +++ b/sources/platform/integrations/ai/skyfire.md @@ -172,7 +172,7 @@ Once you send the `skyfire-pay-id` header, the protocol is inferred from it, so ### Run an Actor -Make a standard Actor run request to the [run Actor endpoint](https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor), but include the Skyfire PAY token in the header. +Make a standard Actor run request to the [Run Actor](/api/v2/actors-runs-post) endpoint, but include the Skyfire PAY token in the header. ```bash title="Example of using the synchronous run endpoint" curl -X POST \ @@ -186,13 +186,13 @@ curl -X POST \ }' ``` -You can also use the asynchronous [run Actor endpoint](https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor) if you don't need to wait for results immediately. +You can also use the asynchronous [Run Actor](/api/v2/actors-runs-post) endpoint if you don't need to wait for results immediately. ### Access the run and its storages -To access a run and its storages, reuse the same `skyfire-pay-id` header as authentication. As long as you send the token that paid for the run, you can call the [run](https://docs.apify.com/api/v2#/reference/actor-runs/run-object-and-its-storages/get-run), [dataset](https://docs.apify.com/api/v2#/reference/datasets), and [key-value store](https://docs.apify.com/api/v2#/reference/key-value-stores) endpoints for that run and its default storages. +To access a run and its storages, reuse the same `skyfire-pay-id` header as authentication. As long as you send the token that paid for the run, you can call the [Get Actor run](/api/v2/actor-run-get) endpoint and the [Datasets](/api/v2/storage-datasets) and [Key-value stores](/api/v2/storage-key-value-stores) endpoints for that run and its default storages. -This is useful when you start a run asynchronously with the [Run Actor](https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor) endpoint and then poll its status or fetch results separately. +This is useful when you start a run asynchronously with the [Run Actor](/api/v2/actors-runs-post) endpoint and then poll its status or fetch results separately. ```bash # Get run status - authenticate with the same Skyfire PAY token @@ -212,7 +212,7 @@ Not all Actors in Apify Store are eligible. -Apify maintains a curated list of Actors approved for agentic payments. To check if an Actor supports agentic payments, use the `allowsAgenticUsers=true` query parameter when [searching the store via API](https://docs.apify.com/api/v2#/reference/store/store-actors-collection/get-list-of-actors-in-store). +Apify maintains a curated list of Actors approved for agentic payments. To check if an Actor supports agentic payments, use the `allowsAgenticUsers=true` query parameter when searching the store with the [Get list of Actors in Store](/api/v2/store-get) endpoint. ```text https://api.apify.com/v2/store?allowsAgenticUsers=true diff --git a/sources/platform/integrations/ai/x402.md b/sources/platform/integrations/ai/x402.md index b19f1e3260..38dd8c8565 100644 --- a/sources/platform/integrations/ai/x402.md +++ b/sources/platform/integrations/ai/x402.md @@ -123,7 +123,7 @@ To review what an Actor does and which input it accepts, fetch its Markdown docu ### Access the run and its storages -The prepaid token authenticates every call that draws from its balance. You can start a run asynchronously with the [Run Actor](https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor) endpoint and then poll its status or fetch results separately, instead of using `run-sync-get-dataset-items`. +The prepaid token authenticates every call that draws from its balance. You can start a run asynchronously with the [Run Actor](/api/v2/actors-runs-post) endpoint and then poll its status or fetch results separately, instead of using `run-sync-get-dataset-items`. ```bash # Get run status diff --git a/sources/platform/integrations/integrate-with-apify.md b/sources/platform/integrations/integrate-with-apify.md index 06631862a9..87608de40f 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/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). +- Select Actor: The Actor list will be pre-populated with Actors that the user created or used, using the [Get list of Actors](https://docs.apify.com/api/v2/actors-get) endpoint and enriched with Actors from the store, which the user has not run already using the [Get list of Actors in Store](https://docs.apify.com/api/v2/store-get) endpoint. - 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/actors/running/runs-and-builds), [memory](https://docs.apify.com/actors/running/usage-and-resources#memory), and [timeout](https://docs.apify.com/actors/running/usage-and-resources#memory). @@ -86,7 +86,7 @@ Starts a predefined task (a saved Actor configuration), making it easy for users Recommended features: -- _Select task_: The task list will be pre-populated with tasks that the user created, using the [List of tasks](https://docs.apify.com/api/v2/actor-tasks-get) API. +- _Select task_: The task list will be pre-populated with tasks that the user created, using the [Get list of Actor tasks](https://docs.apify.com/api/v2/actor-tasks-get) endpoint. - _Synchronous vs. asynchronous run_: the flow will wait until the run/task finishes (considering timeout on your platform side) - _JSON input field_: possibility to add a JSON input to override the task input. @@ -96,7 +96,7 @@ Fetches structured results (JSON, CSV, etc.) generated by a previously run Actor Recommended features: -- _Dataset_: Dropdown (user's datasets) or ID/String input. Populated via [Datasets API](https://docs.apify.com/api/v2/datasets-get). +- _Dataset_: Dropdown (user's datasets) or ID/String input. Populated via the [Get list of datasets](https://docs.apify.com/api/v2/datasets-get) endpoint. - _Limit (optional)_: The maximum number of dataset items to fetch. If empty, the default limit will be used. - _Offset (optional)_: The offset in the dataset from where to start fetching the items. If empty, it will be from the beginning. @@ -106,7 +106,7 @@ Retrieves a specific item from a key-value store, commonly used to access metada Recommended features: -- _Key-value store_: Dropdown (user's KV stores) or ID/String input. Populated via [Key-value Stores API](https://docs.apify.com/api/v2/key-value-stores-get). +- _Key-value store_: Dropdown (user's KV stores) or ID/String input. Populated via the [Get list of key-value stores](https://docs.apify.com/api/v2/key-value-stores-get) endpoint. - _Record key_: value (string) ##### Web Fetch @@ -136,7 +136,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/actors-get) +- _Select Actor runs to watch_: Dropdown (list of user's Actors). Populated via the [Get list of Actors](https://docs.apify.com/api/v2/actors-get) endpoint ##### Watch task runs @@ -144,7 +144,7 @@ Similar to watching Actor runs, this tracks the progress and completion status o Recommended features: -- _Select Actor tasks to watch_: Dropdown (list of user's tasks). Populated via [List tasks API](https://docs.apify.com/api/v2/actor-tasks-get). +- _Select Actor tasks to watch_: Dropdown (list of user's tasks). Populated via the [Get list of Actor tasks](https://docs.apify.com/api/v2/actor-tasks-get) endpoint. ### Pricing options diff --git a/sources/platform/integrations/programming/webhooks/events.md b/sources/platform/integrations/programming/webhooks/events.md index 9cd885694a..566c670992 100644 --- a/sources/platform/integrations/programming/webhooks/events.md +++ b/sources/platform/integrations/programming/webhooks/events.md @@ -31,7 +31,7 @@ The following data is provided for Actor run events: } ``` -To fetch the results from the Actor run, you can use the `actorRunId` event property and call one of the [Run object and its storages](/api/v2/actor-runs) API endpoints. For example: +To fetch the results from the Actor run, you can use the `actorRunId` event property and call one of the [Manage Actor runs](/api/v2/actor-runs) API endpoints. For example: ```text https://api.apify.com/v2/actor-runs/[ACTOR_RUN_ID]/dataset/items?token=[TOKEN] diff --git a/sources/platform/storage/dataset/dataset_schema.md b/sources/platform/storage/dataset/dataset_schema.md index 668e169de6..2e25576b3b 100644 --- a/sources/platform/storage/dataset/dataset_schema.md +++ b/sources/platform/storage/dataset/dataset_schema.md @@ -120,7 +120,7 @@ The same data often serves different purposes. An e-commerce scraper could offer Views show the same data from different angles. Don't use views for: - Separating unrelated data types - Storing posts, comments, and profiles in one dataset, then using views to separate them. Use separate datasets for unrelated data types. -- Controlling export formats - Views don't change how data exports to JSON, CSV, or Excel. Export format is set in download options or the [Dataset API `format` parameter](/api/v2/dataset-items-get). Views only affect Console UI display. +- Controlling export formats - Views don't change how data exports to JSON, CSV, or Excel. Export format is set in download options or the `format` parameter of the [Get dataset items](/api/v2/dataset-items-get) endpoint. Views only affect Console UI display. ### Basic view example diff --git a/sources/platform/storage/dataset/index.md b/sources/platform/storage/dataset/index.md index b5c3c7e03c..049f65c037 100644 --- a/sources/platform/storage/dataset/index.md +++ b/sources/platform/storage/dataset/index.md @@ -328,7 +328,7 @@ The following example demonstrates a dataset record with hidden fields, includin } ``` -Data excluding hidden fields, termed as "clean" data, can be downloaded from the [Apify Console](https://console.apify.com/storage?tab=datasets) using the **Clean items** option. Alternatively, you can download it via API by applying `clean=true` or `clean=1` as [URL parameters](/api/v2/dataset-items-get). +Data excluding hidden fields, termed as "clean" data, can be downloaded from the [Apify Console](https://console.apify.com/storage?tab=datasets) using the **Clean items** option. Alternatively, you can download it via API by applying `clean=true` or `clean=1` as URL parameters of the [Get dataset items](/api/v2/dataset-items-get) endpoint. ## XML format extension @@ -424,7 +424,7 @@ To read from or write to a dataset that belongs to a different Actor or task run ### Rate limiting -The rate limit for pushing data to a dataset through the [API](/api/v2/dataset-items-post) is capped at _400 requests per second_ for each dataset, a measure to prevent overloading Apify servers. +The rate limit for pushing data to a dataset through the [Store items in dataset](/api/v2/dataset-items-post) endpoint is capped at _400 requests per second_ for each dataset, a measure to prevent overloading Apify servers. For all other dataset [API endpoints](/api/v2/storage-datasets), the rate limit is 60 requests per second for each dataset. diff --git a/sources/platform/storage/dataset/multiple_datasets.mdx b/sources/platform/storage/dataset/multiple_datasets.mdx index af00d9614b..f8837251f0 100644 --- a/sources/platform/storage/dataset/multiple_datasets.mdx +++ b/sources/platform/storage/dataset/multiple_datasets.mdx @@ -127,7 +127,7 @@ The **Export** button on the Run page exports only the `default` dataset. To export programmatically: -- Call the [Dataset API](/api/v2/dataset-items-get) with the dataset ID from `ACTOR_STORAGES_JSON`. The API returns items in any supported format via query parameters. +- Call the [Get dataset items](/api/v2/dataset-items-get) endpoint with the dataset ID from `ACTOR_STORAGES_JSON`. The API returns items in any supported format via query parameters. - From inside an Actor, open the dataset (see [Access datasets in Actor code](#access-datasets-in-actor-code)), then call `getData` / `get_data` to read items into memory, or `exportTo` / `export_to` to write a JSON or CSV file to the key-value store. See [Datasets](/storage/dataset) for formats and query parameters. diff --git a/sources/platform/storage/index.md b/sources/platform/storage/index.md index 633bdacacb..4378b81c68 100644 --- a/sources/platform/storage/index.md +++ b/sources/platform/storage/index.md @@ -196,4 +196,4 @@ Named storages are only removed upon your request. You can delete storages in th [dataset](/api/client/python#datasetclient), [key-value store](/api/client/python/reference/class/KeyValueStoreClient), or [request queue](/api/client/python/reference/class/RequestQueueClient) clients. -* [API](/api/v2/key-value-store-delete) - using the `Delete [store]` endpoint, where `[store]` is the storage type you want to delete. +* API - using the [Delete dataset](/api/v2/dataset-delete), [Delete key-value store](/api/v2/key-value-store-delete), or [Delete request queue](/api/v2/request-queue-delete) endpoint. diff --git a/sources/platform/storage/key_value_store/index.md b/sources/platform/storage/key_value_store/index.md index cc85c0b9d5..3e84ad3d5a 100644 --- a/sources/platform/storage/key_value_store/index.md +++ b/sources/platform/storage/key_value_store/index.md @@ -287,9 +287,9 @@ Key-value storage uses the [AWS S3](https://aws.amazon.com/s3/) service. Accordi ### Rate limiting -Operations on a single record ([get](/api/v2/key-value-store-record-get), [put](/api/v2/key-value-store-record-put), [delete](/api/v2/key-value-store-record-delete)) and [getting the list of keys](/api/v2/key-value-store-keys-get) are limited to _200 requests per second_ per store. +Operations on a single record ([Get key-value store record](/api/v2/key-value-store-record-get), [Set key-value store record](/api/v2/key-value-store-record-put), [Delete key-value store record](/api/v2/key-value-store-record-delete)) and the [Get list of key-value store keys](/api/v2/key-value-store-keys-get) endpoint are limited to _200 requests per second_ per store. -[Downloading all records](/api/v2/key-value-store-records-get) as a ZIP archive is limited to _100 requests per second_ per store. +The [Download key-value store records](/api/v2/key-value-store-records-get) endpoint, which returns a ZIP archive, is limited to _100 requests per second_ per store. All other key-value store [API endpoints](/api/v2/storage-key-value-stores) use the default limit of _60 requests per second_ per store. diff --git a/sources/platform/storage/request_queue.md b/sources/platform/storage/request_queue.md index 99fdd1bbae..fee863e850 100644 --- a/sources/platform/storage/request_queue.md +++ b/sources/platform/storage/request_queue.md @@ -571,15 +571,15 @@ To add requests to a queue that belongs to a different Actor or task run, see [U ### Rate limiting When managing request queues via [API](/api/v2/storage-request-queues-requests), -CRUD ([add](/api/v2/request-queue-requests-post), -[get](/api/v2/request-queue-request-get), -[update](/api/v2/request-queue-request-put), -[delete](/api/v2/request-queue-request-delete)) +CRUD ([Add request to request queue](/api/v2/request-queue-requests-post), +[Get request from request queue](/api/v2/request-queue-request-get), +[Update request in request queue](/api/v2/request-queue-request-put), +[Delete request from request queue](/api/v2/request-queue-request-delete)) operation requests are limited to _350 requests per second_ per request queue. This helps protect Apify servers from being overloaded. -Request-lock operations ([prolong a lock](/api/v2/request-queue-request-lock-put) and [delete a lock](/api/v2/request-queue-request-lock-delete)) are also limited to _350 requests per second_ per request queue. +Request-lock operations ([Prolong lock on request in request queue](/api/v2/request-queue-request-lock-put) and [Delete lock on request in request queue](/api/v2/request-queue-request-lock-delete)) are also limited to _350 requests per second_ per request queue. -Batch operations ([add](/api/v2/request-queue-requests-batch-post) and [delete](/api/v2/request-queue-requests-batch-delete)) and the [list and lock head](/api/v2/request-queue-head-lock-post) endpoint are limited to _35 requests per second_ per request queue. +Batch operations ([Batch add requests to request queue](/api/v2/request-queue-requests-batch-post) and [Batch delete requests from request queue](/api/v2/request-queue-requests-batch-delete)) and the [Get and lock request queue head](/api/v2/request-queue-head-lock-post) endpoint are limited to _35 requests per second_ per request queue. All other request queue API [endpoints](/api/v2/storage-request-queues) are limited to _60 requests per second_ per request queue. From 3080d0340bd8664f555666eb7dabc1243b7fff8e Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 20 Oct 2026 13:41:04 +0000 Subject: [PATCH 3/6] docs: drop CLAUDE.md symlink in favor of AGENTS.md AGENTS.md is the instructions file, so the CLAUDE.md symlink is no longer needed. References to CLAUDE.md now point to AGENTS.md. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01Y6QEzb6KwtQKFiG83nzg5J --- .claude/README.md | 4 ++-- .markdownlintignore | 1 - CLAUDE.md | 1 - CONTRIBUTING.md | 2 +- 4 files changed, 3 insertions(+), 5 deletions(-) delete mode 120000 CLAUDE.md diff --git a/.claude/README.md b/.claude/README.md index 13bf121124..f452609d48 100644 --- a/.claude/README.md +++ b/.claude/README.md @@ -32,7 +32,7 @@ Each skill contains its own `references/` and `scripts/` (formerly in `workflows ### For Claude Code users -1. **Start a new session**: Claude Code reads `CLAUDE.md` (symlink to `AGENTS.md`) +1. **Start a new session**: Claude Code reads `AGENTS.md` 2. **Use skills**: Type `/doc-write`, `/api-doc`, `/tutorial`, or `/review-docs` 3. **Reference standards**: See `standards/` for detailed rules, `AGENTS.md` for summary @@ -104,7 +104,7 @@ npm start # Preview changes ## Best practices -1. **Read `CLAUDE.md` first** +1. **Read `AGENTS.md` first** 2. **Check `standards/`** - Detailed rules for writing, formatting, terminology 3. **Use the appropriate skill** - Designed for specific documentation tasks 4. **Run linters before committing** - `npm run lint:md`, `npm run lint:code`, and `vale` diff --git a/.markdownlintignore b/.markdownlintignore index 34b0984bce..6f3041b029 100644 --- a/.markdownlintignore +++ b/.markdownlintignore @@ -3,7 +3,6 @@ build .claude .agents AGENTS.md -CLAUDE.md GEMINI.md standards sources/_partials/* diff --git a/CLAUDE.md b/CLAUDE.md deleted file mode 120000 index 47dc3e3d86..0000000000 --- a/CLAUDE.md +++ /dev/null @@ -1 +0,0 @@ -AGENTS.md \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9fdebcb8e4..e7ba3efba2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -95,7 +95,7 @@ This project uses an agent-agnostic approach: standards and workflows live at th - **`standards/`** - Writing, formatting, terminology, and quality rules - **`.agents/skills/`** - Documentation skills with processes, references, and scripts (AgentSkills spec) -- **`AGENTS.md`** - Condensed summary + pointers (also `CLAUDE.md` via symlink) +- **`AGENTS.md`** - Condensed summary + pointers (also `GEMINI.md` via symlink) ### Skills (AgentSkills standard) From 64f7027749b2b5b2a481f5cfaf07329e56e06456 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 20 Oct 2026 13:58:56 +0000 Subject: [PATCH 4/6] docs: allow short link text when listing several API endpoints Full endpoint summaries read badly in inline lists such as the request queue rate limits. AGENTS.md now allows shortening each link to the word that tells the endpoints apart when a sentence lists several of them, and those lists go back to the short form. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01Y6QEzb6KwtQKFiG83nzg5J --- AGENTS.md | 1 + .../api/run_actor_and_retrieve_data_via_api.md | 6 +++--- sources/platform/integrations/ai/skyfire.md | 2 +- sources/platform/storage/key_value_store/index.md | 2 +- sources/platform/storage/request_queue.md | 12 ++++++------ 5 files changed, 12 insertions(+), 11 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 88f66b8bdb..37bed3a555 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -95,6 +95,7 @@ schema: Applies to every link to an API reference page, in the OpenAPI spec and in `sources/`: - Use the endpoint's current `summary` as the link text, exactly as written in the spec: `[Get dataset items](/api/v2/dataset-items-get)`, not `[List items](…)`, `[API](…)` or `[documentation](…)`. Keep "endpoint" or "API reference" outside the link: `use the [Run Actor](/api/v2/actors-runs-post) endpoint` +- Exception for lists: when a sentence lists several related endpoints, you can shorten each link to the word that tells them apart, as long as the surrounding text names the resource. For example, `CRUD ([add](…), [get](…), [update](…), [delete](…)) operations on requests` or `endpoints for [Actors](…) and [tasks](…)`. A link to a single endpoint still uses its full summary - Link to an endpoint group page with that group's current title, for example `[Manage Actor runs](/api/v2/actor-runs)` - Link to the page path (`/api/v2/`), never to legacy anchors such as `#/reference/...` or `#tag/.../operation/...`. Those anchors only exist on the target page itself, so they lead nowhere from any other page - When you rename an endpoint's `summary`, update the link text of every link to it across the repo (`grep -rn "/api/v2/"`) 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 87f0cf29d2..70c5b3d1f6 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 @@ -27,7 +27,7 @@ If the Actor being run via API takes 5 minutes or less to complete a typical run > If you are unsure about the differences between an Actor and a task, you can read about them in the [tasks](/actors/running/tasks) documentation. In brief, tasks are pre-configured inputs for Actors. -The API endpoints and usage (for both sync and async) for Actors ([Run Actor](/api/v2/actors-runs-post)) and tasks ([Run Actor task](/api/v2/actor-task-runs-post)) are essentially the same. +The API endpoints and usage (for both sync and async) for [Actors](/api/v2/actors-runs-post) and [tasks](/api/v2/actor-task-runs-post) are essentially the same. To run, or **call**, an Actor/task, you will need a few things: @@ -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](/storage/dataset). The Apify API provides **run-sync-get-dataset-items** endpoints for Actors ([Run Actor synchronously and get dataset items](/api/v2/actor-run-sync-get-dataset-items-post)) and tasks ([Run Actor task synchronously and get dataset items](/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](/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](/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 ([Run Actor synchronously and get key-value store record](/api/v2/actor-run-sync-post)) and tasks ([Run Actor task synchronously and get key-value store record](/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](/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/platform/integrations/ai/skyfire.md b/sources/platform/integrations/ai/skyfire.md index af39544292..2aadd35174 100644 --- a/sources/platform/integrations/ai/skyfire.md +++ b/sources/platform/integrations/ai/skyfire.md @@ -190,7 +190,7 @@ You can also use the asynchronous [Run Actor](/api/v2/actors-runs-post) endpoint ### Access the run and its storages -To access a run and its storages, reuse the same `skyfire-pay-id` header as authentication. As long as you send the token that paid for the run, you can call the [Get Actor run](/api/v2/actor-run-get) endpoint and the [Datasets](/api/v2/storage-datasets) and [Key-value stores](/api/v2/storage-key-value-stores) endpoints for that run and its default storages. +To access a run and its storages, reuse the same `skyfire-pay-id` header as authentication. As long as you send the token that paid for the run, you can call the [run](/api/v2/actor-run-get), [dataset](/api/v2/storage-datasets), and [key-value store](/api/v2/storage-key-value-stores) endpoints for that run and its default storages. This is useful when you start a run asynchronously with the [Run Actor](/api/v2/actors-runs-post) endpoint and then poll its status or fetch results separately. diff --git a/sources/platform/storage/key_value_store/index.md b/sources/platform/storage/key_value_store/index.md index 3e84ad3d5a..efcccb989e 100644 --- a/sources/platform/storage/key_value_store/index.md +++ b/sources/platform/storage/key_value_store/index.md @@ -287,7 +287,7 @@ Key-value storage uses the [AWS S3](https://aws.amazon.com/s3/) service. Accordi ### Rate limiting -Operations on a single record ([Get key-value store record](/api/v2/key-value-store-record-get), [Set key-value store record](/api/v2/key-value-store-record-put), [Delete key-value store record](/api/v2/key-value-store-record-delete)) and the [Get list of key-value store keys](/api/v2/key-value-store-keys-get) endpoint are limited to _200 requests per second_ per store. +Operations on a single record ([get](/api/v2/key-value-store-record-get), [put](/api/v2/key-value-store-record-put), [delete](/api/v2/key-value-store-record-delete)) and [getting the list of keys](/api/v2/key-value-store-keys-get) are limited to _200 requests per second_ per store. The [Download key-value store records](/api/v2/key-value-store-records-get) endpoint, which returns a ZIP archive, is limited to _100 requests per second_ per store. diff --git a/sources/platform/storage/request_queue.md b/sources/platform/storage/request_queue.md index fee863e850..99fdd1bbae 100644 --- a/sources/platform/storage/request_queue.md +++ b/sources/platform/storage/request_queue.md @@ -571,15 +571,15 @@ To add requests to a queue that belongs to a different Actor or task run, see [U ### Rate limiting When managing request queues via [API](/api/v2/storage-request-queues-requests), -CRUD ([Add request to request queue](/api/v2/request-queue-requests-post), -[Get request from request queue](/api/v2/request-queue-request-get), -[Update request in request queue](/api/v2/request-queue-request-put), -[Delete request from request queue](/api/v2/request-queue-request-delete)) +CRUD ([add](/api/v2/request-queue-requests-post), +[get](/api/v2/request-queue-request-get), +[update](/api/v2/request-queue-request-put), +[delete](/api/v2/request-queue-request-delete)) operation requests are limited to _350 requests per second_ per request queue. This helps protect Apify servers from being overloaded. -Request-lock operations ([Prolong lock on request in request queue](/api/v2/request-queue-request-lock-put) and [Delete lock on request in request queue](/api/v2/request-queue-request-lock-delete)) are also limited to _350 requests per second_ per request queue. +Request-lock operations ([prolong a lock](/api/v2/request-queue-request-lock-put) and [delete a lock](/api/v2/request-queue-request-lock-delete)) are also limited to _350 requests per second_ per request queue. -Batch operations ([Batch add requests to request queue](/api/v2/request-queue-requests-batch-post) and [Batch delete requests from request queue](/api/v2/request-queue-requests-batch-delete)) and the [Get and lock request queue head](/api/v2/request-queue-head-lock-post) endpoint are limited to _35 requests per second_ per request queue. +Batch operations ([add](/api/v2/request-queue-requests-batch-post) and [delete](/api/v2/request-queue-requests-batch-delete)) and the [list and lock head](/api/v2/request-queue-head-lock-post) endpoint are limited to _35 requests per second_ per request queue. All other request queue API [endpoints](/api/v2/storage-request-queues) are limited to _60 requests per second_ per request queue. From 0f3680e8e6c7f95c9f5f0cb82621985162545a62 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 20 Oct 2026 14:07:06 +0000 Subject: [PATCH 5/6] docs: replace broken legacy object and namespace links in API spec Links such as [Version object](#/reference/actors/version-object) pointed to anchors that only exist on endpoint group pages, so they led nowhere. Object mentions are now plain text, since each endpoint page shows the object schema, and the deprecated-namespace notes link to the Manage Actor runs and Manage Actor builds pages. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01Y6QEzb6KwtQKFiG83nzg5J --- .../openapi/components/objects/actor-runs/abort.yaml | 3 ++- .../components/objects/actor-runs/metamorph.yaml | 3 ++- .../components/objects/actor-runs/resurrect.yaml | 3 ++- ...ons@{versionNumber}@env-vars@{envVarName}put.yaml | 10 +++++----- .../acts@{actorId}@versions@{versionNumber}put.yaml | 6 +++--- .../actors/acts@{actorId}@builds@{buildId}.yaml | 2 +- .../acts@{actorId}@builds@{buildId}@abort.yaml | 2 +- .../paths/actors/acts@{actorId}@runs@{runId}.yaml | 3 ++- .../paths/actors/acts@{actorId}@versions.yaml | 12 ++++++------ .../acts@{actorId}@versions@{versionNumber}.yaml | 2 +- ...@{actorId}@versions@{versionNumber}@env-vars.yaml | 10 +++++----- ...rsions@{versionNumber}@env-vars@{envVarName}.yaml | 2 +- 12 files changed, 31 insertions(+), 27 deletions(-) diff --git a/apify-api/openapi/components/objects/actor-runs/abort.yaml b/apify-api/openapi/components/objects/actor-runs/abort.yaml index ecbddeefc5..00d28e9a51 100644 --- a/apify-api/openapi/components/objects/actor-runs/abort.yaml +++ b/apify-api/openapi/components/objects/actor-runs/abort.yaml @@ -56,7 +56,8 @@ byActorRunId: summary: Abort Actor run description: | **[DEPRECATED]** API endpoints related to run of the Actor were moved under - new namespace [`actor-runs`](#/reference/actor-runs). Aborts an Actor run and + new namespace `actor-runs` + ([Manage Actor runs](/api/v2/actor-runs)). Aborts an Actor run and returns an object that contains all the details about the run. Only runs that are starting or running are aborted. For runs with status diff --git a/apify-api/openapi/components/objects/actor-runs/metamorph.yaml b/apify-api/openapi/components/objects/actor-runs/metamorph.yaml index 900f1d31a7..5df8c99683 100644 --- a/apify-api/openapi/components/objects/actor-runs/metamorph.yaml +++ b/apify-api/openapi/components/objects/actor-runs/metamorph.yaml @@ -81,7 +81,8 @@ byActorRunId: summary: Metamorph Actor run description: | **[DEPRECATED]** API endpoints related to run of the Actor were moved under - new namespace [`actor-runs`](#/reference/actor-runs). Transforms an Actor run + new namespace `actor-runs` + ([Manage Actor runs](/api/v2/actor-runs)). Transforms an Actor run into a run of another Actor with a new input. This is useful if you want to use another Actor to finish the work diff --git a/apify-api/openapi/components/objects/actor-runs/resurrect.yaml b/apify-api/openapi/components/objects/actor-runs/resurrect.yaml index 5b51dea466..a9210e25bb 100644 --- a/apify-api/openapi/components/objects/actor-runs/resurrect.yaml +++ b/apify-api/openapi/components/objects/actor-runs/resurrect.yaml @@ -63,7 +63,8 @@ byActorRunId: summary: Resurrect Actor run description: | **[DEPRECATED]** API endpoints related to run of the Actor were moved under - new namespace [`actor-runs`](#/reference/actor-runs).Resurrects a finished + new namespace `actor-runs` + ([Manage Actor runs](/api/v2/actor-runs)). Resurrects a finished Actor run and returns an object that contains all the details about the resurrected run. 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 c357c21aa2..16c7741d7d 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 @@ -61,8 +61,8 @@ put: <<: *shared summary: Update environment variable in Actor version description: | - Updates Actor environment variable using values specified by a [EnvVar - object](#/reference/actors/environment-variable-object) + Updates Actor environment variable using values specified by an EnvVar + object passed as JSON in the POST payload. If the object does not define a specific property, its value will not be updated. @@ -74,7 +74,7 @@ put: request's `Authorization` header, rather than the URL. [Learn more](/api/v2/getting-started#authentication) - The response is the [EnvVar object](#/reference/actors/environment-variable-object) as returned by the + The response is the EnvVar object as returned by the [Get environment variable of Actor version](/api/v2/actor-version-env-var-get) endpoint. operationId: actor_version_envVar_put @@ -87,8 +87,8 @@ post: <<: *shared summary: Update environment variable in Actor version (POST) description: | - Updates Actor environment variable using values specified by a [EnvVar - object](#/reference/actors/environment-variable-object) + Updates Actor environment variable using values specified by an EnvVar + object passed as JSON in the POST payload. This endpoint is an alias for the [Update environment variable in Actor version](/api/v2/actor-version-env-var-put) endpoint and behaves identically. operationId: actor_version_envVar_post 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 e47f3ddbd7..911c292f1c 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 @@ -57,7 +57,7 @@ put: <<: *shared summary: Update Actor version description: | - Updates Actor version using values specified by a [Version object](#/reference/actors/version-object) passed as JSON in the POST payload. + Updates Actor version using values specified by a Version object passed as JSON in the POST payload. If the object does not define a specific property, its value will not be updated. @@ -69,7 +69,7 @@ put: request's `Authorization` header, rather than the URL. [Learn more](/api/v2/getting-started#authentication) - The response is the [Version object](#/reference/actors/version-object) as + The response is the Version object as returned by the [Get Actor version](/api/v2/actor-version-get) endpoint. operationId: actor_version_put x-legacy-doc-urls: @@ -81,7 +81,7 @@ post: <<: *shared summary: Update Actor version (POST) description: | - Updates Actor version using values specified by a [Version object](#/reference/actors/version-object) passed as JSON in the POST payload. + Updates Actor version using values specified by a Version object passed as JSON in the POST payload. This endpoint is an alias for the [Update Actor version](/api/v2/actor-version-put) endpoint and behaves identically. operationId: actor_version_post x-legacy-doc-urls: diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}.yaml index 539c8608ea..273737286b 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}.yaml @@ -35,7 +35,7 @@ get: "429": $ref: ../../components/responses/TooManyRequests.yaml deprecated: true - x-deprecated-description: "API endpoints related to build of the Actor were moved under new namespace [`actor-builds`](#/reference/actor-builds). Gets an object that contains all the details about a specific build of an Actor." + x-deprecated-description: "API endpoints related to build of the Actor were moved under new namespace `actor-builds` ([Manage Actor builds](/api/v2/actor-builds)). Gets an object that contains all the details about a specific build of an Actor." x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/build-object/get-build - https://docs.apify.com/api/v2#/reference/actors/get-build diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@abort.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@abort.yaml index 052bf59622..8cefb5b2c9 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@abort.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@abort.yaml @@ -4,7 +4,7 @@ post: summary: Abort Actor build description: | **[DEPRECATED]** API endpoints related to build of the Actor were moved - under new namespace [`actor-builds`](#/reference/actor-builds). Aborts an + under new namespace `actor-builds` ([Manage Actor builds](/api/v2/actor-builds)). Aborts an Actor build and returns an object that contains all the details about the build. diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}.yaml index 59489b211b..929aa53976 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}.yaml @@ -4,7 +4,8 @@ get: summary: Get Actor run description: | **[DEPRECATED]** API endpoints related to run of the Actor were moved under - new namespace [`actor-runs`](#/reference/actor-runs). + new namespace `actor-runs` + ([Manage Actor runs](/api/v2/actor-runs)). Gets an object that contains all the details about a specific run of an Actor. diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml index 255290e3ee..96a001702e 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml @@ -4,7 +4,7 @@ get: summary: Get list of Actor versions description: | 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 + with the list of Version objects, where each contains basic information about a single version. operationId: actor_versions_get parameters: @@ -70,8 +70,8 @@ post: - Actors/Actor versions summary: Create Actor version description: | - Creates a version of an Actor using values specified in a [Version - object](#/reference/actors/version-object) passed as JSON in the POST + Creates a version of an Actor using values specified in a Version + object passed as JSON in the POST payload. The request must specify `versionNumber` and `sourceType` parameters (as @@ -79,8 +79,8 @@ post: header. Each `sourceType` requires its own additional properties to be passed to the - JSON payload object. These are outlined in the [Version - object](#/reference/actors/version-object) table below and in more detail in + JSON payload object. These are outlined in the Version + object table below and in more detail in the [Apify documentation](https://docs.apify.com/platform/actors/development/deployment/source-types). @@ -97,7 +97,7 @@ post: } ``` - The response is the [Version object](#/reference/actors/version-object) as + The response is the Version object as returned by the [Get Actor version](/api/v2/actor-version-get) endpoint. operationId: actor_versions_post parameters: 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 ac89682ee1..95fdb40dfe 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml @@ -3,7 +3,7 @@ get: - Actors/Actor versions summary: Get Actor version description: | - Gets a [Version object](#/reference/actors/version-object) that contains all the details about a specific version of an Actor. + Gets a Version object that contains all the details about a specific version of an Actor. operationId: actor_version_get parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" 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 f036ac0e74..3e9fb8d364 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 @@ -4,7 +4,7 @@ get: summary: Get list of environment variables of Actor version 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. + The response is a JSON object with the list of EnvVar objects, where each contains basic information about a single environment variable. operationId: actor_version_envVars_get parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" @@ -42,8 +42,8 @@ post: - Actors/Actor versions summary: Create environment variable in Actor version description: | - Creates an environment variable of an Actor using values specified in a - [EnvVar object](#/reference/actors/environment-variable-object) passed as + Creates an environment variable of an Actor using values specified in an + EnvVar object passed as JSON in the POST payload. The request must specify `name` and `value` parameters (as strings) in the @@ -56,8 +56,8 @@ post: } ``` - The response is the [EnvVar - object](#/reference/actors/environment-variable-object) as returned by the [Get environment variable of Actor version](/api/v2/actor-version-env-var-get) + The response is the EnvVar + object as returned by the [Get environment variable of Actor version](/api/v2/actor-version-env-var-get) endpoint. operationId: actor_version_envVars_post parameters: 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 0ca9e765ee..d9b6f0bf63 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 @@ -3,7 +3,7 @@ get: - Actors/Actor versions summary: Get environment variable of Actor version description: | - Gets a [EnvVar object](#/reference/actors/environment-variable-object) that + Gets an EnvVar object that contains all the details about a specific environment variable of an Actor. If `isSecret` is set to `true`, then `value` will never be returned. From c3478b3ee723496e8b6efeaa949f05e8d7fcdc17 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 20 Oct 2026 14:11:39 +0000 Subject: [PATCH 6/6] docs: format Version and EnvVar object names as code in API spec Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01Y6QEzb6KwtQKFiG83nzg5J --- ...versions@{versionNumber}@env-vars@{envVarName}put.yaml | 6 +++--- .../acts@{actorId}@versions@{versionNumber}put.yaml | 6 +++--- apify-api/openapi/components/tags.yaml | 2 +- .../openapi/paths/actors/acts@{actorId}@versions.yaml | 8 ++++---- .../actors/acts@{actorId}@versions@{versionNumber}.yaml | 2 +- .../acts@{actorId}@versions@{versionNumber}@env-vars.yaml | 6 +++--- ...d}@versions@{versionNumber}@env-vars@{envVarName}.yaml | 2 +- 7 files changed, 16 insertions(+), 16 deletions(-) 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 16c7741d7d..0d87ea9c03 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 @@ -61,7 +61,7 @@ put: <<: *shared summary: Update environment variable in Actor version description: | - Updates Actor environment variable using values specified by an EnvVar + Updates Actor environment variable using values specified by an `EnvVar` object passed as JSON in the POST payload. If the object does not define a specific property, its value will not be @@ -74,7 +74,7 @@ put: request's `Authorization` header, rather than the URL. [Learn more](/api/v2/getting-started#authentication) - The response is the EnvVar object as returned by the + The response is the `EnvVar` object as returned by the [Get environment variable of Actor version](/api/v2/actor-version-env-var-get) endpoint. operationId: actor_version_envVar_put @@ -87,7 +87,7 @@ post: <<: *shared summary: Update environment variable in Actor version (POST) description: | - Updates Actor environment variable using values specified by an EnvVar + Updates Actor environment variable using values specified by an `EnvVar` object passed as JSON in the POST payload. This endpoint is an alias for the [Update environment variable in Actor version](/api/v2/actor-version-env-var-put) endpoint and behaves identically. 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 911c292f1c..08b9592a23 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 @@ -57,7 +57,7 @@ put: <<: *shared summary: Update Actor version description: | - Updates Actor version using values specified by a Version object passed as JSON in the POST payload. + Updates Actor version using values specified by a `Version` object passed as JSON in the POST payload. If the object does not define a specific property, its value will not be updated. @@ -69,7 +69,7 @@ put: request's `Authorization` header, rather than the URL. [Learn more](/api/v2/getting-started#authentication) - The response is the Version object as + The response is the `Version` object as returned by the [Get Actor version](/api/v2/actor-version-get) endpoint. operationId: actor_version_put x-legacy-doc-urls: @@ -81,7 +81,7 @@ post: <<: *shared summary: Update Actor version (POST) description: | - Updates Actor version using values specified by a Version object passed as JSON in the POST payload. + Updates Actor version using values specified by a `Version` object passed as JSON in the POST payload. This endpoint is an alias for the [Update Actor version](/api/v2/actor-version-put) endpoint and behaves identically. operationId: actor_version_post x-legacy-doc-urls: diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index fc32ff698c..54a5c7f76f 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -34,7 +34,7 @@ - The version object contains the source code of a specific version of an Actor. - The `sourceType` property indicates where the source code is hosted, and based - on its value the Version object has the following additional property: + on its value the `Version` object has the following additional property: | **Value** | **Description** | |---|---| diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml index 96a001702e..5b3d99377d 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml @@ -4,7 +4,7 @@ get: summary: Get list of Actor versions description: | Gets the list of versions of a specific Actor. The response is a JSON object - with the list of Version objects, where each + with the list of `Version` objects, where each contains basic information about a single version. operationId: actor_versions_get parameters: @@ -70,7 +70,7 @@ post: - Actors/Actor versions summary: Create Actor version description: | - Creates a version of an Actor using values specified in a Version + Creates a version of an Actor using values specified in a `Version` object passed as JSON in the POST payload. @@ -79,7 +79,7 @@ post: header. Each `sourceType` requires its own additional properties to be passed to the - JSON payload object. These are outlined in the Version + JSON payload object. These are outlined in the `Version` object table below and in more detail in the [Apify documentation](https://docs.apify.com/platform/actors/development/deployment/source-types). @@ -97,7 +97,7 @@ post: } ``` - The response is the Version object as + The response is the `Version` object as returned by the [Get Actor version](/api/v2/actor-version-get) endpoint. operationId: actor_versions_post parameters: 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 95fdb40dfe..0f81c2d450 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml @@ -3,7 +3,7 @@ get: - Actors/Actor versions summary: Get Actor version description: | - Gets a Version object that contains all the details about a specific version of an Actor. + Gets a `Version` object that contains all the details about a specific version of an Actor. operationId: actor_version_get parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" 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 3e9fb8d364..210894342e 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 @@ -4,7 +4,7 @@ get: summary: Get list of environment variables of Actor version 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, where each contains basic information about a single environment variable. + The response is a JSON object with the list of `EnvVar` objects, where each contains basic information about a single environment variable. operationId: actor_version_envVars_get parameters: - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" @@ -43,7 +43,7 @@ post: summary: Create environment variable in Actor version description: | Creates an environment variable of an Actor using values specified in an - EnvVar object passed as + `EnvVar` object passed as JSON in the POST payload. The request must specify `name` and `value` parameters (as strings) in the @@ -56,7 +56,7 @@ post: } ``` - The response is the EnvVar + The response is the `EnvVar` object as returned by the [Get environment variable of Actor version](/api/v2/actor-version-env-var-get) endpoint. operationId: actor_version_envVars_post 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 d9b6f0bf63..a0f172338a 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 @@ -3,7 +3,7 @@ get: - Actors/Actor versions summary: Get environment variable of Actor version description: | - Gets an EnvVar object that + Gets an `EnvVar` object that contains all the details about a specific environment variable of an Actor. If `isSecret` is set to `true`, then `value` will never be returned.