diff --git a/apify-docs-theme/src/config.js b/apify-docs-theme/src/config.js index ccd4577658..92b4bc8116 100644 --- a/apify-docs-theme/src/config.js +++ b/apify-docs-theme/src/config.js @@ -20,91 +20,102 @@ const themeConfig = { }, items: [ { - label: 'Academy', - href: `${absoluteUrl}/academy`, - activeBasePath: 'academy', + label: 'Get started', + href: `${absoluteUrl}/platform/get-started`, + activeBasePath: 'platform/get-started', position: 'left', target: '_self', rel: 'dofollow', }, { - label: 'Platform', - href: `${absoluteUrl}/platform`, - className: 'navbar__active', - activeBasePath: 'platform', + label: 'Actors', + href: `${absoluteUrl}/platform/actors`, + activeBasePath: 'platform/actors', position: 'left', target: '_self', rel: 'dofollow', }, { - label: 'API', - type: 'dropdown', - to: `${absoluteUrl}/api`, + label: 'Storage', + href: `${absoluteUrl}/platform/storage`, + activeBasePath: 'platform/storage', + position: 'left', + target: '_self', + rel: 'dofollow', + }, + { + label: 'Proxy', + href: `${absoluteUrl}/platform/proxy`, + activeBasePath: 'platform/proxy', + position: 'left', + target: '_self', + rel: 'dofollow', + }, + { + label: 'Integrations', + href: `${absoluteUrl}/platform/integrations`, + activeBasePath: 'platform/integrations', + position: 'left', + target: '_self', + rel: 'dofollow', + }, + { + label: 'Account', + href: `${absoluteUrl}/platform/account`, + activeBasePath: 'platform/account', + position: 'left', target: '_self', rel: 'dofollow', + }, + { + label: 'API', + href: `${absoluteUrl}/api/v2`, activeBasePath: 'api', position: 'left', + target: '_self', + rel: 'dofollow', + }, + { + label: 'Resources', + type: 'dropdown', + position: 'left', items: [ { - label: 'Reference', - href: `${absoluteUrl}/api/v2`, + label: 'Academy', + href: `${absoluteUrl}/academy`, target: '_self', rel: 'dofollow', }, { - label: 'Client for JavaScript', - href: `${absoluteUrl}/api/client/js/docs`, + label: 'SDK for JavaScript', + href: `${absoluteUrl}/sdk/js/docs/overview`, target: '_self', rel: 'dofollow', }, { - label: 'Client for Python', - href: `${absoluteUrl}/api/client/python/docs/overview`, + label: 'SDK for Python', + href: `${absoluteUrl}/sdk/python/docs/overview`, target: '_self', rel: 'dofollow', }, - ], - }, - { - label: 'SDK', - type: 'dropdown', - to: `${absoluteUrl}/sdk`, - activeBasePath: 'sdk', - position: 'left', - target: '_self', - rel: 'dofollow', - items: [ { - label: 'SDK for JavaScript', - href: `${absoluteUrl}/sdk/js/docs/overview`, + label: 'API Client for JavaScript', + href: `${absoluteUrl}/api/client/js/docs`, target: '_self', rel: 'dofollow', }, { - html: 'SDK for Python', - href: `${absoluteUrl}/sdk/python/docs/overview`, + label: 'API Client for Python', + href: `${absoluteUrl}/api/client/python/docs/overview`, + target: '_self', + rel: 'dofollow', + }, + { + label: 'CLI', + href: `${absoluteUrl}/cli/docs`, target: '_self', rel: 'dofollow', }, - ], - }, - { - label: 'CLI', - href: `${absoluteUrl}/cli/docs`, - position: 'left', - activeBasePath: 'cli', - target: '_self', - rel: 'dofollow', - }, - { - label: 'Open source', - type: 'dropdown', - to: `${absoluteUrl}/open-source`, - activeBasePath: 'open-source', - target: '_self', - position: 'left', - className: 'navbar__item', - items: [ { label: 'Crawlee', href: 'https://crawlee.dev', diff --git a/apify-docs-theme/src/theme/Layout/index.jsx b/apify-docs-theme/src/theme/Layout/index.jsx index b5f4d60b4f..75f04889b6 100644 --- a/apify-docs-theme/src/theme/Layout/index.jsx +++ b/apify-docs-theme/src/theme/Layout/index.jsx @@ -1,5 +1,6 @@ import Head from '@docusaurus/Head'; import { useLocation } from '@docusaurus/router'; +import { isRegexpStringMatch } from '@docusaurus/theme-common'; // cannot use any of the theme aliases here as it causes a circular dependency :( ideas welcome import Layout from '@docusaurus/theme-classic/lib/theme/Layout/index'; import useBaseUrl from '@docusaurus/useBaseUrl'; @@ -7,13 +8,19 @@ import { usePluginData } from '@docusaurus/useGlobalData'; import React from 'react'; export default function LayoutWrapper(props) { - const { options: { subNavbar } } = usePluginData('@apify/docs-theme'); + const { options } = usePluginData('@apify/docs-theme'); const baseUrl = useBaseUrl('/'); - const currentPath = useLocation().pathname.replace(new RegExp(`^${baseUrl}`), '').trim(); + const location = useLocation(); + const currentPath = location.pathname.replace(new RegExp(`^${baseUrl}`), '').trim(); const shouldRenderAlternateLink = currentPath && currentPath !== '404'; const alternateMarkdownLink = useBaseUrl(`/${currentPath}.md`, { absolute: true }); + const subNavbars = options.subNavbars ?? (options.subNavbar ? [options.subNavbar] : []); + const hasActiveSubNavbar = subNavbars.some( + (nav) => !nav.pathRegex || isRegexpStringMatch(nav.pathRegex, location.pathname), + ); + return ( <> @@ -25,7 +32,7 @@ export default function LayoutWrapper(props) {
-
-
-
- } - to={subNavbar.to ?? '/'} - activeBaseRegex='(?!)' - /> -
- + const subNavbars = options.subNavbars ?? (options.subNavbar ? [options.subNavbar] : []); + const activeSubNavbar = subNavbars.find( + (nav) => !nav.pathRegex || isRegexpStringMatch(nav.pathRegex, location.pathname), + ); + + return activeSubNavbar ? ( +
+
+
+
+ } + to={activeSubNavbar.to ?? '/'} + activeBaseRegex='(?!)' + />
+
- ) : null - ); +
+ ) : null; } export default function NavbarContent() { diff --git a/apify-docs-theme/src/theme/Navbar/MobileSidebar/PrimaryMenu/index.jsx b/apify-docs-theme/src/theme/Navbar/MobileSidebar/PrimaryMenu/index.jsx index 376e1e6d44..bba1d39ad7 100644 --- a/apify-docs-theme/src/theme/Navbar/MobileSidebar/PrimaryMenu/index.jsx +++ b/apify-docs-theme/src/theme/Navbar/MobileSidebar/PrimaryMenu/index.jsx @@ -1,4 +1,5 @@ -import { useThemeConfig } from '@docusaurus/theme-common'; +import { useLocation } from '@docusaurus/router'; +import { isRegexpStringMatch, useThemeConfig } from '@docusaurus/theme-common'; import useBaseUrl from '@docusaurus/useBaseUrl'; import { usePluginData } from '@docusaurus/useGlobalData'; import NavbarItem from '@theme/NavbarItem'; @@ -15,19 +16,26 @@ export default function NavbarMobilePrimaryMenu() { // Should we allow providing a different list of items? const items = useNavbarItems(); const baseUrl = useBaseUrl('/'); - const { options: { subNavbar } } = usePluginData('@apify/docs-theme'); + const { options } = usePluginData('@apify/docs-theme'); + const location = useLocation(); + + const subNavbars = options.subNavbars ?? (options.subNavbar ? [options.subNavbar] : []); + const activeSubNavbar = subNavbars.find( + (nav) => !nav.pathRegex || isRegexpStringMatch(nav.pathRegex, location.pathname), + ); + return ( <> { - subNavbar ? <> + activeSubNavbar ? <>
    - {subNavbar.items.map((item, i) => ( + {activeSubNavbar.items.map((item, i) => ( Running + rewrite ^/platform/schedules$ /platform/actors/running/schedules redirect; + rewrite ^/platform/monitoring$ /platform/actors/running/monitoring redirect; + + # IA restructure: Console → Account + rewrite ^/platform/console/billing$ /platform/account/billing redirect; + rewrite ^/platform/console/store$ /platform/account/store redirect; + rewrite ^/platform/console/settings$ /platform/account/settings redirect; + rewrite ^/platform/console/two-factor-authentication$ /platform/account/two-factor-authentication redirect; + rewrite ^/platform/console$ /platform/account/console redirect; + + # IA restructure: Collaboration → Account + rewrite ^/platform/collaboration/access-rights$ /platform/account/access-rights redirect; + rewrite ^/platform/collaboration/general-resource-access$ /platform/account/general-resource-access redirect; + rewrite ^/platform/collaboration/list-of-permissions$ /platform/account/list-of-permissions redirect; + rewrite ^/platform/collaboration/organization-account/setup$ /platform/account/organization/setup redirect; + rewrite ^/platform/collaboration/organization-account/how-to-use$ /platform/account/organization/how-to-use redirect; + rewrite ^/platform/collaboration/organization-account$ /platform/account/organization redirect; + rewrite ^/platform/collaboration$ /platform/account redirect; + + # IA restructure: Limits → Account (Security stays top-level) + rewrite ^/platform/limits$ /platform/account/limits redirect; + + # IA restructure: Schema directories flattened + rewrite ^/platform/actors/development/actor-definition/input-schema/specification/v1$ /platform/actors/development/input-output-schemas/input-schema/specification/v1 redirect; + rewrite ^/platform/actors/development/actor-definition/input-schema/secret-input$ /platform/actors/development/input-output-schemas/input-schema/secret-input redirect; + rewrite ^/platform/actors/development/actor-definition/input-schema/custom-error-messages$ /platform/actors/development/input-output-schemas/input-schema/custom-error-messages redirect; + rewrite ^/platform/actors/development/actor-definition/input-schema$ /platform/actors/development/input-output-schemas/input-schema redirect; + rewrite ^/platform/actors/development/actor-definition/output-schema$ /platform/actors/development/input-output-schemas/output-schema redirect; + rewrite ^/platform/actors/development/actor-definition/dataset-schema/validation$ /platform/actors/development/input-output-schemas/dataset-schema/validation redirect; + rewrite ^/platform/actors/development/actor-definition/dataset-schema$ /platform/actors/development/input-output-schemas/dataset-schema redirect; + rewrite ^/platform/actors/development/actor-definition/key-value-store-schema$ /platform/actors/development/input-output-schemas/key-value-store-schema redirect; + # Misc rewrite ^/platform/integrations/llama$ /platform/integrations/llama-index permanent; } diff --git a/sources/academy/build-and-publish/apify-store-basics/actor_description_seo_description.md b/sources/academy/build-and-publish/apify-store-basics/actor_description_seo_description.md index 298e5c9e83..b67f06cf16 100644 --- a/sources/academy/build-and-publish/apify-store-basics/actor_description_seo_description.md +++ b/sources/academy/build-and-publish/apify-store-basics/actor_description_seo_description.md @@ -22,11 +22,11 @@ You can change descriptions and names as many times as you want. ## Regular description vs. SEO description -| | Actor description & name | SEO description & name | -|---|---|---| +| | Actor description & name | SEO description & name | +| --- | --- | --- | | Name length | 40-50 characters | 40-50 characters | | Description length | 300 characters | 145-155 characters | -| Visibility | Visible on Store | Visible on Google | +| Visibility | Visible on Store | Visible on Google | ### Description & Actor name diff --git a/sources/academy/build-and-publish/how-to-build/actorization_playbook.mdx b/sources/academy/build-and-publish/how-to-build/actorization_playbook.mdx index 44896742dd..8ff81813db 100644 --- a/sources/academy/build-and-publish/how-to-build/actorization_playbook.mdx +++ b/sources/academy/build-and-publish/how-to-build/actorization_playbook.mdx @@ -83,7 +83,7 @@ In case you're starting a new project, we strongly advise to start with a [templ :::note Quick Start for beginners - For a step-by-step introduction to creating your first Actor (including tech stack choices and development paths), see [Quick Start](/platform/actors/development/quick-start). + For a step-by-step introduction to creating your first Actor (including tech stack choices and development paths), see [Quick Start](/platform/get-started/build-an-actor). ::: @@ -100,7 +100,7 @@ These steps are the bare minimum you need to run your code on Apify. The rest of Most Actors accept an input and produce an output. As part of Actorization, you need to define the input and output structure of your application. -For detailed information, read the docs for [input schema](/platform/actors/development/actor-definition/input-schema), [dataset schema](/platform/actors/development/actor-definition/dataset-schema), and general [storage](/platform/storage). +For detailed information, read the docs for [input schema](/platform/actors/development/input-output-schemas/input-schema), [dataset schema](/platform/actors/development/input-output-schemas/dataset-schema), and general [storage](/platform/storage). #### Design guidelines diff --git a/sources/academy/build-and-publish/how-to-build/how_to_create_a_great_input_schema.md b/sources/academy/build-and-publish/how-to-build/how_to_create_a_great_input_schema.md index 43f5b73f1e..c03a13e7f0 100644 --- a/sources/academy/build-and-publish/how-to-build/how_to_create_a_great_input_schema.md +++ b/sources/academy/build-and-publish/how-to-build/how_to_create_a_great_input_schema.md @@ -31,7 +31,7 @@ In this article, _we’ll refer to the input schema as the user interface_ of yo :::tip Understand input schemas -To fully understand the recommendations in this blog post, you’ll first need to familiarize yourself with the [technical aspects of the input schema](https://docs.apify.com/platform/actors/development/actor-definition/input-schema). This context is essential to make good use of the insights shared here. +To fully understand the recommendations in this blog post, you’ll first need to familiarize yourself with the [technical aspects of the input schema](https://docs.apify.com/platform/actors/development/input-output-schemas/input-schema). This context is essential to make good use of the insights shared here. ::: @@ -170,4 +170,4 @@ The version above was the improved input schema. Here's what this tool's input s ## Resources - Basics of input schema: [https://docs.apify.com/academy/deploying-your-code/input-schema](https://docs.apify.com/academy/deploying-your-code/input-schema) -- Specifications of input schema: [https://docs.apify.com/platform/actors/development/actor-definition/input-schema](https://docs.apify.com/platform/actors/development/actor-definition/input-schema) +- Specifications of input schema: [https://docs.apify.com/platform/actors/development/input-output-schemas/input-schema](https://docs.apify.com/platform/actors/development/input-output-schemas/input-schema) diff --git a/sources/academy/platform/deploying_your_code/input_schema.md b/sources/academy/platform/deploying_your_code/input_schema.md index 82eeab6b30..f19cf8ce1a 100644 --- a/sources/academy/platform/deploying_your_code/input_schema.md +++ b/sources/academy/platform/deploying_your_code/input_schema.md @@ -9,7 +9,7 @@ slug: /deploying-your-code/input-schema --- -Though writing an [input schema](/platform/actors/development/actor-definition/input-schema) for an Actor is not a required step, it's definitely an ideal one. The Apify platform will read the `INPUT_SCHEMA.json` file within the root of your project and generate a user interface for entering input into your Actor, which makes it significantly easier for non-developers (and even developers) to configure and understand the inputs your Actor can receive. Because of this, we'll be writing an input schema for our example Actor. +Though writing an [input schema](/platform/actors/development/input-output-schemas/input-schema) for an Actor is not a required step, it's definitely an ideal one. The Apify platform will read the `INPUT_SCHEMA.json` file within the root of your project and generate a user interface for entering input into your Actor, which makes it significantly easier for non-developers (and even developers) to configure and understand the inputs your Actor can receive. Because of this, we'll be writing an input schema for our example Actor. :::note JSON requirement @@ -55,7 +55,7 @@ Each property's key corresponds to the name we're expecting within our code, whi ## Property types & editor types {#property-types} -Within our new **numbers** property, there are two more fields we must specify. Firstly, we must let the platform know that we're expecting an array of numbers with the **type** field. Then, we should also instruct Apify on which UI component to render for this input property. In our case, we have an array of numbers, which means we should use the **json** editor type that we discovered in the ["array" section](/platform/actors/development/actor-definition/input-schema/specification/v1#array) of the input schema documentation. We could also use **stringList**, but then we'd have to parse out the numbers from the strings. +Within our new **numbers** property, there are two more fields we must specify. Firstly, we must let the platform know that we're expecting an array of numbers with the **type** field. Then, we should also instruct Apify on which UI component to render for this input property. In our case, we have an array of numbers, which means we should use the **json** editor type that we discovered in the ["array" section](/platform/actors/development/input-output-schemas/input-schema/specification/v1#array) of the input schema documentation. We could also use **stringList**, but then we'd have to parse out the numbers from the strings. ```json { @@ -106,8 +106,8 @@ Here is what the input schema we wrote will render on the platform: Later on, we'll be building more complex input schemas, as well as discussing how to write quality input schemas that allow the user to understand the Actor. -It's not expected to memorize all of the fields that properties can take or the different editor types available, which is why it's always good to reference the [input schema documentation](/platform/actors/development/actor-definition/input-schema) when writing a schema. +It's not expected to memorize all of the fields that properties can take or the different editor types available, which is why it's always good to reference the [input schema documentation](/platform/actors/development/input-output-schemas/input-schema) when writing a schema. ## Next up {#next} -In the [next lesson](/platform/actors/development/actor-definition/dataset-schema), we'll learn how to generate an appealing Overview table to display our Actor's results in real time, so users can get immediate feedback about the data being extracted. +In the [next lesson](/platform/actors/development/input-output-schemas/dataset-schema), we'll learn how to generate an appealing Overview table to display our Actor's results in real time, so users can get immediate feedback about the data being extracted. diff --git a/sources/academy/platform/deploying_your_code/output_schema.md b/sources/academy/platform/deploying_your_code/output_schema.md index ed3c6156ee..7c98f5d9dc 100644 --- a/sources/academy/platform/deploying_your_code/output_schema.md +++ b/sources/academy/platform/deploying_your_code/output_schema.md @@ -11,7 +11,7 @@ slug: /deploying-your-code/dataset-schema The dataset schema generates an interface that enables users to instantly preview their Actor results in real time. -![Dataset Schema](../../../platform/actors/development/actor_definition/images/output-schema-example.png) +![Dataset Schema](../../../platform/actors/development/input_output_schemas/images/output-schema-example.png) In this quick tutorial, you will learn how to set up an output tab for your own Actor. @@ -162,7 +162,7 @@ Great! Now that everything is set up, it's time to run the Actor and admire your :::tip Additional resources -Visit the [dataset schema documentation](/platform/actors/development/actor-definition/dataset-schema) for more detailed information about how to implement this feature. +Visit the [dataset schema documentation](/platform/actors/development/input-output-schemas/dataset-schema) for more detailed information about how to implement this feature. ::: diff --git a/sources/academy/platform/getting_started/creating_actors.md b/sources/academy/platform/getting_started/creating_actors.md index a1c6505b43..e2ccbaa24d 100644 --- a/sources/academy/platform/getting_started/creating_actors.md +++ b/sources/academy/platform/getting_started/creating_actors.md @@ -56,7 +56,7 @@ You will end up on a template detail page where you can see all the important in ### Using the template in the Web IDE {#web-ide} -By clicking **Use this template** button you will create the Actor in Apify Console and you will be moved to the **Code** tab with the [Web IDE](/platform/actors/development/quick-start/web-ide) where you can see the code of the template and start editing it. +By clicking **Use this template** button you will create the Actor in Apify Console and you will be moved to the **Code** tab with the [Web IDE](/platform/get-started/build-an-actor/web-ide) where you can see the code of the template and start editing it. :::tip Web IDE diff --git a/sources/academy/platform/getting_started/inputs_outputs.md b/sources/academy/platform/getting_started/inputs_outputs.md index 1b942658df..e1903d4e69 100644 --- a/sources/academy/platform/getting_started/inputs_outputs.md +++ b/sources/academy/platform/getting_started/inputs_outputs.md @@ -69,7 +69,7 @@ This step isn't necessary, as the Actor will still be able to take input in JSON :::tip Learn more -If you're interested in learning more about how the code works, and what the `INPUT_SCHEMA.json` means, read about [inputs](/sdk/js/docs/examples/accept-user-input) and [adding data to a dataset](/sdk/js/docs/examples/add-data-to-dataset) in the Apify SDK documentation, and refer to the [input schema docs](/platform/actors/development/actor-definition/input-schema/specification/v1#integer). +If you're interested in learning more about how the code works, and what the `INPUT_SCHEMA.json` means, read about [inputs](/sdk/js/docs/examples/accept-user-input) and [adding data to a dataset](/sdk/js/docs/examples/add-data-to-dataset) in the Apify SDK documentation, and refer to the [input schema docs](/platform/actors/development/input-output-schemas/input-schema/specification/v1#integer). ::: 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 ac643b365b..b26bb79bd3 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 @@ -10,7 +10,7 @@ You need to regularly grab SERP data about your target keywords? Apify provides ![Apify Google SERP API](./images/gserp-api.png) -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](/platform/schedules#setting-up-a-new-schedule). +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](/platform/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/acts/TASK_NAME_OR_ID/runs?token=YOUR_TOKEN`. Include any required input in a JSON object in the request's body. diff --git a/sources/academy/webscraping/scraping_basics_javascript/13_platform.md b/sources/academy/webscraping/scraping_basics_javascript/13_platform.md index 4bb57a84e8..628a9ff97d 100644 --- a/sources/academy/webscraping/scraping_basics_javascript/13_platform.md +++ b/sources/academy/webscraping/scraping_basics_javascript/13_platform.md @@ -191,7 +191,7 @@ We don't need to click buttons to download the data. It's possible to retrieve i Now that our scraper is deployed, let's automate its execution. In the Apify web interface, we'll go to [Schedules](https://console.apify.com/schedules). Let's click **Create new**, review the periodicity (default: daily), and specify the Actor to run. Then we'll click **Enable**—that's it! -From now on, the Actor will execute daily. We can inspect each run, view logs, check collected data, [monitor stats and charts](https://docs.apify.com/platform/monitoring), and even set up alerts. +From now on, the Actor will execute daily. We can inspect each run, view logs, check collected data, [monitor stats and charts](https://docs.apify.com/platform/actors/running/monitoring), and even set up alerts. ![Schedule detail page](../scraping_basics/images/actor-schedule.webp) diff --git a/sources/academy/webscraping/scraping_basics_python/13_platform.md b/sources/academy/webscraping/scraping_basics_python/13_platform.md index aaa287bdbc..f1b7294f23 100644 --- a/sources/academy/webscraping/scraping_basics_python/13_platform.md +++ b/sources/academy/webscraping/scraping_basics_python/13_platform.md @@ -274,7 +274,7 @@ We don't need to click buttons to download the data. It's possible to retrieve i Now that our scraper is deployed, let's automate its execution. In the Apify web interface, we'll go to [Schedules](https://console.apify.com/schedules). Let's click **Create new**, review the periodicity (default: daily), and specify the Actor to run. Then we'll click **Enable**—that's it! -From now on, the Actor will execute daily. We can inspect each run, view logs, check collected data, [monitor stats and charts](https://docs.apify.com/platform/monitoring), and even set up alerts. +From now on, the Actor will execute daily. We can inspect each run, view logs, check collected data, [monitor stats and charts](https://docs.apify.com/platform/actors/running/monitoring), and even set up alerts. ![Schedule detail page](../scraping_basics/images/actor-schedule.webp) diff --git a/sources/platform/collaboration/access_rights.md b/sources/platform/account/access_rights.md similarity index 94% rename from sources/platform/collaboration/access_rights.md rename to sources/platform/account/access_rights.md index 219c9b43cd..135e9869d2 100644 --- a/sources/platform/collaboration/access_rights.md +++ b/sources/platform/account/access_rights.md @@ -1,9 +1,8 @@ --- title: Access rights description: Manage permissions for your private resources such as Actors, Actor runs, and storages. Allow other users to read, run, modify, or build new versions. -sidebar_position: 12 -category: platform -slug: /collaboration/access-rights +sidebar_position: 7 +slug: /account/access-rights --- **Manage permissions for your private resources such as Actors, Actor runs, and storages. Allow other users to read, run, modify, or build new versions.** diff --git a/sources/platform/console/billing.md b/sources/platform/account/billing.md similarity index 99% rename from sources/platform/console/billing.md rename to sources/platform/account/billing.md index 223f937cff..2c53396518 100644 --- a/sources/platform/console/billing.md +++ b/sources/platform/account/billing.md @@ -2,8 +2,7 @@ title: Billing description: The Billings page is the central place for all information regarding your invoices, billing information regarding current usage, historical usage, subscriptions & limits. sidebar_position: 3 -category: platform -slug: /console/billing +slug: /account/billing --- **The Billings page is the central place for all information regarding your invoices, billing information regarding usage in the current billing cycle, historical usage, subscriptions & limits.** diff --git a/sources/platform/console/index.md b/sources/platform/account/console.md similarity index 79% rename from sources/platform/console/index.md rename to sources/platform/account/console.md index 78293381f6..f16ede6215 100644 --- a/sources/platform/console/index.md +++ b/sources/platform/account/console.md @@ -1,9 +1,8 @@ --- -title: Apify Console +title: Console overview description: Learn about Apify Console's easy account creation and user-friendly homepage for efficient web scraping management. sidebar_position: 1 -category: platform -slug: /console +slug: /account/console --- **Learn about Apify Console's easy account creation and user-friendly homepage for efficient web scraping management.** @@ -24,7 +23,7 @@ This is the most common way of creating an account. You just need to provide you After you click the **Sign up** button, we will send you a verification email. The email contains a link that you need to click on or copy to your browser to proceed to automated email verification. After we verify your email, you will proceed to Apify Console. :::info CAPTCHA -We are using Google reCaptcha to prevent spam accounts. Usually, you will not see it, but if Google evaluates your browser as suspicious, they will ask you to solve a reCaptcha before we create your account and send you the verification email. +We are using Google reCAPTCHA to prevent spam accounts. Usually, you will not see it, but if Google evaluates your browser as suspicious, they will ask you to solve a reCAPTCHA before we create your account and send you the verification email. ::: If you did not receive the email, you can visit the [sign-in page](https://console.apify.com/sign-in). There, you will either proceed to our verification page right away, or you can sign in and will be redirected afterward. On the verification page, you can click on the **Resend verification email** button to send the email again. @@ -94,34 +93,34 @@ You can also navigate Apify Console via keyboard shortcuts.
    Keyboard Shortcuts -|Shortcut| Tab | -|:---|:----| -|Show shortcuts | Shift? | -|Home| GH | -|Store| GO | -|Actors| GA | -|Development| GD | -|Saved tasks| GT | -|Runs| GR | -|Integrations | GI | -|Schedules| GU | -|Storage| GE | -|Proxy| GP | -|Settings| GS | -|Billing| GB | +| Shortcut | Tab | +| :--- | :--- | +| Show shortcuts | Shift? | +| Home | GH | +| Store | GO | +| Actors | GA | +| Development | GD | +| Saved tasks | GT | +| Runs | GR | +| Integrations | GI | +| Schedules | GU | +| Storage | GE | +| Proxy | GP | +| Settings | GS | +| Billing | GB |
    | Tab name | Description | -|:---|:---| -| [Apify Store](/platform/console/store)| Search for Actors that suit your web-scraping needs. | -| [Actors](/platform/actors)| View recent & bookmarked Actors. | -| [Runs](/platform/actors/running/runs-and-builds)| View your recent runs. | -| [Saved tasks](/platform/actors/running/tasks)| View your saved tasks. | -| [Schedules](/platform/schedules)| Schedule Actor runs & tasks to run at specified time. | -| [Integrations](/platform/integrations)| View your integrations. | -| [Development](/platform/actors/development)| • My Actors - See Actors developed by you.
    • Insights - see analytics for your Actors.
    • Messaging - check on issues reported in your Actors or send emails to users of your Actors. | -| [Proxy](/platform/proxy)| View your proxy usage & credentials | -| [Storage](/platform/storage)| View stored results of your runs in various data formats. | -| [Billing](/platform/console/billing)| Billing information, statistics and invoices. | -| [Settings](/platform/console/settings)| Settings of your account. | +| :--- | :--- | +| [Apify Store](/platform/account/store) | Search for Actors that suit your web-scraping needs. | +| [Actors](/platform/actors) | View recent & bookmarked Actors. | +| [Runs](/platform/actors/running/runs-and-builds) | View your recent runs. | +| [Saved tasks](/platform/actors/running/tasks) | View your saved tasks. | +| [Schedules](/platform/actors/running/schedules) | Schedule Actor runs & tasks to run at specified time. | +| [Integrations](/platform/integrations) | View your integrations. | +| [Development](/platform/actors/development) | • My Actors - See Actors developed by you.
    • Insights - see analytics for your Actors.
    • Messaging - check on issues reported in your Actors or send emails to users of your Actors. | +| [Proxy](/platform/proxy) | View your proxy usage & credentials | +| [Storage](/platform/storage) | View stored results of your runs in various data formats. | +| [Billing](/platform/account/billing) | Billing information, statistics and invoices. | +| [Settings](/platform/account/settings) | Settings of your account. | diff --git a/sources/platform/collaboration/general-resource-access.md b/sources/platform/account/general-resource-access.md similarity index 99% rename from sources/platform/collaboration/general-resource-access.md rename to sources/platform/account/general-resource-access.md index 5e3d695b74..38c2d8f037 100644 --- a/sources/platform/collaboration/general-resource-access.md +++ b/sources/platform/account/general-resource-access.md @@ -1,9 +1,8 @@ --- title: General resource access description: Control how Apify resources are shared. Set default access (Anyone with ID can read or Restricted), and learn about link sharing, exceptions, and pre-signed URLs. -sidebar_position: 1 -category: platform -slug: /collaboration/general-resource-access +sidebar_position: 8 +slug: /account/general-resource-access --- Some resources, like storages, Actor runs or Actor builds, can be shared simply by sending their unique resource ID or Console link and the recipient can then view the data in Console or fetch it via API without needing an API token. This is very useful for ad-hoc collaboration, integrating third party tools that connect to data in your Apify account or quick prototypes. @@ -305,7 +304,7 @@ const recordUrl = await storeClient.getRecordPublicUrl(recordKey); await Actor.pushData({ recordUrl }); ``` -To learn more about generating pre-signed URLs, refer to the section [Sharing restricted resources with pre-signed URLs](/platform/collaboration/general-resource-access#pre-signed-urls). +To learn more about generating pre-signed URLs, refer to the section [Sharing restricted resources with pre-signed URLs](/platform/account/general-resource-access#pre-signed-urls). :::note Using Console URLs diff --git a/sources/platform/collaboration/images/access-rights/access-rights.png b/sources/platform/account/images/access-rights/access-rights.png similarity index 100% rename from sources/platform/collaboration/images/access-rights/access-rights.png rename to sources/platform/account/images/access-rights/access-rights.png diff --git a/sources/platform/console/images/apify-console-homepage.png b/sources/platform/account/images/apify-console-homepage.png similarity index 100% rename from sources/platform/console/images/apify-console-homepage.png rename to sources/platform/account/images/apify-console-homepage.png diff --git a/sources/platform/console/images/console-account-two-factor-disabled.png b/sources/platform/account/images/console-account-two-factor-disabled.png similarity index 100% rename from sources/platform/console/images/console-account-two-factor-disabled.png rename to sources/platform/account/images/console-account-two-factor-disabled.png diff --git a/sources/platform/console/images/console-account-two-factor-enabled.png b/sources/platform/account/images/console-account-two-factor-enabled.png similarity index 100% rename from sources/platform/console/images/console-account-two-factor-enabled.png rename to sources/platform/account/images/console-account-two-factor-enabled.png diff --git a/sources/platform/console/images/console-actors-recently-used.png b/sources/platform/account/images/console-actors-recently-used.png similarity index 100% rename from sources/platform/console/images/console-actors-recently-used.png rename to sources/platform/account/images/console-actors-recently-used.png diff --git a/sources/platform/console/images/console-actors-runs.png b/sources/platform/account/images/console-actors-runs.png similarity index 100% rename from sources/platform/console/images/console-actors-runs.png rename to sources/platform/account/images/console-actors-runs.png diff --git a/sources/platform/console/images/console-billing-current-period.png b/sources/platform/account/images/console-billing-current-period.png similarity index 100% rename from sources/platform/console/images/console-billing-current-period.png rename to sources/platform/account/images/console-billing-current-period.png diff --git a/sources/platform/console/images/console-billing-historical-usage-by-actors.png b/sources/platform/account/images/console-billing-historical-usage-by-actors.png similarity index 100% rename from sources/platform/console/images/console-billing-historical-usage-by-actors.png rename to sources/platform/account/images/console-billing-historical-usage-by-actors.png diff --git a/sources/platform/console/images/console-billing-historical-usage.png b/sources/platform/account/images/console-billing-historical-usage.png similarity index 100% rename from sources/platform/console/images/console-billing-historical-usage.png rename to sources/platform/account/images/console-billing-historical-usage.png diff --git a/sources/platform/console/images/console-billing-invoices.png b/sources/platform/account/images/console-billing-invoices.png similarity index 100% rename from sources/platform/console/images/console-billing-invoices.png rename to sources/platform/account/images/console-billing-invoices.png diff --git a/sources/platform/console/images/console-billing-limits.png b/sources/platform/account/images/console-billing-limits.png similarity index 100% rename from sources/platform/console/images/console-billing-limits.png rename to sources/platform/account/images/console-billing-limits.png diff --git a/sources/platform/console/images/console-billing-pricing.png b/sources/platform/account/images/console-billing-pricing.png similarity index 100% rename from sources/platform/console/images/console-billing-pricing.png rename to sources/platform/account/images/console-billing-pricing.png diff --git a/sources/platform/console/images/console-billing-subscription.png b/sources/platform/account/images/console-billing-subscription.png similarity index 100% rename from sources/platform/console/images/console-billing-subscription.png rename to sources/platform/account/images/console-billing-subscription.png diff --git a/sources/platform/console/images/console-email-verification-page.png b/sources/platform/account/images/console-email-verification-page.png similarity index 100% rename from sources/platform/console/images/console-email-verification-page.png rename to sources/platform/account/images/console-email-verification-page.png diff --git a/sources/platform/console/images/console-forgotten-password-page.png b/sources/platform/account/images/console-forgotten-password-page.png similarity index 100% rename from sources/platform/console/images/console-forgotten-password-page.png rename to sources/platform/account/images/console-forgotten-password-page.png diff --git a/sources/platform/console/images/console-login.png b/sources/platform/account/images/console-login.png similarity index 100% rename from sources/platform/console/images/console-login.png rename to sources/platform/account/images/console-login.png diff --git a/sources/platform/console/images/console-reset-password-page.png b/sources/platform/account/images/console-reset-password-page.png similarity index 100% rename from sources/platform/console/images/console-reset-password-page.png rename to sources/platform/account/images/console-reset-password-page.png diff --git a/sources/platform/console/images/console-setup-two-factor-auth-key.png b/sources/platform/account/images/console-setup-two-factor-auth-key.png similarity index 100% rename from sources/platform/console/images/console-setup-two-factor-auth-key.png rename to sources/platform/account/images/console-setup-two-factor-auth-key.png diff --git a/sources/platform/console/images/console-sign-in-form.png b/sources/platform/account/images/console-sign-in-form.png similarity index 100% rename from sources/platform/console/images/console-sign-in-form.png rename to sources/platform/account/images/console-sign-in-form.png diff --git a/sources/platform/console/images/console-sign-in-methods-section.png b/sources/platform/account/images/console-sign-in-methods-section.png similarity index 100% rename from sources/platform/console/images/console-sign-in-methods-section.png rename to sources/platform/account/images/console-sign-in-methods-section.png diff --git a/sources/platform/console/images/console-sign-up-form.png b/sources/platform/account/images/console-sign-up-form.png similarity index 100% rename from sources/platform/console/images/console-sign-up-form.png rename to sources/platform/account/images/console-sign-up-form.png diff --git a/sources/platform/console/images/console-signup.png b/sources/platform/account/images/console-signup.png similarity index 100% rename from sources/platform/console/images/console-signup.png rename to sources/platform/account/images/console-signup.png diff --git a/sources/platform/console/images/console-store.png b/sources/platform/account/images/console-store.png similarity index 100% rename from sources/platform/console/images/console-store.png rename to sources/platform/account/images/console-store.png diff --git a/sources/platform/console/images/console-two-factor-app-setup.png b/sources/platform/account/images/console-two-factor-app-setup.png similarity index 100% rename from sources/platform/console/images/console-two-factor-app-setup.png rename to sources/platform/account/images/console-two-factor-app-setup.png diff --git a/sources/platform/console/images/console-two-factor-auth-disable.png b/sources/platform/account/images/console-two-factor-auth-disable.png similarity index 100% rename from sources/platform/console/images/console-two-factor-auth-disable.png rename to sources/platform/account/images/console-two-factor-auth-disable.png diff --git a/sources/platform/console/images/console-two-factor-authentication.png b/sources/platform/account/images/console-two-factor-authentication.png similarity index 100% rename from sources/platform/console/images/console-two-factor-authentication.png rename to sources/platform/account/images/console-two-factor-authentication.png diff --git a/sources/platform/console/images/console-two-factor-recovery-settings-request.png b/sources/platform/account/images/console-two-factor-recovery-settings-request.png similarity index 100% rename from sources/platform/console/images/console-two-factor-recovery-settings-request.png rename to sources/platform/account/images/console-two-factor-recovery-settings-request.png diff --git a/sources/platform/console/images/console-two-factor-recovery-settings-revealed.png b/sources/platform/account/images/console-two-factor-recovery-settings-revealed.png similarity index 100% rename from sources/platform/console/images/console-two-factor-recovery-settings-revealed.png rename to sources/platform/account/images/console-two-factor-recovery-settings-revealed.png diff --git a/sources/platform/console/images/console-two-factor-recovery-setup.png b/sources/platform/account/images/console-two-factor-recovery-setup.png similarity index 100% rename from sources/platform/console/images/console-two-factor-recovery-setup.png rename to sources/platform/account/images/console-two-factor-recovery-setup.png diff --git a/sources/platform/console/images/console-two-factor-use-recovery-code.png b/sources/platform/account/images/console-two-factor-use-recovery-code.png similarity index 100% rename from sources/platform/console/images/console-two-factor-use-recovery-code.png rename to sources/platform/account/images/console-two-factor-use-recovery-code.png diff --git a/sources/platform/collaboration/images/general-resouce-access/account-setting.png b/sources/platform/account/images/general-resouce-access/account-setting.png similarity index 100% rename from sources/platform/collaboration/images/general-resouce-access/account-setting.png rename to sources/platform/account/images/general-resouce-access/account-setting.png diff --git a/sources/platform/collaboration/images/general-resouce-access/copy-record-url-kv-store.png b/sources/platform/account/images/general-resouce-access/copy-record-url-kv-store.png similarity index 100% rename from sources/platform/collaboration/images/general-resouce-access/copy-record-url-kv-store.png rename to sources/platform/account/images/general-resouce-access/copy-record-url-kv-store.png diff --git a/sources/platform/collaboration/images/general-resouce-access/copy-shareable-link.png b/sources/platform/account/images/general-resouce-access/copy-shareable-link.png similarity index 100% rename from sources/platform/collaboration/images/general-resouce-access/copy-shareable-link.png rename to sources/platform/account/images/general-resouce-access/copy-shareable-link.png diff --git a/sources/platform/collaboration/images/general-resouce-access/creating-actor-issue.png b/sources/platform/account/images/general-resouce-access/creating-actor-issue.png similarity index 100% rename from sources/platform/collaboration/images/general-resouce-access/creating-actor-issue.png rename to sources/platform/account/images/general-resouce-access/creating-actor-issue.png diff --git a/sources/platform/collaboration/images/general-resouce-access/share-resource-dialog.png b/sources/platform/account/images/general-resouce-access/share-resource-dialog.png similarity index 100% rename from sources/platform/collaboration/images/general-resouce-access/share-resource-dialog.png rename to sources/platform/account/images/general-resouce-access/share-resource-dialog.png diff --git a/sources/platform/images/limits/usage-limits.png b/sources/platform/account/images/limits/usage-limits.png similarity index 100% rename from sources/platform/images/limits/usage-limits.png rename to sources/platform/account/images/limits/usage-limits.png diff --git a/sources/platform/collaboration/images/organizations/configure-permissions.png b/sources/platform/account/images/organizations/configure-permissions.png similarity index 100% rename from sources/platform/collaboration/images/organizations/configure-permissions.png rename to sources/platform/account/images/organizations/configure-permissions.png diff --git a/sources/platform/collaboration/images/organizations/convert-to-organization.png b/sources/platform/account/images/organizations/convert-to-organization.png similarity index 100% rename from sources/platform/collaboration/images/organizations/convert-to-organization.png rename to sources/platform/account/images/organizations/convert-to-organization.png diff --git a/sources/platform/collaboration/images/organizations/create-new-org.png b/sources/platform/account/images/organizations/create-new-org.png similarity index 100% rename from sources/platform/collaboration/images/organizations/create-new-org.png rename to sources/platform/account/images/organizations/create-new-org.png diff --git a/sources/platform/collaboration/images/organizations/integrations.png b/sources/platform/account/images/organizations/integrations.png similarity index 100% rename from sources/platform/collaboration/images/organizations/integrations.png rename to sources/platform/account/images/organizations/integrations.png diff --git a/sources/platform/collaboration/images/organizations/members.png b/sources/platform/account/images/organizations/members.png similarity index 100% rename from sources/platform/collaboration/images/organizations/members.png rename to sources/platform/account/images/organizations/members.png diff --git a/sources/platform/collaboration/images/organizations/my-organizations.png b/sources/platform/account/images/organizations/my-organizations.png similarity index 100% rename from sources/platform/collaboration/images/organizations/my-organizations.png rename to sources/platform/account/images/organizations/my-organizations.png diff --git a/sources/platform/collaboration/images/organizations/roles.png b/sources/platform/account/images/organizations/roles.png similarity index 100% rename from sources/platform/collaboration/images/organizations/roles.png rename to sources/platform/account/images/organizations/roles.png diff --git a/sources/platform/collaboration/images/organizations/switch-to-organization.png b/sources/platform/account/images/organizations/switch-to-organization.png similarity index 100% rename from sources/platform/collaboration/images/organizations/switch-to-organization.png rename to sources/platform/account/images/organizations/switch-to-organization.png diff --git a/sources/platform/account/index.md b/sources/platform/account/index.md new file mode 100644 index 0000000000..d5a739aba4 --- /dev/null +++ b/sources/platform/account/index.md @@ -0,0 +1,6 @@ +--- +title: Account +sidebar_position: 0 +slug: /account +description: Manage your Apify account, billing, organizations, and security settings. +--- diff --git a/sources/platform/limits.md b/sources/platform/account/limits.md similarity index 96% rename from sources/platform/limits.md rename to sources/platform/account/limits.md index 8fe52e9a7b..7c1fd9a6e4 100644 --- a/sources/platform/limits.md +++ b/sources/platform/account/limits.md @@ -1,9 +1,8 @@ --- title: Limits description: Learn the Apify platform's resource capability and limitations such as max memory, disk size and number of Actors and tasks per user. -sidebar_position: 16 -category: platform -slug: /limits +sidebar_position: 11 +slug: /account/limits --- **Learn the Apify platform's resource capability and limitations such as max memory, disk size and number of Actors and tasks per user.** @@ -133,7 +132,7 @@ The tables below demonstrate the Apify platform's default resource limits. For A ## Usage limit -The Apify platform also introduces usage limits based on the billing plan to protect users from accidental overspending. To learn more about usage limits, head over to the [Limits](./console/billing.md#limits) section of our docs. +The Apify platform also introduces usage limits based on the billing plan to protect users from accidental overspending. To learn more about usage limits, head over to the [Limits](./billing.md#limits) section of our docs. View these limits and adjust your maximum usage limit in [Apify Console](https://console.apify.com/billing#/limits): diff --git a/sources/platform/collaboration/list_of_permissions.md b/sources/platform/account/list_of_permissions.md similarity index 98% rename from sources/platform/collaboration/list_of_permissions.md rename to sources/platform/account/list_of_permissions.md index 9b7d3b227e..32d2f49a49 100644 --- a/sources/platform/collaboration/list_of_permissions.md +++ b/sources/platform/account/list_of_permissions.md @@ -1,8 +1,8 @@ --- title: List of permissions description: Learn about the access rights you can grant to other users. See a list of all access options for Apify resources such as Actors, Actor runs/tasks and storage. -sidebar_position: 12.2 -slug: /collaboration/list-of-permissions +sidebar_position: 9 +slug: /account/list-of-permissions --- **Learn about the access rights you can grant to other users. See a list of all access options for Apify resources such as Actors, Actor runs/tasks and storage.** @@ -80,7 +80,7 @@ To learn about Apify Proxy, see its [documentation](../proxy/index.md). ## User permissions -Permissions that can be granted to members of organizations. To learn about the organization account, see its [documentation](./organization_account/index.md). +Permissions that can be granted to members of organizations. To learn about the organization account, see its [documentation](./organization/index.md). | Permission | Description | |---------------------|-----------------------------------------------------------------------| diff --git a/sources/platform/collaboration/organization_account/how_to_use.md b/sources/platform/account/organization/how_to_use.md similarity index 98% rename from sources/platform/collaboration/organization_account/how_to_use.md rename to sources/platform/account/organization/how_to_use.md index ee54ae198b..20cd66feb9 100644 --- a/sources/platform/collaboration/organization_account/how_to_use.md +++ b/sources/platform/account/organization/how_to_use.md @@ -2,7 +2,7 @@ title: Using the organization account description: Learn to use and manage your organization account using the Apify Console or API. View the organizations you are in and manage your memberships. sidebar_position: 2 -slug: /collaboration/organization-account/how-to-use +slug: /account/organization/how-to-use sidebar_label: How to use --- diff --git a/sources/platform/collaboration/organization_account/index.md b/sources/platform/account/organization/index.md similarity index 98% rename from sources/platform/collaboration/organization_account/index.md rename to sources/platform/account/organization/index.md index f38e1c34f4..a16bb66a72 100644 --- a/sources/platform/collaboration/organization_account/index.md +++ b/sources/platform/account/organization/index.md @@ -1,8 +1,8 @@ --- title: Organization account description: Create a specialized account for your organization to encourage collaboration and manage permissions. Convert an existing account, or create one from scratch. -sidebar_position: 12.1 -slug: /collaboration/organization-account +sidebar_position: 6 +slug: /account/organization --- **Create a specialized account for your organization to encourage collaboration and manage permissions. Convert an existing account, or create one from scratch.** diff --git a/sources/platform/collaboration/organization_account/setup.md b/sources/platform/account/organization/setup.md similarity index 98% rename from sources/platform/collaboration/organization_account/setup.md rename to sources/platform/account/organization/setup.md index ab93a7b29e..f8be306c5f 100644 --- a/sources/platform/collaboration/organization_account/setup.md +++ b/sources/platform/account/organization/setup.md @@ -2,7 +2,7 @@ title: Setup description: Configure your organization account by inviting new members and assigning their roles. Manage team members' access permissions to the organization's resources. sidebar_position: 1 -slug: /collaboration/organization-account/setup +slug: /account/organization/setup --- **Configure your organization account by inviting new members and assigning their roles. Manage team members' access permissions to the organization's resources.** diff --git a/sources/platform/console/settings.md b/sources/platform/account/settings.md similarity index 98% rename from sources/platform/console/settings.md rename to sources/platform/account/settings.md index ff829d36cb..112c562483 100644 --- a/sources/platform/console/settings.md +++ b/sources/platform/account/settings.md @@ -2,8 +2,7 @@ title: Account settings description: Learn how to manage your Apify account, configure integrations, create and manage organizations, and set notification preferences in the Settings tab. sidebar_position: 4 -category: platform -slug: /console/settings +slug: /account/settings --- **Learn how to manage your Apify account, configure integrations, create and manage organizations, and set notification preferences in the Settings tab.** diff --git a/sources/platform/console/store.md b/sources/platform/account/store.md similarity index 96% rename from sources/platform/console/store.md rename to sources/platform/account/store.md index fd38e87c49..0dcaf58431 100644 --- a/sources/platform/console/store.md +++ b/sources/platform/account/store.md @@ -2,8 +2,7 @@ title: Apify Store description: Explore Apify Store, browse and select Actors, search by criteria, sort by relevance, and adjust settings for immediate or future runs. sidebar_position: 2 -category: platform -slug: /console/store +slug: /account/store --- **Explore Apify Store, browse and select Actors, search by criteria, sort by relevance, and adjust settings for immediate or future runs.** diff --git a/sources/platform/console/two-factor-authentication.md b/sources/platform/account/two-factor-authentication.md similarity index 99% rename from sources/platform/console/two-factor-authentication.md rename to sources/platform/account/two-factor-authentication.md index 0061735f77..67632579e5 100644 --- a/sources/platform/console/two-factor-authentication.md +++ b/sources/platform/account/two-factor-authentication.md @@ -2,8 +2,7 @@ title: Two-factor authentication setup description: Learn about Apify Console's two-factor authentication process and how to set it up. sidebar_position: 5 -category: platform -slug: /console/two-factor-authentication +slug: /account/two-factor-authentication --- **Learn about Apify Console's account two-factor authentication process and how to set it up.** diff --git a/sources/platform/actors/development/actor_definition/actor_json.md b/sources/platform/actors/development/actor_definition/actor_json.md index 1cd2cfb3a6..8c25fd711e 100644 --- a/sources/platform/actors/development/actor_definition/actor_json.md +++ b/sources/platform/actors/development/actor_definition/actor_json.md @@ -82,9 +82,9 @@ Actor `name`, `version`, `buildTag`, and `environmentVariables` are currently on | `dockerfile` | Optional | The path to the Dockerfile to be used for building the Actor on the platform. If not specified, the system will search for Dockerfiles in the `.actor/Dockerfile` and `Dockerfile` paths, in that order. Refer to the [Dockerfile](./docker.md) section for more information. | | `dockerContextDir` | Optional | The path to the directory to be used as the Docker context when building the Actor. The path is relative to the location of the `actor.json` file. This property is useful for monorepos containing multiple Actors. Refer to the [Actor monorepos](../deployment/source_types.md#actor-monorepos) section for more details. | | `readme` | Optional | The path to the README file to be used on the platform. If not specified, the system will look for README files in the `.actor/README.md` and `README.md` paths, in that order of preference. Check out [Apify Marketing Playbook to learn how to write a quality README files](https://apify.notion.site/How-to-create-an-Actor-README-759a1614daa54bee834ee39fe4d98bc2) guidance. | -| `input` | Optional | You can embed your [input schema](./input_schema/index.md) object directly in `actor.json` under the `input` field. You can also provide a path to a custom input schema. If not provided, the input schema at `.actor/INPUT_SCHEMA.json` or `INPUT_SCHEMA.json` is used, in this order of preference. | +| `input` | Optional | You can embed your [input schema](../input_output_schemas/input_schema.md) object directly in `actor.json` under the `input` field. You can also provide a path to a custom input schema. If not provided, the input schema at `.actor/INPUT_SCHEMA.json` or `INPUT_SCHEMA.json` is used, in this order of preference. | | `changelog` | Optional | The path to the CHANGELOG file displayed in the Information tab of the Actor in Apify Console next to Readme. If not provided, the CHANGELOG at `.actor/CHANGELOG.md` or `CHANGELOG.md` is used, in this order of preference. Your Actor doesn't need to have a CHANGELOG but it is a good practice to keep it updated for published Actors. | -| `storages.dataset` | Optional | You can define the schema of the items in your dataset under the `storages.dataset` field. This can be either an embedded object or a path to a JSON schema file. [Read more](/platform/actors/development/actor-definition/dataset-schema) about Actor dataset schemas. | +| `storages.dataset` | Optional | You can define the schema of the items in your dataset under the `storages.dataset` field. This can be either an embedded object or a path to a JSON schema file. [Read more](/platform/actors/development/input-output-schemas/dataset-schema) about Actor dataset schemas. | | `defaultMemoryMbytes` | Optional | Specifies the default amount of memory in megabytes to be used when the Actor is started. Can be an integer or a [dynamic memory expression string](./dynamic_actor_memory/index.md). | | `minMemoryMbytes` | Optional | Specifies the minimum amount of memory in megabytes required by the Actor to run. Requires an _integer_ value. If both `minMemoryMbytes` and `maxMemoryMbytes` are set, then `minMemoryMbytes` must be equal or lower than `maxMemoryMbytes`. Refer to the [Usage and resources](https://docs.apify.com/platform/actors/running/usage-and-resources#memory) for more details about memory allocation. | | `maxMemoryMbytes` | Optional | Specifies the maximum amount of memory in megabytes required by the Actor to run. It can be used to control the costs of run, especially when developing pay per result Actors. Requires an _integer_ value. Refer to the [Usage and resources](https://docs.apify.com/platform/actors/running/usage-and-resources#memory) for more details about memory allocation. | diff --git a/sources/platform/actors/development/actor_definition/index.md b/sources/platform/actors/development/actor_definition/index.md index 00bfcd895f..3dd6e2d96e 100644 --- a/sources/platform/actors/development/actor_definition/index.md +++ b/sources/platform/actors/development/actor_definition/index.md @@ -18,13 +18,13 @@ Actors have the following elements: - The main **[actor.json](./actor_json.md)** file contains **metadata** such as the Actor name, description, author, version, and links pointing to the other definition files below. - **[Dockerfile](./docker.md)** which specifies where is the Actor's source code, how to build it, and run it. - **Documentation** in the form of a **README.md** file. -- **[Input](./input_schema/index.md)** and **[dataset schemas](/platform/actors/development/actor-definition/dataset-schema)** that describe what input the Actor requires and what results it produces. +- **[Input](../input_output_schemas/input_schema.md)** and **[dataset schemas](/platform/actors/development/input-output-schemas/dataset-schema)** that describe what input the Actor requires and what results it produces. - Access to an out-of-box **[storage](../../../storage/index.md)** system for Actor data, results, and files. The documentation and the input/dataset schemas make it possible for people to easily understand what the Actor does, enter the required inputs both in the user interface or API, and integrate the Actor's results with their other workflows. Actors can easily call and interact with each other, enabling building more complex systems on top of simple ones. -The Apify platform provides an open [API](/api/v2), cron-style [scheduler](../../schedules), [webhooks](../../../integrations/programming/webhooks/index.md), and [integrations](../../integrations) to services such as Zapier or Make, which make it easy for users to integrate Actors with their existing workflows. Anyone is welcome to [publish Actors](/platform/actors/publishing) in [Apify Store](https://apify.com/store), and you can even [monetize your Actors](/platform/actors/publishing/monetize). +The Apify platform provides an open [API](/api/v2), cron-style [scheduler](/platform/actors/running/schedules), [webhooks](../../../integrations/api-and-webhooks/webhooks/index.md), and [integrations](../../integrations) to services such as Zapier or Make, which make it easy for users to integrate Actors with their existing workflows. Anyone is welcome to [publish Actors](/platform/actors/publishing) in [Apify Store](https://apify.com/store), and you can even [monetize your Actors](/platform/actors/publishing/monetize). -Actors can be developed and run locally and then easily deployed to the Apify platform using the [Apify CLI](/cli) or a [GitHub integration](../../../integrations/programming/github.md). For more details, see the [Deployment](../deployment/index.md) section. +Actors can be developed and run locally and then easily deployed to the Apify platform using the [Apify CLI](/cli) or a [GitHub integration](../../../integrations/api-and-webhooks/github.md). For more details, see the [Deployment](../deployment/index.md) section. > **To get a better idea of what Apify Actors are, visit [Apify Store](https://apify.com/store), and try out some of them!** diff --git a/sources/platform/actors/development/builds_and_runs/runs.md b/sources/platform/actors/development/builds_and_runs/runs.md index 19f9567a2a..0675808b0f 100644 --- a/sources/platform/actors/development/builds_and_runs/runs.md +++ b/sources/platform/actors/development/builds_and_runs/runs.md @@ -17,7 +17,7 @@ You can start an Actor in several ways: - Manually from the [Apify Console](https://console.apify.com/actors) UI - Via the [Apify API](/api/v2/act-runs-post) -- Using the [Scheduler](../../../schedules.md) provided by the Apify platform +- Using the [Scheduler](../../running/schedules.md) provided by the Apify platform - By one of the available [integrations](../../../integrations/index.mdx) ## Input and environment variables diff --git a/sources/platform/actors/development/deployment/source_types.md b/sources/platform/actors/development/deployment/source_types.md index f9f57408c7..b9a964f699 100644 --- a/sources/platform/actors/development/deployment/source_types.md +++ b/sources/platform/actors/development/deployment/source_types.md @@ -21,7 +21,7 @@ This section explains the various sources types available for Apify Actors and h ## Web IDE -This is the default option when your Actor's source code is hosted on the Apify platform. It offers quick previews and updates to your source code, easy file and directory browsing, and direct testing of the [`INPUT_SCHEMA.json`](/platform/actors/development/actor-definition/input-schema) on the Apify platform. +This is the default option when your Actor's source code is hosted on the Apify platform. It offers quick previews and updates to your source code, easy file and directory browsing, and direct testing of the [`INPUT_SCHEMA.json`](/platform/actors/development/input-output-schemas/input-schema) on the Apify platform. A `Dockerfile` is mandatory for all Actors. When using the default NodeJS Dockerfile, you'll typically need `main.js` for your source code and `package.json` for [npm](https://www.npmjs.com/) package configurations. diff --git a/sources/platform/actors/development/index.md b/sources/platform/actors/development/index.md index 575e4effc4..be4193d3ad 100644 --- a/sources/platform/actors/development/index.md +++ b/sources/platform/actors/development/index.md @@ -2,7 +2,7 @@ title: Actor development description: Read about the technical part of building Apify Actors. Learn to define Actor inputs, build new versions, persist Actor state, and choose base Docker images. sidebar_label: Development -sidebar_position: 7.4 +sidebar_position: 3 slug: /actors/development --- @@ -20,7 +20,7 @@ Build and publish new tools on Apify and have multiple chances to win big prizes This section will guide you through the whole story of [Actor](../index.mdx) development. -You can follow chapters sequentially from [Quick start](/platform/actors/development/quick-start), where you learn how to create your first Actor in just a few minutes, through the more technical sections describing the whole Actor model, up to the [Performance](/sources/platform/actors/development/performance.md) section, where you learn how to fine-tune your Actor to get the most out of the Apify platform. +You can follow chapters sequentially from [Quick start](/platform/get-started/build-an-actor), where you learn how to create your first Actor in just a few minutes, through the more technical sections describing the whole Actor model, up to the [Performance](/sources/platform/actors/development/performance.md) section, where you learn how to fine-tune your Actor to get the most out of the Apify platform. import Card from "@site/src/components/Card"; import CardGrid from "@site/src/components/CardGrid"; @@ -28,7 +28,7 @@ import CardGrid from "@site/src/components/CardGrid"; Currently only version 1 is available. | -| `title` | string | true | Title of the schema | -| `description` | string | false | Description of the schema | -| `collections` | Object | true | An object where each key is a collection ID and its value is a collection definition object (see below). | +| Property | Type | Required | Description | +| --- | --- | --- | --- | +| `actorKeyValueStoreSchemaVersion` | integer | true | Specifies the version of key-value store schema structure document.
    Currently only version 1 is available. | +| `title` | string | true | Title of the schema | +| `description` | string | false | Description of the schema | +| `collections` | Object | true | An object where each key is a collection ID and its value is a collection definition object (see below). | ### Collection object definition -| Property | Type | Required | Description | -|----------------|--------------|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------| -| `title` | string | true | The collection’s title, shown in the run's storage tab and in the storage detail view, where it appears as a tab for filtering records. | -| `description` | string | false | A description of the collection that appears in UI tooltips. | -| `key` | string | conditional* | Defines a single specific key that will be part of this collection. | -| `keyPrefix` | string | conditional* | Defines a prefix for keys that should be included in this collection. | -| `contentTypes` | string array | false | Allowed content types for records in this collection. Used for validation when storing data. | -| `jsonSchema` | object | false | For collections with content type `application/json`, you can define a JSON schema to validate structure.
    Uses JSON Schema Draft 07 format. | +| Property | Type | Required | Description | +| --- | --- | --- | --- | +| `title` | string | true | The collection's title, shown in the run's storage tab and in the storage detail view, where it appears as a tab for filtering records. | +| `description` | string | false | A description of the collection that appears in UI tooltips. | +| `key` | string | conditional* | Defines a single specific key that will be part of this collection. | +| `keyPrefix` | string | conditional* | Defines a prefix for keys that should be included in this collection. | +| `contentTypes` | string array | false | Allowed content types for records in this collection. Used for validation when storing data. | +| `jsonSchema` | object | false | For collections with content type `application/json`, you can define a JSON schema to validate structure.
    Uses JSON Schema Draft 07 format. | \* Either `key` or `keyPrefix` must be specified for each collection, but not both. diff --git a/sources/platform/actors/development/actor_definition/output_schema/index.md b/sources/platform/actors/development/input_output_schemas/output_schema.md similarity index 96% rename from sources/platform/actors/development/actor_definition/output_schema/index.md rename to sources/platform/actors/development/input_output_schemas/output_schema.md index d4709248db..30bb449ce5 100644 --- a/sources/platform/actors/development/actor_definition/output_schema/index.md +++ b/sources/platform/actors/development/input_output_schemas/output_schema.md @@ -1,16 +1,16 @@ --- title: Actor output schema sidebar_label: Actor output schema -sidebar_position: 4 +sidebar_position: 5 description: Learn how to define and present output of your Actor. -slug: /actors/development/actor-definition/output-schema +slug: /actors/development/input-output-schemas/output-schema --- **Learn how to define and present the output of your Actor.** --- -The Actor output schema builds upon the schemas for the [dataset](/platform/actors/development/actor-definition/dataset-schema) and [key-value store](/platform/actors/development/actor-definition/key-value-store-schema). It specifies where an Actor stores its output and defines templates for accessing that output. Apify Console uses these output definitions to display run results, and the Actor run's `GET` endpoint includes them in the output property. +The Actor output schema builds upon the schemas for the [dataset](/platform/actors/development/input-output-schemas/dataset-schema) and [key-value store](/platform/actors/development/input-output-schemas/key-value-store-schema). It specifies where an Actor stores its output and defines templates for accessing that output. Apify Console uses these output definitions to display run results, and the Actor run's `GET` endpoint includes them in the output property. ## Structure diff --git a/sources/platform/actors/development/actor_definition/input_schema/secret_input.md b/sources/platform/actors/development/input_output_schemas/secret_input.md similarity index 98% rename from sources/platform/actors/development/actor_definition/input_schema/secret_input.md rename to sources/platform/actors/development/input_output_schemas/secret_input.md index bfde32d4c9..93077484d5 100644 --- a/sources/platform/actors/development/actor_definition/input_schema/secret_input.md +++ b/sources/platform/actors/development/input_output_schemas/secret_input.md @@ -1,7 +1,7 @@ --- title: Secret input description: Learn about making some Actor input fields secret and encrypted. Ideal for passing passwords, API tokens, or login cookies to Actors. -slug: /actors/development/actor-definition/input-schema/secret-input +slug: /actors/development/input-output-schemas/input-schema/secret-input --- **Learn about making some Actor input fields secret and encrypted. Ideal for passing passwords, API tokens, or login cookies to Actors.** diff --git a/sources/platform/actors/development/actor_definition/input_schema/specification.md b/sources/platform/actors/development/input_output_schemas/specification.md similarity index 99% rename from sources/platform/actors/development/actor_definition/input_schema/specification.md rename to sources/platform/actors/development/input_output_schemas/specification.md index 9d8d43153e..84e1efc3c5 100644 --- a/sources/platform/actors/development/actor_definition/input_schema/specification.md +++ b/sources/platform/actors/development/input_output_schemas/specification.md @@ -2,7 +2,7 @@ title: Actor input schema specification sidebar_position: 2 description: Learn how to define and validate a schema for your Actor's input with code examples. Provide an autogenerated input UI for your Actor's users. -slug: /actors/development/actor-definition/input-schema/specification/v1 +slug: /actors/development/input-output-schemas/input-schema/specification/v1 toc_max_heading_level: 5 sidebar_label: Input schema specification --- @@ -965,14 +965,14 @@ Rendered input: #### Resource permissions -If your Actor runs with limited permissions, it must declare what access it needs to resources supplied via input. The `resourcePermissions` field defines which operations your Actor can perform on user-selected storages. This field is evaluated at run start and expands the Actor's [limited permissions](../../permissions/index.md) scope to access resources sent via input. +If your Actor runs with limited permissions, it must declare what access it needs to resources supplied via input. The `resourcePermissions` field defines which operations your Actor can perform on user-selected storages. This field is evaluated at run start and expands the Actor's [limited permissions](../permissions/index.md) scope to access resources sent via input. - `["READ"]` - The Actor can read from the referenced resources. - `["READ", "WRITE"]` - The Actor can read from and write to the referenced resources. :::note Runtime behavior -This setting defines runtime access only and doesn't change field visibility or whether the field is required in the UI. For array fields (`type: array`), the same permissions apply to each selected resource. Your Actor's run will fail with an insufficient-permissions error if it attempts an operation without the required permission, such as writing with read-only access. Users can see the required permissions in the [input field's tooltip](../../../running/permissions.md#recognizing-permission-levels-in-console-and-store). +This setting defines runtime access only and doesn't change field visibility or whether the field is required in the UI. For array fields (`type: array`), the same permissions apply to each selected resource. Your Actor's run will fail with an insufficient-permissions error if it attempts an operation without the required permission, such as writing with read-only access. Users can see the required permissions in the [input field's tooltip](../../running/permissions.md#recognizing-permission-levels-in-console-and-store). ::: diff --git a/sources/platform/actors/development/actor_definition/dataset_schema/validation.md b/sources/platform/actors/development/input_output_schemas/validation.md similarity index 97% rename from sources/platform/actors/development/actor_definition/dataset_schema/validation.md rename to sources/platform/actors/development/input_output_schemas/validation.md index a4d10edb02..ced5357cac 100644 --- a/sources/platform/actors/development/actor_definition/dataset_schema/validation.md +++ b/sources/platform/actors/development/input_output_schemas/validation.md @@ -1,7 +1,7 @@ --- title: Dataset validation description: Specify the dataset schema within the Actors so you can add monitoring and validation at the field level. -slug: /actors/development/actor-definition/dataset-schema/validation +slug: /actors/development/input-output-schemas/dataset-schema/validation --- import Tabs from '@theme/Tabs'; @@ -252,4 +252,4 @@ When you configure the dataset fields schema, we generate a field list and measu - For booleans, this tracks whether the boolean was set to true. Minimum is always 0, but maximum can be either 1 or 0 based on whether at least one item in the dataset has the boolean field set to true. -You can use them in [monitoring](../../../../monitoring#alert-configuration). +You can use them in [monitoring](/platform/actors/running/monitoring#alert-configuration). diff --git a/sources/platform/actors/development/permissions/index.md b/sources/platform/actors/development/permissions/index.md index 181990ce0b..e965198872 100644 --- a/sources/platform/actors/development/permissions/index.md +++ b/sources/platform/actors/development/permissions/index.md @@ -24,7 +24,7 @@ When a user runs an Actor, it receives an Apify API token. This token is injecte Actors with **Full permissions** receive a token that grants complete access to the user's Apify account via the Apify API. -Actors with **Limited permissions** receive [a restricted scoped token](../../../integrations/programming/api.md#api-tokens-with-limited-permissions). This token only allows the Actor to perform a specific set of actions, which covers the vast majority of common use cases. +Actors with **Limited permissions** receive [a restricted scoped token](../../../integrations/api-and-webhooks/api.md#api-tokens-with-limited-permissions). This token only allows the Actor to perform a specific set of actions, which covers the vast majority of common use cases. A limited-permission Actor can: @@ -109,7 +109,7 @@ Behavior at run time: - The user’s selection is injected into the run input, and the run token is expanded to allow only the requested operations on the selected storages. - If your code attempts an operation not covered by `resourcePermissions` (for example, writing with only `READ`), the platform returns an insufficient-permissions error. -See the full [input schema reference for details.](../actor_definition/input_schema/specification.md). +See the full [input schema reference for details.](../input_output_schemas/specification.md). ### Requesting full permissions diff --git a/sources/platform/actors/development/programming_interface/environment_variables.md b/sources/platform/actors/development/programming_interface/environment_variables.md index b295748a64..b4e001cdfb 100644 --- a/sources/platform/actors/development/programming_interface/environment_variables.md +++ b/sources/platform/actors/development/programming_interface/environment_variables.md @@ -35,7 +35,7 @@ Apify sets several system environment variables for each Actor run. These variab Here's a table of key system environment variables: | Environment Variable | Description | -|----------------------|-------------| +| ---------------------- | ------------- | | `ACTOR_ID` | ID of the Actor. | | `ACTOR_FULL_NAME` | Full technical name of the Actor, in the format `owner-username/actor-name`. | | `ACTOR_RUN_ID` | ID of the Actor run. | @@ -47,7 +47,7 @@ Here's a table of key system environment variables: | `ACTOR_DEFAULT_DATASET_ID` | Unique identifier for the default dataset associated with the current Actor run. | | `ACTOR_DEFAULT_KEY_VALUE_STORE_ID` | Unique identifier for the default key-value store associated with the current Actor run. | | `ACTOR_DEFAULT_REQUEST_QUEUE_ID` | Unique identifier for the default request queue associated with the current Actor run. | -| `ACTOR_INPUT_KEY` | Key of the record in the default key-value store that holds the [Actor input](/platform/actors/running/input-and-output#input). | +| `ACTOR_INPUT_KEY` | Key of the record in the default key-value store that holds the [Actor input](/platform/actors/running/input-and-output#input). | | `ACTOR_MAX_PAID_DATASET_ITEMS` | For paid-per-result Actors, the user-set limit on returned results. Do not exceed this limit. | | `ACTOR_MAX_TOTAL_CHARGE_USD` | For pay-per-event Actors, the user-set limit on run cost. Do not exceed this limit. | | `ACTOR_RESTART_ON_ERROR` | If **1**, the Actor run will be restarted if it fails. | @@ -70,7 +70,7 @@ Here's a table of key system environment variables: | `APIFY_DEDICATED_CPUS` | Number of CPU cores reserved for the Actor, based on allocated memory. | | `APIFY_WORKFLOW_KEY` | Identifier used for grouping related runs and API calls together. | | `APIFY_META_ORIGIN` | Specifies how an Actor run was started. Possible values are in [Runs and builds](/platform/actors/running/runs-and-builds#origin) documentation. | -| `APIFY_INPUT_SECRETS_KEY_FILE` | Path to the secret key used to decrypt [Secret inputs](/platform/actors/development/actor-definition/input-schema/secret-input). | +| `APIFY_INPUT_SECRETS_KEY_FILE` | Path to the secret key used to decrypt [Secret inputs](/platform/actors/development/input-output-schemas/input-schema/secret-input). | | `APIFY_INPUT_SECRETS_KEY_PASSPHRASE` | Passphrase for the input secret key specified in `APIFY_INPUT_SECRETS_KEY_FILE`. | diff --git a/sources/platform/actors/development/programming_interface/metamorph.md b/sources/platform/actors/development/programming_interface/metamorph.md index 0b847374cb..813b6cffc3 100644 --- a/sources/platform/actors/development/programming_interface/metamorph.md +++ b/sources/platform/actors/development/programming_interface/metamorph.md @@ -37,7 +37,7 @@ To make your Actor compatible with metamorph, use `Actor.getInput()` instead of :::note Runtime limits -There's a limit to how many times you can metamorph a single run. Refer to the [Actor runtime limits](/platform/limits#actor-limits) for more details. +There's a limit to how many times you can metamorph a single run. Refer to the [Actor runtime limits](/platform/account/limits#actor-limits) for more details. ::: diff --git a/sources/platform/actors/development/programming_interface/system_events.md b/sources/platform/actors/development/programming_interface/system_events.md index bcb9e8c10c..f607ea8b6c 100644 --- a/sources/platform/actors/development/programming_interface/system_events.md +++ b/sources/platform/actors/development/programming_interface/system_events.md @@ -28,12 +28,12 @@ These events help you manage your Actor's behavior and resources effectively. The following table outlines the system events available: -| Event name | Payload | Description | -| -------------- | ------- | ----------- | -| `cpuInfo` | `{ isCpuOverloaded: Boolean }` | Emitted approximately every second, indicating whether the Actor is using maximum available CPU resources. | -| `migrating` | `{ timeRemainingSecs: Float }` | Signals that the Actor will soon migrate to another worker server on the Apify platform. | -| `aborting` | N/A | Triggered when a user initiates a graceful abort of an Actor run, allowing time for cleanup. | -| `persistState` | `{ isMigrating: Boolean }` | Emitted at regular intervals (default: _60 seconds_) to notify Apify SDK components to persist their state. | +| Event name | Payload | Description | +| --- | --- | --- | +| `cpuInfo` | `{ isCpuOverloaded: Boolean }` | Emitted approximately every second, indicating whether the Actor is using maximum available CPU resources. | +| `migrating` | `{ timeRemainingSecs: Float }` | Signals that the Actor will soon migrate to another worker server on the Apify platform. | +| `aborting` | N/A | Triggered when a user initiates a graceful abort of an Actor run, allowing time for cleanup. | +| `persistState` | `{ isMigrating: Boolean }` | Emitted at regular intervals (default: _60 seconds_) to notify Apify SDK components to persist their state. | ## How system events work diff --git a/sources/platform/actors/index.mdx b/sources/platform/actors/index.mdx index bfd6843002..c75f286e13 100644 --- a/sources/platform/actors/index.mdx +++ b/sources/platform/actors/index.mdx @@ -1,7 +1,7 @@ --- title: Actors description: Learn how to develop, run and share serverless cloud programs. Create your own web scraping and automation tools and publish them on the Apify platform. -sidebar_position: 7 +sidebar_position: 1 category: platform slug: /actors --- @@ -63,7 +63,7 @@ Ready to start? Check out the [Actor development documentation](/platform/actors ## Running Actors -You can run Actors manually in [Apify Console](https://console.apify.com/actors), using the [API](/api), [CLI](/cli), or [scheduler](../schedules.md). You can easily [integrate Actors](../integrations/index.mdx) with other apps, [share](../collaboration/access_rights.md) them with other people, [publish](./publishing/index.mdx) them in [Apify Store](https://apify.com/store), and even [monetize](./publishing/monetize/index.mdx). +You can run Actors manually in [Apify Console](https://console.apify.com/actors), using the [API](/api), [CLI](/cli), or [scheduler](./running/schedules.md). You can easily [integrate Actors](../integrations/index.mdx) with other apps, [share](../account/access_rights.md) them with other people, [publish](./publishing/index.mdx) them in [Apify Store](https://apify.com/store), and even [monetize](./publishing/monetize/index.mdx). :::tip Try Actors diff --git a/sources/platform/actors/publishing/index.mdx b/sources/platform/actors/publishing/index.mdx index b781ddec57..c6228346a7 100644 --- a/sources/platform/actors/publishing/index.mdx +++ b/sources/platform/actors/publishing/index.mdx @@ -1,7 +1,7 @@ --- title: Publishing and monetization description: Learn about publishing, and monetizing your Actors on the Apify platform. -sidebar_position: 7.5 +sidebar_position: 4 slug: /actors/publishing --- diff --git a/sources/platform/actors/publishing/monetize/pay_per_event.mdx b/sources/platform/actors/publishing/monetize/pay_per_event.mdx index 51a2561c34..6ddad8d8b1 100644 --- a/sources/platform/actors/publishing/monetize/pay_per_event.mdx +++ b/sources/platform/actors/publishing/monetize/pay_per_event.mdx @@ -145,7 +145,7 @@ We recommend using the synthetic Actor start event in PPE Actors. It benefits bo Starting an Actor takes time, and creates additional cost for the Actor creator, because the profit equals revenue minus platform costs. -One of the options to charge for the time spent on starting the Actor is to charge an “Actor start” event. Unfortunately, this makes your Actor comparably expensive with other tools on the market (outside of [Apify Store](/platform/console/store)) that do not incur this startup cost. +One of the options to charge for the time spent on starting the Actor is to charge an “Actor start” event. Unfortunately, this makes your Actor comparably expensive with other tools on the market (outside of [Apify Store](/platform/account/store)) that do not incur this startup cost. We want to make it easier for Actor creators to stay competitive, but also help them to be profitable. Therefore, we have the Apify Actor synthetic start event `apify-actor-start`. This event is enabled by default for all new PPE Actors, and when you use it Apify will cover the compute unit cost of the first 5 seconds of every Actor run. diff --git a/sources/platform/actors/publishing/quality_score.mdx b/sources/platform/actors/publishing/quality_score.mdx index 3e32396200..a685fbe497 100644 --- a/sources/platform/actors/publishing/quality_score.mdx +++ b/sources/platform/actors/publishing/quality_score.mdx @@ -46,7 +46,7 @@ These are the quality categories: Reliability measures your Actor's operational stability and consistency. A reliable Actor maintains high run success rates and passes automated quality assurance tests. Poor reliability significantly impacts your quality score. For more information on testing requirements, see [Automated Testing](https://docs.apify.com/platform/actors/publishing/test). -Implementing an [input schema](https://docs.apify.com/platform/actors/development/actor-definition/input-schema) helps prevent runtime failures by validating user input before execution begins, reducing errors caused by invalid or malformed inputs. +Implementing an [input schema](https://docs.apify.com/platform/actors/development/input-output-schemas/input-schema) helps prevent runtime failures by validating user input before execution begins, reducing errors caused by invalid or malformed inputs. ### Popularity @@ -80,4 +80,4 @@ Developers with a proven track record of publishing successful Actors receive re ### Congruency -Congruency measures the consistency and coherence across your Actor's components. A well-designed Actor maintains alignment between its title, description, documentation, and schemas. Ensure that your [input schema](https://docs.apify.com/platform/actors/development/actor-definition/input-schema), [dataset schema](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema), [key-value store schema](https://docs.apify.com/platform/actors/development/actor-definition/key-value-store-schema), and README documentation all reflect consistent terminology and accurately describe the Actor's behavior. This coherence reduces user confusion and improves the overall experience. +Congruency measures the consistency and coherence across your Actor's components. A well-designed Actor maintains alignment between its title, description, documentation, and schemas. Ensure that your [input schema](https://docs.apify.com/platform/actors/development/input-output-schemas/input-schema), [dataset schema](https://docs.apify.com/platform/actors/development/input-output-schemas/dataset-schema), [key-value store schema](https://docs.apify.com/platform/actors/development/input-output-schemas/key-value-store-schema), and README documentation all reflect consistent terminology and accurately describe the Actor's behavior. This coherence reduces user confusion and improves the overall experience. diff --git a/sources/platform/actors/publishing/testing.mdx b/sources/platform/actors/publishing/testing.mdx index fb9580d44d..e2c1602f2a 100644 --- a/sources/platform/actors/publishing/testing.mdx +++ b/sources/platform/actors/publishing/testing.mdx @@ -9,14 +9,14 @@ sidebar_position: 3 --- -### Why we test +## Why we test We want to make sure that all Actors in Apify Store are top-notch, or at least as top-notch as they can be. Since there are many of them, we have an automated testing procedure in place that tests all Actors daily. This helps us to flag Actors that temporarily don't work as expected `under maintenance`, and to automatically `deprecate` Actors that have been broken for more than a month. -### How we test +## How we test -The test runs the Actor with its default input (defined by the [**prefill**](https://docs.apify.com/platform/actors/development/actor-definition/input-schema/specification/v1#prefill-vs-default-vs-required) option in the input schema file) +The test runs the Actor with its default input (defined by the [**prefill**](https://docs.apify.com/platform/actors/development/input-output-schemas/input-schema/specification/v1#prefill-vs-default-vs-required) option in the input schema file) and expects it to finish with a **Succeeded** status and non-empty default dataset within 5 minutes of the beginning of the run. ![Actor page](./images/actor-test.webp) diff --git a/sources/platform/actors/running/actor_standby.md b/sources/platform/actors/running/actor_standby.md index b2c171b477..d6dcb7589e 100644 --- a/sources/platform/actors/running/actor_standby.md +++ b/sources/platform/actors/running/actor_standby.md @@ -33,8 +33,8 @@ Generally speaking, Actors in Standby mode behave as standard HTTP servers. You ## How do I authenticate my requests -To authenticate requests to Actor Standby, follow the same process as [authenticating requests to the Apify API](../../integrations/programming/api.md). -You can provide your [API token](../../integrations/programming/api.md#api-token) in one of two ways: +To authenticate requests to Actor Standby, follow the same process as [authenticating requests to the Apify API](../../integrations/api-and-webhooks/api.md). +You can provide your [API token](../../integrations/api-and-webhooks/api.md#api-token) in one of two ways: 1. _Recommended_: Include the token in the `Authorization` header of your request as `Bearer `. This approach is recommended because it prevents your token from being logged in server logs. diff --git a/sources/platform/monitoring/images/alerts.png b/sources/platform/actors/running/images/monitoring/alerts.png similarity index 100% rename from sources/platform/monitoring/images/alerts.png rename to sources/platform/actors/running/images/monitoring/alerts.png diff --git a/sources/platform/monitoring/images/daily-run-statuses.png b/sources/platform/actors/running/images/monitoring/daily-run-statuses.png similarity index 100% rename from sources/platform/monitoring/images/daily-run-statuses.png rename to sources/platform/actors/running/images/monitoring/daily-run-statuses.png diff --git a/sources/platform/monitoring/images/email-notification.png b/sources/platform/actors/running/images/monitoring/email-notification.png similarity index 100% rename from sources/platform/monitoring/images/email-notification.png rename to sources/platform/actors/running/images/monitoring/email-notification.png diff --git a/sources/platform/monitoring/images/in-app-notification.png b/sources/platform/actors/running/images/monitoring/in-app-notification.png similarity index 100% rename from sources/platform/monitoring/images/in-app-notification.png rename to sources/platform/actors/running/images/monitoring/in-app-notification.png diff --git a/sources/platform/monitoring/images/metric-options.png b/sources/platform/actors/running/images/monitoring/metric-options.png similarity index 100% rename from sources/platform/monitoring/images/metric-options.png rename to sources/platform/actors/running/images/monitoring/metric-options.png diff --git a/sources/platform/monitoring/images/monitoring.png b/sources/platform/actors/running/images/monitoring/monitoring.png similarity index 100% rename from sources/platform/monitoring/images/monitoring.png rename to sources/platform/actors/running/images/monitoring/monitoring.png diff --git a/sources/platform/monitoring/images/notifications.png b/sources/platform/actors/running/images/monitoring/notifications.png similarity index 100% rename from sources/platform/monitoring/images/notifications.png rename to sources/platform/actors/running/images/monitoring/notifications.png diff --git a/sources/platform/monitoring/images/run-statistics-chart.png b/sources/platform/actors/running/images/monitoring/run-statistics-chart.png similarity index 100% rename from sources/platform/monitoring/images/run-statistics-chart.png rename to sources/platform/actors/running/images/monitoring/run-statistics-chart.png diff --git a/sources/platform/actors/running/images/schedules-actor-input.png b/sources/platform/actors/running/images/schedules-actor-input.png new file mode 100644 index 0000000000..8a3c082708 Binary files /dev/null and b/sources/platform/actors/running/images/schedules-actor-input.png differ diff --git a/sources/platform/actors/running/images/schedules-bulk-notifications.png b/sources/platform/actors/running/images/schedules-bulk-notifications.png new file mode 100644 index 0000000000..4c63c6ccbb Binary files /dev/null and b/sources/platform/actors/running/images/schedules-bulk-notifications.png differ diff --git a/sources/platform/actors/running/images/schedules-overview.png b/sources/platform/actors/running/images/schedules-overview.png new file mode 100644 index 0000000000..32142cd9d3 Binary files /dev/null and b/sources/platform/actors/running/images/schedules-overview.png differ diff --git a/sources/platform/actors/running/images/schedules-setup-tool.png b/sources/platform/actors/running/images/schedules-setup-tool.png new file mode 100644 index 0000000000..dc081302f3 Binary files /dev/null and b/sources/platform/actors/running/images/schedules-setup-tool.png differ diff --git a/sources/platform/actors/running/images/schedules-task-input.png b/sources/platform/actors/running/images/schedules-task-input.png new file mode 100644 index 0000000000..417b0258a1 Binary files /dev/null and b/sources/platform/actors/running/images/schedules-task-input.png differ diff --git a/sources/platform/actors/running/index.md b/sources/platform/actors/running/index.md index 88be596a39..83ac6008e6 100644 --- a/sources/platform/actors/running/index.md +++ b/sources/platform/actors/running/index.md @@ -1,7 +1,7 @@ --- title: Running Actors description: Start an Actor from Apify Console or via API. Learn about Actor lifecycles, how to specify settings and version, provide input, and resurrect finished runs. -sidebar_position: 7.1 +sidebar_position: 2 slug: /actors/running --- diff --git a/sources/platform/monitoring/index.md b/sources/platform/actors/running/monitoring.md similarity index 84% rename from sources/platform/monitoring/index.md rename to sources/platform/actors/running/monitoring.md index 4cb75ef4f0..d146e5701c 100644 --- a/sources/platform/monitoring/index.md +++ b/sources/platform/actors/running/monitoring.md @@ -1,9 +1,9 @@ --- title: Monitoring +sidebar_label: Monitoring description: Learn how to continuously make sure that your Actors and tasks perform as expected and retrieve correct results. Receive alerts when your jobs or their metrics are not as you expect. -sidebar_position: 12 -category: guides -slug: /monitoring +sidebar_position: 6 +slug: /actors/running/monitoring --- **Learn how to continuously make sure that your Actors and tasks perform as expected and retrieve correct results. Receive alerts when your jobs or their metrics are not as you expect.** @@ -22,20 +22,20 @@ Monitoring is an option you can find on any Actor or saved task in Apify Console The monitoring system is free for all users. You can use it to monitor as many Actors and tasks as you want, and it does not use any additional resources on top of your usage when running them. -![Monitoring](./images/monitoring.png) +![Monitoring](./images/monitoring/monitoring.png) ### Features Currently, the monitoring option offers the following features: 1. Chart showing **statuses** of runs of the Actor or saved task over last 30 days. - ![Daily run statuses](./images/daily-run-statuses.png) + ![Daily run statuses](./images/monitoring/daily-run-statuses.png) 2. Chart displaying **metrics** of the last 200 runs of the Actor or saved task. - ![Run statistics](./images/run-statistics-chart.png) + ![Run statistics](./images/monitoring/run-statistics-chart.png) 3. Option to set up **alerts** with notifications based on the run metrics. - ![Alerts](./images/alerts.png) + ![Alerts](./images/monitoring/alerts.png) > Both charts can also be added to your Apify Console home page so you can quickly see if there are any issues every time you open Apify Console. @@ -49,7 +49,7 @@ When you set up an alert, you have four choices for how you want the metrics to 3. **Alert, when run status is one of following** - This type of alert is checked only after the run finishes. It makes possible to track the status of your finished runs and send an alert if the run finishes in a state you do not expect. If your Actor runs very often and suddenly starts failing, you will receive a single alert after the first failed run in 1 minute, and then aggregated alert every 15 minutes. -4. **Alert for dataset field statistics** - If you have a [dataset schema](../actors/development/actor_definition/dataset_schema/validation.md) set up, then you can use the field statistics to set up an alert. You can use field statistics for example to track if some field is filled in all records, if some numeric value is too low/high (for example when tracking the price of a product over multiple sources), if the number of items in an array is too low/high (for example alert on Instagram Actor if post has a lot of comments) and many other tasks like these. +4. **Alert for dataset field statistics** - If you have a [dataset schema](../development/input_output_schemas/validation.md) set up, then you can use the field statistics to set up an alert. You can use field statistics for example to track if some field is filled in all records, if some numeric value is too low/high (for example when tracking the price of a product over multiple sources), if the number of items in an array is too low/high (for example alert on Instagram Actor if post has a lot of comments) and many other tasks like these. :::important @@ -57,7 +57,7 @@ When you set up an alert, you have four choices for how you want the metrics to ::: -![Metric condition configuration](./images/metric-options.png) +![Metric condition configuration](./images/monitoring/metric-options.png) You can get notified by email, Slack, or in Apify Console. If you use Slack, we suggest using Slack notifications instead of email because they are more reliable, and you can also get notified quicker. @@ -65,7 +65,7 @@ You can get notified by email, Slack, or in Apify Console. If you use Slack, we 2. **Slack** - To set up Slack notifications, you first need to connect your Slack workspace to Apify. To do that, go to your [account integration settings](https://console.apify.com/account/integrations) and click on the **+ Add** button in the Slack section. Once you have your workspace connected, you can choose the workspace when setting up alert notifications and then pick a channel to which you want the notifications to be delivered. 3. **In Console** - You can also get notified in Apify Console. This is useful if you access Apify Console often, and you do not need to be notified as soon as possible. -![Notifications configurations](./images/notifications.png) +![Notifications configurations](./images/monitoring/notifications.png) ### Alert notification @@ -78,11 +78,11 @@ The email and Slack alert notifications both contain the same information. You w 5. **Actor** - The full name of the Actor that triggered the alert which links to the Actor detail in Apify Console. 6. **Task** - If the monitoring alert was set up for a task, then this field will contain the name of the task which links to the task detail in Apify Console. -![Email notification](./images/email-notification.png) +![Email notification](./images/monitoring/email-notification.png) While the in-app notification will contain less information, it will point you directly to the Actor or task that triggered the alert: - + ## Other @@ -108,7 +108,7 @@ These are just a few examples of what you can monitor. It's always recommended t ### Alternative solutions -For more complex monitoring, you can use the [monitoring suite](https://apify.com/apify/monitoring), which is a collection of [Apify Actors](../actors/index.mdx) that allows you to automate the monitoring of jobs you have running on the [Apify platform](https://apify.com). The monitoring suite offers some features that are not **currently** available in Apify Console, such as: +For more complex monitoring, you can use the [monitoring suite](https://apify.com/apify/monitoring), which is a collection of [Apify Actors](../index.mdx) that allows you to automate the monitoring of jobs you have running on the [Apify platform](https://apify.com). The monitoring suite offers some features that are not **currently** available in Apify Console, such as: 1. Schema validation of the output 2. Duplicate checks in the output diff --git a/sources/platform/actors/running/runs_and_builds.md b/sources/platform/actors/running/runs_and_builds.md index 9accc07dae..b75fa24b95 100644 --- a/sources/platform/actors/running/runs_and_builds.md +++ b/sources/platform/actors/running/runs_and_builds.md @@ -88,8 +88,8 @@ flowchart LR | FAILED | terminal | Run failed | | TIMING-OUT | transitional | Timing out now | | TIMED-OUT | terminal | Timed out | -| ABORTING | transitional | Being aborted by the user | -| ABORTED | terminal | Aborted by the user | +| ABORTING | transitional | Being aborted by the user | +| ABORTED | terminal | Aborted by the user | ### Aborting runs @@ -129,4 +129,4 @@ Apify securely stores your ten most recent runs indefinitely, ensuring your reco ## Sharing -Share your Actor runs with other Apify users via the [access rights](../../collaboration/index.md) system. +Share your Actor runs with other Apify users via the [access rights](../../account/index.md) system. diff --git a/sources/platform/schedules.md b/sources/platform/actors/running/schedules.md similarity index 93% rename from sources/platform/schedules.md rename to sources/platform/actors/running/schedules.md index ef13cc0048..844de4ef71 100644 --- a/sources/platform/schedules.md +++ b/sources/platform/actors/running/schedules.md @@ -1,9 +1,8 @@ --- title: Schedules description: Learn how to automatically start your Actor and task runs and the basics of cron expressions. Set up and manage your schedules from Apify Console or via API. -sidebar_position: 8 -category: platform -slug: /schedules +sidebar_position: 5 +slug: /actors/running/schedules --- **Learn how to automatically start your Actor and task runs and the basics of cron expressions. Set up and manage your schedules from Apify Console or via API.** @@ -34,7 +33,7 @@ Each schedule can be associated with a maximum of _10_ Actors and _10_ Actor tas ## Setting up a new schedule -Before setting up a new schedule, you should have the [Actor](./actors/index.mdx) or [task](./actors/running/tasks.md) you want to schedule prepared and tested. +Before setting up a new schedule, you should have the [Actor](../index.mdx) or [task](./tasks.md) you want to schedule prepared and tested. To schedule an Actor, you need to have run it at least once before. To run the Actor, navigate to the Actor's page through [Apify Console](https://console.apify.com/store), where you can configure and initiate the Actor's run with your preferred settings by clicking the **Start** button. After this initial run, you can then use Schedules to automate future runs. @@ -54,7 +53,7 @@ You can adjust how often your Actor or task runs using the [schedule setup tool] Next, you'll need to give the schedule something to run. This is where the Actor or task you prepared earlier comes in. Click on the **Add** dropdown and select whether you want to schedule an Actor or task. -If you're scheduling an Actor run, you'll be able to specify the Actor's [input](./actors/running/input_and_output.md) and running options like [build](./actors/development/builds_and_runs/builds.md), timeout, [memory](./actors/running/usage_and_resources.md). +If you're scheduling an Actor run, you'll be able to specify the Actor's [input](./input_and_output.md) and running options like [build](../development/builds_and_runs/builds.md), timeout, [memory](./usage_and_resources.md). The **timeout** value is specified in seconds; a value of _0_ means there is no timeout, and the Actor runs until it finishes. If you don't provide an input, then the Actor's default input is used. If you provide an input with some fields missing, the missing fields are filled in with values from the default input. If input options are not provided, the default options values are used. @@ -75,7 +74,7 @@ For integrations, you can also add a [webhook](/platform/integrations/webhooks) 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/index.mdx) under the [Integrations](https://console.apify.com/account?tab=integrations) tab of your Apify account settings. +You can find your [secret API token](../../integrations/index.mdx) under the [Integrations](https://console.apify.com/account?tab=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)). diff --git a/sources/platform/actors/running/tasks.md b/sources/platform/actors/running/tasks.md index 033fd175b1..c32be09cc9 100644 --- a/sources/platform/actors/running/tasks.md +++ b/sources/platform/actors/running/tasks.md @@ -10,7 +10,7 @@ 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](../../schedules.md), 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](./schedules.md), or [API](/api/v2/actor-task-runs-post). You can find all your tasks in the [Apify Console](https://console.apify.com/actors/tasks). @@ -46,11 +46,11 @@ Or using the **Start** button positioned following the input configuration. You can also run tasks using: -- [Schedules](../../schedules.md). +- [Schedules](./schedules.md). - Directly via the [Apify API](/api/v2/actor-task-runs-post). - The [JavaScript API client](/api/client/js/reference/class/TaskClient). - The [Python API client](/api/client/python/reference/class/TaskClient). ## Share -Like any other resource, you can share your Actor tasks with other Apify users via the [access rights](../../collaboration/index.md) system. +Like any other resource, you can share your Actor tasks with other Apify users via the [access rights](../../account/index.md) system. diff --git a/sources/platform/actors/running/usage_and_resources.md b/sources/platform/actors/running/usage_and_resources.md index 310819f7c4..f3e7c3343a 100644 --- a/sources/platform/actors/running/usage_and_resources.md +++ b/sources/platform/actors/running/usage_and_resources.md @@ -17,7 +17,7 @@ slug: /actors/running/usage-and-resources Assigning an Actor a specific **Memory** capacity, also determines the allocated CPU power and its disk size. -Check out the [Limits](../../limits.md) page for detailed information on Actor memory, CPU limits, disk size and other limits. +Check out the [Limits](../../account/limits.md) page for detailed information on Actor memory, CPU limits, disk size and other limits. ### Memory @@ -28,7 +28,7 @@ When invoking an Actor, the caller can specify the memory allocation for the Act - The maximum allowed value is `32768MB` - Acceptable values include: `128MB`, `256MB`, `512MB`, `1024MB`, `2048MB`, `4096MB`, `8192MB`, `16384MB`, and `32768MB` -Additionally, each user has a certain total limit of memory for running Actors. The sum of memory allocated for all running Actors and builds needs to be within this limit, otherwise the user cannot start a new Actor. For more details, see [limits](../../limits.md). +Additionally, each user has a certain total limit of memory for running Actors. The sum of memory allocated for all running Actors and builds needs to be within this limit, otherwise the user cannot start a new Actor. For more details, see [limits](../../account/limits.md). ### CPU diff --git a/sources/platform/collaboration/index.md b/sources/platform/collaboration/index.md deleted file mode 100644 index 18aad02362..0000000000 --- a/sources/platform/collaboration/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Collaboration -description: Learn how to collaborate with other users and manage permissions for organizations or private resources such as Actors, Actor runs, and storages. -sidebar_position: 12 -category: platform -slug: /collaboration ---- - -**Learn how to collaborate with other users and manage permissions for organizations or private resources such as Actors, Actor runs, and storages.** - ---- -Apify was built from the ground up as a collaborative platform. Whether you’re publishing your Actor in Apify Store or sharing a dataset with a teammate, collaboration is deeply integrated into how Apify works. You can share your resources (like Actors, runs, or storages) with others, manage permissions, or invite collaborators to your organization. By default, each system resource you create is only available to you, the owner. However, you can grant access to other users, making it easy to collaborate effectively and securely. - -While most resources can be shared by assigning permissions (see [Access Rights](./access_rights.md)), some resources can also be shared simply by using their unique links or IDs. There are two types of resources in terms of sharing: - -- _Resources that require explicit access by default:_ - - [Actors](../actors/running/index.md), [tasks](../actors/running/tasks.md) - - Can be shared only by inviting collaborators using [Access Rights](./access_rights.md)) or using [Organization Accounts](./organization_account/index.md) -- _Resources supporting both explicit access and link sharing:_ - - Actor runs, Actor builds and storage resources (datasets, key-value stores, request queues) - - Can be shared by inviting collaborators or simply by sharing a unique direct link - -You can control access to your resources in four ways: - - - - - - - - - - - - - - - - - - -
    Access rightsEnables you to grant access to another user for a certain resource you own. This way, you can share results with your client, or two engineers can collaborate on developing one Actor.
    Share resources by linkCertain resources (runs, builds and storages) can by shared just by their link. Anyone with their ID is able to access them. This is configurable via General resource access
    Organization accountApify's organization account allows multiple engineers to collaborate on team projects with role-specific access permissions.
    Publishing in Apify StoreAnother way to share your Actor with other users is to publish it in Apify Store. When publishing your Actor, you can make it a Paid Actor and get paid by the users benefiting from your tool. For more information, read the publishing and monetization section.
    diff --git a/sources/platform/actors/development/quick-start/build_with_ai.md b/sources/platform/get-started/build-an-actor/build_with_ai.md similarity index 99% rename from sources/platform/actors/development/quick-start/build_with_ai.md rename to sources/platform/get-started/build-an-actor/build_with_ai.md index 43da362911..c9419a207a 100644 --- a/sources/platform/actors/development/quick-start/build_with_ai.md +++ b/sources/platform/get-started/build-an-actor/build_with_ai.md @@ -3,7 +3,7 @@ title: Build Actors with AI sidebar_position: 3 sidebar_label: Build with AI description: Learn how to build new Actors or improve existing ones using AI code generation and vibe coding tools. -slug: /actors/development/quick-start/build-with-ai +slug: /get-started/build-an-actor/build-with-ai toc_max_heading_level: 4 --- diff --git a/sources/platform/actors/development/quick-start/images/actor-build.png b/sources/platform/get-started/build-an-actor/images/actor-build.png similarity index 100% rename from sources/platform/actors/development/quick-start/images/actor-build.png rename to sources/platform/get-started/build-an-actor/images/actor-build.png diff --git a/sources/platform/actors/development/quick-start/images/actor-create-button.png b/sources/platform/get-started/build-an-actor/images/actor-create-button.png similarity index 100% rename from sources/platform/actors/development/quick-start/images/actor-create-button.png rename to sources/platform/get-started/build-an-actor/images/actor-create-button.png diff --git a/sources/platform/actors/development/quick-start/images/actor-create-templates.png b/sources/platform/get-started/build-an-actor/images/actor-create-templates.png similarity index 100% rename from sources/platform/actors/development/quick-start/images/actor-create-templates.png rename to sources/platform/get-started/build-an-actor/images/actor-create-templates.png diff --git a/sources/platform/actors/development/quick-start/images/actor-create.gif b/sources/platform/get-started/build-an-actor/images/actor-create.gif similarity index 100% rename from sources/platform/actors/development/quick-start/images/actor-create.gif rename to sources/platform/get-started/build-an-actor/images/actor-create.gif diff --git a/sources/platform/actors/development/quick-start/images/actor-input.png b/sources/platform/get-started/build-an-actor/images/actor-input.png similarity index 100% rename from sources/platform/actors/development/quick-start/images/actor-input.png rename to sources/platform/get-started/build-an-actor/images/actor-input.png diff --git a/sources/platform/actors/development/quick-start/images/actor-local-code.png b/sources/platform/get-started/build-an-actor/images/actor-local-code.png similarity index 100% rename from sources/platform/actors/development/quick-start/images/actor-local-code.png rename to sources/platform/get-started/build-an-actor/images/actor-local-code.png diff --git a/sources/platform/actors/development/quick-start/images/actor-local-run.png b/sources/platform/get-started/build-an-actor/images/actor-local-run.png similarity index 100% rename from sources/platform/actors/development/quick-start/images/actor-local-run.png rename to sources/platform/get-started/build-an-actor/images/actor-local-run.png diff --git a/sources/platform/actors/development/quick-start/images/actor-pull.png b/sources/platform/get-started/build-an-actor/images/actor-pull.png similarity index 100% rename from sources/platform/actors/development/quick-start/images/actor-pull.png rename to sources/platform/get-started/build-an-actor/images/actor-pull.png diff --git a/sources/platform/actors/development/quick-start/images/actor-run.png b/sources/platform/get-started/build-an-actor/images/actor-run.png similarity index 100% rename from sources/platform/actors/development/quick-start/images/actor-run.png rename to sources/platform/get-started/build-an-actor/images/actor-run.png diff --git a/sources/platform/actors/development/quick-start/images/actor-source-code.png b/sources/platform/get-started/build-an-actor/images/actor-source-code.png similarity index 100% rename from sources/platform/actors/development/quick-start/images/actor-source-code.png rename to sources/platform/get-started/build-an-actor/images/actor-source-code.png diff --git a/sources/platform/actors/development/quick-start/images/actor-templates.png b/sources/platform/get-started/build-an-actor/images/actor-templates.png similarity index 100% rename from sources/platform/actors/development/quick-start/images/actor-templates.png rename to sources/platform/get-started/build-an-actor/images/actor-templates.png diff --git a/sources/platform/actors/development/quick-start/images/claude.png b/sources/platform/get-started/build-an-actor/images/claude.png similarity index 100% rename from sources/platform/actors/development/quick-start/images/claude.png rename to sources/platform/get-started/build-an-actor/images/claude.png diff --git a/sources/platform/actors/development/quick-start/images/copy-for-ai.png b/sources/platform/get-started/build-an-actor/images/copy-for-ai.png similarity index 100% rename from sources/platform/actors/development/quick-start/images/copy-for-ai.png rename to sources/platform/get-started/build-an-actor/images/copy-for-ai.png diff --git a/sources/platform/actors/development/quick-start/images/create-actor.png b/sources/platform/get-started/build-an-actor/images/create-actor.png similarity index 100% rename from sources/platform/actors/development/quick-start/images/create-actor.png rename to sources/platform/get-started/build-an-actor/images/create-actor.png diff --git a/sources/platform/actors/development/quick-start/images/cursor.png b/sources/platform/get-started/build-an-actor/images/cursor.png similarity index 100% rename from sources/platform/actors/development/quick-start/images/cursor.png rename to sources/platform/get-started/build-an-actor/images/cursor.png diff --git a/sources/platform/actors/development/quick-start/images/github-copilot.png b/sources/platform/get-started/build-an-actor/images/github-copilot.png similarity index 100% rename from sources/platform/actors/development/quick-start/images/github-copilot.png rename to sources/platform/get-started/build-an-actor/images/github-copilot.png diff --git a/sources/platform/actors/development/quick-start/images/python-templates.png b/sources/platform/get-started/build-an-actor/images/python-templates.png similarity index 100% rename from sources/platform/actors/development/quick-start/images/python-templates.png rename to sources/platform/get-started/build-an-actor/images/python-templates.png diff --git a/sources/platform/actors/development/quick-start/images/windsurf.png b/sources/platform/get-started/build-an-actor/images/windsurf.png similarity index 100% rename from sources/platform/actors/development/quick-start/images/windsurf.png rename to sources/platform/get-started/build-an-actor/images/windsurf.png diff --git a/sources/platform/actors/development/quick-start/index.mdx b/sources/platform/get-started/build-an-actor/index.mdx similarity index 84% rename from sources/platform/actors/development/quick-start/index.mdx rename to sources/platform/get-started/build-an-actor/index.mdx index fbc99ffc29..4cb93fdfcf 100644 --- a/sources/platform/actors/development/quick-start/index.mdx +++ b/sources/platform/get-started/build-an-actor/index.mdx @@ -1,9 +1,9 @@ --- -title: Actor development quick start -sidebar_label: Quick start -sidebar_position: 0.5 +title: Build an Actor +sidebar_label: Build an Actor +sidebar_position: 2 description: Create your first Actor using the Apify Web IDE or locally in your IDE. -slug: /actors/development/quick-start +slug: /get-started/build-an-actor --- import Card from "@site/src/components/Card"; @@ -37,16 +37,16 @@ You can choose from three main ways to build your Actor, depending on your prefe     diff --git a/sources/platform/actors/development/quick-start/start_locally.md b/sources/platform/get-started/build-an-actor/start_locally.md similarity index 95% rename from sources/platform/actors/development/quick-start/start_locally.md rename to sources/platform/get-started/build-an-actor/start_locally.md index a107d14db2..388d169bb8 100644 --- a/sources/platform/actors/development/quick-start/start_locally.md +++ b/sources/platform/get-started/build-an-actor/start_locally.md @@ -3,7 +3,7 @@ title: Local Actor development sidebar_label: Local development sidebar_position: 1 description: Create your first Actor locally on your machine, deploy it to the Apify platform, and run it in the cloud. -slug: /actors/development/quick-start/locally +slug: /get-started/build-an-actor/locally --- **Create your first Actor locally on your machine, deploy it to the Apify platform, and run it in the cloud.** @@ -98,7 +98,7 @@ This JSON Schema validates input automatically (no error handling needed), power ::: -Find more info in the [Input schema](/platform/actors/development/actor-definition/input-schema) documentation. +Find more info in the [Input schema](/platform/actors/development/input-output-schemas/input-schema) documentation. #### Actor's `storage` @@ -116,8 +116,8 @@ The dataset stores a series of data objects from web scraping, crawling, or data You define the Actor output using the Output schema files: -- [Dataset Schema Specification](/platform/actors/development/actor-definition/dataset-schema) -- [Key-value Store Schema Specification](/platform/actors/development/actor-definition/key-value-store-schema) +- [Dataset Schema Specification](/platform/actors/development/input-output-schemas/dataset-schema) +- [Key-value Store Schema Specification](/platform/actors/development/input-output-schemas/key-value-store-schema) The system uses this to generate an immutable JSON file that tells users where to find the Actor's results. diff --git a/sources/platform/actors/development/quick-start/start_web_ide.md b/sources/platform/get-started/build-an-actor/start_web_ide.md similarity index 99% rename from sources/platform/actors/development/quick-start/start_web_ide.md rename to sources/platform/get-started/build-an-actor/start_web_ide.md index 6f22461e52..ba043d6ef6 100644 --- a/sources/platform/actors/development/quick-start/start_web_ide.md +++ b/sources/platform/get-started/build-an-actor/start_web_ide.md @@ -2,7 +2,7 @@ title: Web IDE sidebar_position: 2 description: Create your first Actor using the web IDE in Apify Console. -slug: /actors/development/quick-start/web-ide +slug: /get-started/build-an-actor/web-ide --- import Tabs from '@theme/Tabs'; diff --git a/sources/platform/get-started/connect-ai-agents.md b/sources/platform/get-started/connect-ai-agents.md new file mode 100644 index 0000000000..ae899596b0 --- /dev/null +++ b/sources/platform/get-started/connect-ai-agents.md @@ -0,0 +1,38 @@ +--- +title: Connect AI agents +description: Connect your AI agents and LLM applications to the Apify platform to access web data and automation tools. +sidebar_position: 3 +slug: /get-started/connect-ai-agents +--- + +**Connect your AI agents and LLM applications to the Apify platform to access web data and automation tools.** + +--- + +## Why connect AI agents to Apify + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris. + +## Use Apify Actors as MCP tools + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent euismod, nisi vel consectetur interdum, nisl nisi aliquet nunc, quis aliquam nisl nisi eu nisi. + +### Set up the MCP server + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. + +### Configure your AI agent + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + +## Use Apify with LLM frameworks + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur pretium tincidunt lacus. Nulla gravida orci a odio. + +### LangChain + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. + +### CrewAI + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras dapibus. Vivamus elementum semper nisi. diff --git a/sources/platform/get-started/find-and-run-actor.md b/sources/platform/get-started/find-and-run-actor.md new file mode 100644 index 0000000000..8d670a8bd9 --- /dev/null +++ b/sources/platform/get-started/find-and-run-actor.md @@ -0,0 +1,34 @@ +--- +title: Find and run an Actor +description: Learn how to find the right Actor in Apify Store and run it to extract data or automate a workflow. +sidebar_position: 1 +slug: /get-started/find-and-run-actor +--- + +**Learn how to find the right Actor in Apify Store and run it to extract data or automate a workflow.** + +--- + +## Find an Actor in Apify Store + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris. + +## Run an Actor + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent euismod, nisi vel consectetur interdum, nisl nisi aliquet nunc, quis aliquam nisl nisi eu nisi. + +### Configure the input + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. + +### Start the run + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + +## View the results + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur pretium tincidunt lacus. Nulla gravida orci a odio. + +### Export data + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. diff --git a/sources/platform/get-started/index.md b/sources/platform/get-started/index.md new file mode 100644 index 0000000000..0ca4e032c4 --- /dev/null +++ b/sources/platform/get-started/index.md @@ -0,0 +1,31 @@ +--- +title: Get started +description: Get started with the Apify platform by running Actors, building your own, or connecting AI agents. +sidebar_position: 0 +slug: /get-started +--- + +import Card from "@site/src/components/Card"; +import CardGrid from "@site/src/components/CardGrid"; + +**Get started with the Apify platform by running Actors, building your own, or connecting AI agents.** + +--- + + + + + + diff --git a/sources/platform/homepage_content.json b/sources/platform/homepage_content.json index 2c5fc61f78..4b64b3aa16 100644 --- a/sources/platform/homepage_content.json +++ b/sources/platform/homepage_content.json @@ -17,7 +17,7 @@ { "title": "Schedules", "description": "Learn how to automatically start your Actor and task runs.", - "to": "/platform/schedules" + "to": "/platform/actors/running/schedules" }, { "title": "Integrations", @@ -27,6 +27,6 @@ { "title": "Monitoring", "description": "Learn how to check the performance of your Actors, validate your data and receive alerts.", - "to": "/platform/monitoring" + "to": "/platform/actors/running/monitoring" } ] diff --git a/sources/platform/integrations/actor-to-actor/_category_.yml b/sources/platform/integrations/actor-to-actor/_category_.yml new file mode 100644 index 0000000000..c742ff4d1c --- /dev/null +++ b/sources/platform/integrations/actor-to-actor/_category_.yml @@ -0,0 +1,2 @@ +label: Actor-to-Actor +position: 3 diff --git a/sources/platform/integrations/actors/images/integration_triggers.png b/sources/platform/integrations/actor-to-actor/images/integration_triggers.png similarity index 100% rename from sources/platform/integrations/actors/images/integration_triggers.png rename to sources/platform/integrations/actor-to-actor/images/integration_triggers.png diff --git a/sources/platform/integrations/actors/images/integrations_add.png b/sources/platform/integrations/actor-to-actor/images/integrations_add.png similarity index 100% rename from sources/platform/integrations/actors/images/integrations_add.png rename to sources/platform/integrations/actor-to-actor/images/integrations_add.png diff --git a/sources/platform/integrations/actors/images/integrations_test_options.png b/sources/platform/integrations/actor-to-actor/images/integrations_test_options.png similarity index 100% rename from sources/platform/integrations/actors/images/integrations_test_options.png rename to sources/platform/integrations/actor-to-actor/images/integrations_test_options.png diff --git a/sources/platform/integrations/actors/images/specific_vs_generic_integrations.png b/sources/platform/integrations/actor-to-actor/images/specific_vs_generic_integrations.png similarity index 100% rename from sources/platform/integrations/actors/images/specific_vs_generic_integrations.png rename to sources/platform/integrations/actor-to-actor/images/specific_vs_generic_integrations.png diff --git a/sources/platform/integrations/actors/index.md b/sources/platform/integrations/actor-to-actor/index.md similarity index 100% rename from sources/platform/integrations/actors/index.md rename to sources/platform/integrations/actor-to-actor/index.md diff --git a/sources/platform/integrations/actors/integrating_actors_via_api.md b/sources/platform/integrations/actor-to-actor/integrating_actors_via_api.md similarity index 100% rename from sources/platform/integrations/actors/integrating_actors_via_api.md rename to sources/platform/integrations/actor-to-actor/integrating_actors_via_api.md diff --git a/sources/platform/integrations/actors/integration_ready_actors.md b/sources/platform/integrations/actor-to-actor/integration_ready_actors.md similarity index 100% rename from sources/platform/integrations/actors/integration_ready_actors.md rename to sources/platform/integrations/actor-to-actor/integration_ready_actors.md diff --git a/sources/platform/integrations/actors/_category_.yml b/sources/platform/integrations/actors/_category_.yml deleted file mode 100644 index 51e68dbcf6..0000000000 --- a/sources/platform/integrations/actors/_category_.yml +++ /dev/null @@ -1 +0,0 @@ -position: 3 diff --git a/sources/platform/integrations/ai-frameworks/_category_.yml b/sources/platform/integrations/ai-frameworks/_category_.yml new file mode 100644 index 0000000000..b7ae9507c1 --- /dev/null +++ b/sources/platform/integrations/ai-frameworks/_category_.yml @@ -0,0 +1,2 @@ +label: 'AI frameworks' +position: 6 diff --git a/sources/platform/integrations/ai/agno.md b/sources/platform/integrations/ai-frameworks/agno.md similarity index 100% rename from sources/platform/integrations/ai/agno.md rename to sources/platform/integrations/ai-frameworks/agno.md diff --git a/sources/platform/integrations/ai/aws_bedrock.md b/sources/platform/integrations/ai-frameworks/aws_bedrock.md similarity index 100% rename from sources/platform/integrations/ai/aws_bedrock.md rename to sources/platform/integrations/ai-frameworks/aws_bedrock.md diff --git a/sources/platform/integrations/ai/chatgpt.md b/sources/platform/integrations/ai-frameworks/chatgpt.md similarity index 100% rename from sources/platform/integrations/ai/chatgpt.md rename to sources/platform/integrations/ai-frameworks/chatgpt.md diff --git a/sources/platform/integrations/ai/crewai.md b/sources/platform/integrations/ai-frameworks/crewai.md similarity index 100% rename from sources/platform/integrations/ai/crewai.md rename to sources/platform/integrations/ai-frameworks/crewai.md diff --git a/sources/platform/integrations/ai/flowise.md b/sources/platform/integrations/ai-frameworks/flowise.md similarity index 100% rename from sources/platform/integrations/ai/flowise.md rename to sources/platform/integrations/ai-frameworks/flowise.md diff --git a/sources/platform/integrations/ai/google-adk.md b/sources/platform/integrations/ai-frameworks/google-adk.md similarity index 100% rename from sources/platform/integrations/ai/google-adk.md rename to sources/platform/integrations/ai-frameworks/google-adk.md diff --git a/sources/platform/integrations/ai/haystack.md b/sources/platform/integrations/ai-frameworks/haystack.md similarity index 100% rename from sources/platform/integrations/ai/haystack.md rename to sources/platform/integrations/ai-frameworks/haystack.md diff --git a/sources/platform/integrations/ai/images/lindy/lindy-action.png b/sources/platform/integrations/ai-frameworks/images/lindy/lindy-action.png similarity index 100% rename from sources/platform/integrations/ai/images/lindy/lindy-action.png rename to sources/platform/integrations/ai-frameworks/images/lindy/lindy-action.png diff --git a/sources/platform/integrations/ai/images/lindy/lindy-instagram-actor.png b/sources/platform/integrations/ai-frameworks/images/lindy/lindy-instagram-actor.png similarity index 100% rename from sources/platform/integrations/ai/images/lindy/lindy-instagram-actor.png rename to sources/platform/integrations/ai-frameworks/images/lindy/lindy-instagram-actor.png diff --git a/sources/platform/integrations/ai/images/lindy/lindy-new-button.png b/sources/platform/integrations/ai-frameworks/images/lindy/lindy-new-button.png similarity index 100% rename from sources/platform/integrations/ai/images/lindy/lindy-new-button.png rename to sources/platform/integrations/ai-frameworks/images/lindy/lindy-new-button.png diff --git a/sources/platform/integrations/ai/images/lindy/lindy-received.png b/sources/platform/integrations/ai-frameworks/images/lindy/lindy-received.png similarity index 100% rename from sources/platform/integrations/ai/images/lindy/lindy-received.png rename to sources/platform/integrations/ai-frameworks/images/lindy/lindy-received.png diff --git a/sources/platform/integrations/ai/images/lindy/lindy-run-actor.png b/sources/platform/integrations/ai-frameworks/images/lindy/lindy-run-actor.png similarity index 100% rename from sources/platform/integrations/ai/images/lindy/lindy-run-actor.png rename to sources/platform/integrations/ai-frameworks/images/lindy/lindy-run-actor.png diff --git a/sources/platform/integrations/ai/images/lindy/lindy-scratch.png b/sources/platform/integrations/ai-frameworks/images/lindy/lindy-scratch.png similarity index 100% rename from sources/platform/integrations/ai/images/lindy/lindy-scratch.png rename to sources/platform/integrations/ai-frameworks/images/lindy/lindy-scratch.png diff --git a/sources/platform/integrations/ai/images/lindy/lindy-trigger.png b/sources/platform/integrations/ai-frameworks/images/lindy/lindy-trigger.png similarity index 100% rename from sources/platform/integrations/ai/images/lindy/lindy-trigger.png rename to sources/platform/integrations/ai-frameworks/images/lindy/lindy-trigger.png diff --git a/sources/platform/integrations/ai/langchain.md b/sources/platform/integrations/ai-frameworks/langchain.md similarity index 100% rename from sources/platform/integrations/ai/langchain.md rename to sources/platform/integrations/ai-frameworks/langchain.md diff --git a/sources/platform/integrations/ai/langflow.md b/sources/platform/integrations/ai-frameworks/langflow.md similarity index 100% rename from sources/platform/integrations/ai/langflow.md rename to sources/platform/integrations/ai-frameworks/langflow.md diff --git a/sources/platform/integrations/ai/langgraph.md b/sources/platform/integrations/ai-frameworks/langgraph.md similarity index 100% rename from sources/platform/integrations/ai/langgraph.md rename to sources/platform/integrations/ai-frameworks/langgraph.md diff --git a/sources/platform/integrations/ai/lindy.md b/sources/platform/integrations/ai-frameworks/lindy.md similarity index 100% rename from sources/platform/integrations/ai/lindy.md rename to sources/platform/integrations/ai-frameworks/lindy.md diff --git a/sources/platform/integrations/ai/llama.md b/sources/platform/integrations/ai-frameworks/llama.md similarity index 100% rename from sources/platform/integrations/ai/llama.md rename to sources/platform/integrations/ai-frameworks/llama.md diff --git a/sources/platform/integrations/ai/mastra.md b/sources/platform/integrations/ai-frameworks/mastra.md similarity index 100% rename from sources/platform/integrations/ai/mastra.md rename to sources/platform/integrations/ai-frameworks/mastra.md diff --git a/sources/platform/integrations/ai/mcp.md b/sources/platform/integrations/ai-frameworks/mcp.md similarity index 100% rename from sources/platform/integrations/ai/mcp.md rename to sources/platform/integrations/ai-frameworks/mcp.md diff --git a/sources/platform/integrations/ai/milvus.md b/sources/platform/integrations/ai-frameworks/milvus.md similarity index 100% rename from sources/platform/integrations/ai/milvus.md rename to sources/platform/integrations/ai-frameworks/milvus.md diff --git a/sources/platform/integrations/ai/openai_agents.md b/sources/platform/integrations/ai-frameworks/openai_agents.md similarity index 100% rename from sources/platform/integrations/ai/openai_agents.md rename to sources/platform/integrations/ai-frameworks/openai_agents.md diff --git a/sources/platform/integrations/ai/openai_assistants.md b/sources/platform/integrations/ai-frameworks/openai_assistants.md similarity index 100% rename from sources/platform/integrations/ai/openai_assistants.md rename to sources/platform/integrations/ai-frameworks/openai_assistants.md diff --git a/sources/platform/integrations/ai/pinecone.md b/sources/platform/integrations/ai-frameworks/pinecone.md similarity index 100% rename from sources/platform/integrations/ai/pinecone.md rename to sources/platform/integrations/ai-frameworks/pinecone.md diff --git a/sources/platform/integrations/ai/qdrant.md b/sources/platform/integrations/ai-frameworks/qdrant.md similarity index 100% rename from sources/platform/integrations/ai/qdrant.md rename to sources/platform/integrations/ai-frameworks/qdrant.md diff --git a/sources/platform/integrations/ai/skyfire.md b/sources/platform/integrations/ai-frameworks/skyfire.md similarity index 100% rename from sources/platform/integrations/ai/skyfire.md rename to sources/platform/integrations/ai-frameworks/skyfire.md diff --git a/sources/platform/integrations/ai/vercel-ai-sdk.md b/sources/platform/integrations/ai-frameworks/vercel-ai-sdk.md similarity index 100% rename from sources/platform/integrations/ai/vercel-ai-sdk.md rename to sources/platform/integrations/ai-frameworks/vercel-ai-sdk.md diff --git a/sources/platform/integrations/ai/_category_.yml b/sources/platform/integrations/ai/_category_.yml deleted file mode 100644 index 2bc8d69435..0000000000 --- a/sources/platform/integrations/ai/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: 'AI' -position: 6 diff --git a/sources/platform/integrations/api-and-webhooks/_category_.yml b/sources/platform/integrations/api-and-webhooks/_category_.yml new file mode 100644 index 0000000000..dc33a66356 --- /dev/null +++ b/sources/platform/integrations/api-and-webhooks/_category_.yml @@ -0,0 +1,2 @@ +label: 'API and webhooks' +position: 2 diff --git a/sources/platform/integrations/programming/api.md b/sources/platform/integrations/api-and-webhooks/api.md similarity index 99% rename from sources/platform/integrations/programming/api.md rename to sources/platform/integrations/api-and-webhooks/api.md index 6923b2d64f..4d272f1644 100644 --- a/sources/platform/integrations/programming/api.md +++ b/sources/platform/integrations/api-and-webhooks/api.md @@ -176,7 +176,7 @@ If it’s **on**, the token can implicitly access the default storage of the Act If the toggle is **off**, the token can still trigger and inspect runs, but access to the default storages is restricted: -- For accounts with **Restricted general resource access**, the token cannot read or write to default storages. [Learn more about restricted general resource access](/platform/collaboration/general-resource-access). +- For accounts with **Restricted general resource access**, the token cannot read or write to default storages. [Learn more about restricted general resource access](/platform/account/general-resource-access). - For accounts with **Unrestricted general resource access**, the default storages can still be read anonymously using their IDs, but writing is prevented. diff --git a/sources/platform/integrations/programming/github.md b/sources/platform/integrations/api-and-webhooks/github.md similarity index 100% rename from sources/platform/integrations/programming/github.md rename to sources/platform/integrations/api-and-webhooks/github.md diff --git a/sources/platform/integrations/programming/webhooks/actions.md b/sources/platform/integrations/api-and-webhooks/webhooks/actions.md similarity index 86% rename from sources/platform/integrations/programming/webhooks/actions.md rename to sources/platform/integrations/api-and-webhooks/webhooks/actions.md index c2f8398fb1..b1961f3105 100644 --- a/sources/platform/integrations/programming/webhooks/actions.md +++ b/sources/platform/integrations/api-and-webhooks/webhooks/actions.md @@ -156,13 +156,13 @@ The headers template is a JSON-like text where you can add additional informatio Note that the following HTTP headers are always set by the system and your changes will always be rewritten: -| Variable | Value | -|---------------------------|-------------------------| -| `Host` | Request URL | -| `Content-Type` | `application/json` | -| `X-Apify-Webhook` | Apify internal value | -| `X-Apify-Webhook-Dispatch-Id` | Apify webhook dispatch ID | -| `X-Apify-Request-Origin` | Apify origin | +| Variable | Value | +| --- | --- | +| `Host` | Request URL | +| `Content-Type` | `application/json` | +| `X-Apify-Webhook` | Apify internal value | +| `X-Apify-Webhook-Dispatch-Id` | Apify webhook dispatch ID | +| `X-Apify-Request-Origin` | Apify origin | ## Description @@ -170,14 +170,14 @@ The description is an optional string that you can add to the webhook. It serves ## Available variables -| Variable | Type | Description | -|-------------|--------|-------------------------------------------------------------------------------------| -| `userId` | string | ID of the Apify user who owns the webhook. | -| `createdAt` | string | ISO string date of the webhook's trigger event. | -| `eventType` | string | Type of the trigger event, see [Events](/platform/integrations/webhooks/events). | +| Variable | Type | Description | +| --- | --- | --- | +| `userId` | string | ID of the Apify user who owns the webhook. | +| `createdAt` | string | ISO string date of the webhook's trigger event. | +| `eventType` | string | Type of the trigger event, see [Events](/platform/integrations/webhooks/events). | | `eventData` | Object | Data associated with the trigger event, see [Events](/platform/integrations/webhooks/events). | -| `resource` | Object | The resource that caused the trigger event. | -| `globals` | Object | Data available in global context. Contains `dateISO` (date of webhook's trigger event in ISO 8601 format) and `dateUnix` (date of trigger event in Unix time in seconds) | +| `resource` | Object | The resource that caused the trigger event. | +| `globals` | Object | Data available in global context. Contains `dateISO` (date of webhook's trigger event in ISO 8601 format) and `dateUnix` (date of trigger event in Unix time in seconds) | ### Resource diff --git a/sources/platform/integrations/programming/webhooks/ad_hoc_webhooks.md b/sources/platform/integrations/api-and-webhooks/webhooks/ad_hoc_webhooks.md similarity index 100% rename from sources/platform/integrations/programming/webhooks/ad_hoc_webhooks.md rename to sources/platform/integrations/api-and-webhooks/webhooks/ad_hoc_webhooks.md diff --git a/sources/platform/integrations/programming/webhooks/events.md b/sources/platform/integrations/api-and-webhooks/webhooks/events.md similarity index 100% rename from sources/platform/integrations/programming/webhooks/events.md rename to sources/platform/integrations/api-and-webhooks/webhooks/events.md diff --git a/sources/platform/integrations/programming/webhooks/index.md b/sources/platform/integrations/api-and-webhooks/webhooks/index.md similarity index 100% rename from sources/platform/integrations/programming/webhooks/index.md rename to sources/platform/integrations/api-and-webhooks/webhooks/index.md diff --git a/sources/platform/integrations/data-destinations/_category_.yml b/sources/platform/integrations/data-destinations/_category_.yml new file mode 100644 index 0000000000..45a8b8e06c --- /dev/null +++ b/sources/platform/integrations/data-destinations/_category_.yml @@ -0,0 +1,2 @@ +label: Data destinations +position: 5 diff --git a/sources/platform/integrations/data-storage/airbyte.md b/sources/platform/integrations/data-destinations/airbyte.md similarity index 100% rename from sources/platform/integrations/data-storage/airbyte.md rename to sources/platform/integrations/data-destinations/airbyte.md diff --git a/sources/platform/integrations/data-storage/airtable/console_integration.md b/sources/platform/integrations/data-destinations/airtable/console_integration.md similarity index 100% rename from sources/platform/integrations/data-storage/airtable/console_integration.md rename to sources/platform/integrations/data-destinations/airtable/console_integration.md diff --git a/sources/platform/integrations/data-storage/airtable/index.md b/sources/platform/integrations/data-destinations/airtable/index.md similarity index 100% rename from sources/platform/integrations/data-storage/airtable/index.md rename to sources/platform/integrations/data-destinations/airtable/index.md diff --git a/sources/platform/integrations/data-storage/drive.md b/sources/platform/integrations/data-destinations/drive.md similarity index 100% rename from sources/platform/integrations/data-storage/drive.md rename to sources/platform/integrations/data-destinations/drive.md diff --git a/sources/platform/integrations/data-storage/keboola.md b/sources/platform/integrations/data-destinations/keboola.md similarity index 100% rename from sources/platform/integrations/data-storage/keboola.md rename to sources/platform/integrations/data-destinations/keboola.md diff --git a/sources/platform/integrations/data-storage/_category_.yml b/sources/platform/integrations/data-storage/_category_.yml deleted file mode 100644 index e5d0354cd7..0000000000 --- a/sources/platform/integrations/data-storage/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: Data storage -position: 5 diff --git a/sources/platform/integrations/index.mdx b/sources/platform/integrations/index.mdx index 3b9042f835..6d98093433 100644 --- a/sources/platform/integrations/index.mdx +++ b/sources/platform/integrations/index.mdx @@ -1,7 +1,7 @@ --- title: Integrations description: Learn how to integrate the Apify platform with other services, your systems, data pipelines, and other web automation workflows. -sidebar_position: 11 +sidebar_position: 1 category: platform slug: /integrations --- diff --git a/sources/platform/integrations/integrate_with_apify.md b/sources/platform/integrations/integrate_with_apify.md index a99f6176e3..1265606f6e 100644 --- a/sources/platform/integrations/integrate_with_apify.md +++ b/sources/platform/integrations/integrate_with_apify.md @@ -22,7 +22,7 @@ An Apify integration can be _general_, allowing users to integrate any Actor fro General integrations allow users to integrate Actors into their workflows by connecting Apify with other platforms. Examples include: -- [Zapier](./workflows-and-notifications/zapier.md) integration allows Zapier users to enrich their automation workflows with data from the web or to add additional Actions performed by [Apify Actors](https://apify.com/store). +- [Zapier](./workflow-automation/zapier.md) integration allows Zapier users to enrich their automation workflows with data from the web or to add additional Actions performed by [Apify Actors](https://apify.com/store). - [Keboola](/platform/integrations/keboola) integration enables Keboola users to easily pull data crawled from the web into their data pipelines. ### Actor-specific integrations @@ -45,7 +45,7 @@ To integrate your service with Apify, you have two options: ### Building an integration Actor -One way to reach out to Apify users is directly within [Apify Console](https://console.apify.com). To do that, you need to build an integrable Actor that can be piped into other Actors to upload existing data into a database. This can then be easily configured within Apify Console. Follow the [guide on building integration-ready Actors](./actors/integration_ready_actors.md). +One way to reach out to Apify users is directly within [Apify Console](https://console.apify.com). To do that, you need to build an integrable Actor that can be piped into other Actors to upload existing data into a database. This can then be easily configured within Apify Console. Follow the [guide on building integration-ready Actors](./actor-to-actor/integration_ready_actors.md). ### Building an external integration diff --git a/sources/platform/integrations/programming/_category_.yml b/sources/platform/integrations/programming/_category_.yml deleted file mode 100644 index 6c538173b6..0000000000 --- a/sources/platform/integrations/programming/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: 'Programming' -position: 2 diff --git a/sources/platform/integrations/workflow-automation/_category_.yml b/sources/platform/integrations/workflow-automation/_category_.yml new file mode 100644 index 0000000000..deedd06389 --- /dev/null +++ b/sources/platform/integrations/workflow-automation/_category_.yml @@ -0,0 +1,2 @@ +label: Workflow automation +position: 4 diff --git a/sources/platform/integrations/workflows-and-notifications/activepieces.md b/sources/platform/integrations/workflow-automation/activepieces.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/activepieces.md rename to sources/platform/integrations/workflow-automation/activepieces.md diff --git a/sources/platform/integrations/workflows-and-notifications/bubble.md b/sources/platform/integrations/workflow-automation/bubble.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/bubble.md rename to sources/platform/integrations/workflow-automation/bubble.md diff --git a/sources/platform/integrations/workflows-and-notifications/gmail.md b/sources/platform/integrations/workflow-automation/gmail.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gmail.md rename to sources/platform/integrations/workflow-automation/gmail.md diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/apify_credential_gumloop.png b/sources/platform/integrations/workflow-automation/gumloop/images/apify_credential_gumloop.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/apify_credential_gumloop.png rename to sources/platform/integrations/workflow-automation/gumloop/images/apify_credential_gumloop.png diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/apify_task_runner_node.png b/sources/platform/integrations/workflow-automation/gumloop/images/apify_task_runner_node.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/apify_task_runner_node.png rename to sources/platform/integrations/workflow-automation/gumloop/images/apify_task_runner_node.png diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/apify_task_runner_node_library.png b/sources/platform/integrations/workflow-automation/gumloop/images/apify_task_runner_node_library.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/apify_task_runner_node_library.png rename to sources/platform/integrations/workflow-automation/gumloop/images/apify_task_runner_node_library.png diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/create_apify_task.png b/sources/platform/integrations/workflow-automation/gumloop/images/create_apify_task.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/create_apify_task.png rename to sources/platform/integrations/workflow-automation/gumloop/images/create_apify_task.png diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/generate_apify_token.png b/sources/platform/integrations/workflow-automation/gumloop/images/generate_apify_token.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/generate_apify_token.png rename to sources/platform/integrations/workflow-automation/gumloop/images/generate_apify_token.png diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/instagram/input-outputs.jpeg b/sources/platform/integrations/workflow-automation/gumloop/images/instagram/input-outputs.jpeg similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/instagram/input-outputs.jpeg rename to sources/platform/integrations/workflow-automation/gumloop/images/instagram/input-outputs.jpeg diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/instagram/mcp-node-image.jpeg b/sources/platform/integrations/workflow-automation/gumloop/images/instagram/mcp-node-image.jpeg similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/instagram/mcp-node-image.jpeg rename to sources/platform/integrations/workflow-automation/gumloop/images/instagram/mcp-node-image.jpeg diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/instagram/node.jpeg b/sources/platform/integrations/workflow-automation/gumloop/images/instagram/node.jpeg similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/instagram/node.jpeg rename to sources/platform/integrations/workflow-automation/gumloop/images/instagram/node.jpeg diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/instagram/prompt.jpeg b/sources/platform/integrations/workflow-automation/gumloop/images/instagram/prompt.jpeg similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/instagram/prompt.jpeg rename to sources/platform/integrations/workflow-automation/gumloop/images/instagram/prompt.jpeg diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/maps/input-outputs.jpeg b/sources/platform/integrations/workflow-automation/gumloop/images/maps/input-outputs.jpeg similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/maps/input-outputs.jpeg rename to sources/platform/integrations/workflow-automation/gumloop/images/maps/input-outputs.jpeg diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/maps/mcp-node-image.jpeg b/sources/platform/integrations/workflow-automation/gumloop/images/maps/mcp-node-image.jpeg similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/maps/mcp-node-image.jpeg rename to sources/platform/integrations/workflow-automation/gumloop/images/maps/mcp-node-image.jpeg diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/maps/node.jpeg b/sources/platform/integrations/workflow-automation/gumloop/images/maps/node.jpeg similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/maps/node.jpeg rename to sources/platform/integrations/workflow-automation/gumloop/images/maps/node.jpeg diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/maps/prompt.jpeg b/sources/platform/integrations/workflow-automation/gumloop/images/maps/prompt.jpeg similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/maps/prompt.jpeg rename to sources/platform/integrations/workflow-automation/gumloop/images/maps/prompt.jpeg diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/start_apify_task.png b/sources/platform/integrations/workflow-automation/gumloop/images/start_apify_task.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/start_apify_task.png rename to sources/platform/integrations/workflow-automation/gumloop/images/start_apify_task.png diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/tiktok/input-output.jpeg b/sources/platform/integrations/workflow-automation/gumloop/images/tiktok/input-output.jpeg similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/tiktok/input-output.jpeg rename to sources/platform/integrations/workflow-automation/gumloop/images/tiktok/input-output.jpeg diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/tiktok/mcp-node-image.jpeg b/sources/platform/integrations/workflow-automation/gumloop/images/tiktok/mcp-node-image.jpeg similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/tiktok/mcp-node-image.jpeg rename to sources/platform/integrations/workflow-automation/gumloop/images/tiktok/mcp-node-image.jpeg diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/tiktok/node.jpeg b/sources/platform/integrations/workflow-automation/gumloop/images/tiktok/node.jpeg similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/tiktok/node.jpeg rename to sources/platform/integrations/workflow-automation/gumloop/images/tiktok/node.jpeg diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/tiktok/prompt.jpeg b/sources/platform/integrations/workflow-automation/gumloop/images/tiktok/prompt.jpeg similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/tiktok/prompt.jpeg rename to sources/platform/integrations/workflow-automation/gumloop/images/tiktok/prompt.jpeg diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/youtube/input-outputs.jpeg b/sources/platform/integrations/workflow-automation/gumloop/images/youtube/input-outputs.jpeg similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/youtube/input-outputs.jpeg rename to sources/platform/integrations/workflow-automation/gumloop/images/youtube/input-outputs.jpeg diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/youtube/mcp-node-image.jpeg b/sources/platform/integrations/workflow-automation/gumloop/images/youtube/mcp-node-image.jpeg similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/youtube/mcp-node-image.jpeg rename to sources/platform/integrations/workflow-automation/gumloop/images/youtube/mcp-node-image.jpeg diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/youtube/node.jpeg b/sources/platform/integrations/workflow-automation/gumloop/images/youtube/node.jpeg similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/youtube/node.jpeg rename to sources/platform/integrations/workflow-automation/gumloop/images/youtube/node.jpeg diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/images/youtube/prompt.jpeg b/sources/platform/integrations/workflow-automation/gumloop/images/youtube/prompt.jpeg similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/images/youtube/prompt.jpeg rename to sources/platform/integrations/workflow-automation/gumloop/images/youtube/prompt.jpeg diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/index.md b/sources/platform/integrations/workflow-automation/gumloop/index.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/index.md rename to sources/platform/integrations/workflow-automation/gumloop/index.md diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/instagram.md b/sources/platform/integrations/workflow-automation/gumloop/instagram.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/instagram.md rename to sources/platform/integrations/workflow-automation/gumloop/instagram.md diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/maps.md b/sources/platform/integrations/workflow-automation/gumloop/maps.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/maps.md rename to sources/platform/integrations/workflow-automation/gumloop/maps.md diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/tiktok.md b/sources/platform/integrations/workflow-automation/gumloop/tiktok.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/tiktok.md rename to sources/platform/integrations/workflow-automation/gumloop/tiktok.md diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/youtube.md b/sources/platform/integrations/workflow-automation/gumloop/youtube.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/gumloop/youtube.md rename to sources/platform/integrations/workflow-automation/gumloop/youtube.md diff --git a/sources/platform/integrations/workflows-and-notifications/ifttt.md b/sources/platform/integrations/workflow-automation/ifttt.md similarity index 99% rename from sources/platform/integrations/workflows-and-notifications/ifttt.md rename to sources/platform/integrations/workflow-automation/ifttt.md index 0c700d8565..9f9421157f 100644 --- a/sources/platform/integrations/workflows-and-notifications/ifttt.md +++ b/sources/platform/integrations/workflow-automation/ifttt.md @@ -90,7 +90,7 @@ To use Apify as an action in your Applet: 1. Configure the action parameters: | Parameter | Description | Example Values | - |-----------|-------------|----------------| + | --- | --- | --- | | **Wait until run finishes** | Defines how the Actor should be executed. | `yes`, `no` | | **Input overrides** | JSON input that overrides the Actor's default input. | `{"key": "value"}` | | **Build** | Specifies the Actor build to run. Can be a build tag or build number. See [Builds](/platform/actors/running/runs-and-builds#builds) for more information. | `0.2.10`, `version-0` | diff --git a/sources/platform/integrations/workflows-and-notifications/kestra.md b/sources/platform/integrations/workflow-automation/kestra.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/kestra.md rename to sources/platform/integrations/workflow-automation/kestra.md diff --git a/sources/platform/integrations/workflows-and-notifications/make/ai-crawling.md b/sources/platform/integrations/workflow-automation/make/ai-crawling.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/ai-crawling.md rename to sources/platform/integrations/workflow-automation/make/ai-crawling.md diff --git a/sources/platform/integrations/workflows-and-notifications/make/amazon.md b/sources/platform/integrations/workflow-automation/make/amazon.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/amazon.md rename to sources/platform/integrations/workflow-automation/make/amazon.md diff --git a/sources/platform/integrations/workflows-and-notifications/make/facebook.md b/sources/platform/integrations/workflow-automation/make/facebook.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/facebook.md rename to sources/platform/integrations/workflow-automation/make/facebook.md diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/Apify_token_on_Make.png b/sources/platform/integrations/workflow-automation/make/images/Apify_token_on_Make.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/Apify_token_on_Make.png rename to sources/platform/integrations/workflow-automation/make/images/Apify_token_on_Make.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/ai-crawling/apify-token-for-module-on-make.png b/sources/platform/integrations/workflow-automation/make/images/ai-crawling/apify-token-for-module-on-make.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/ai-crawling/apify-token-for-module-on-make.png rename to sources/platform/integrations/workflow-automation/make/images/ai-crawling/apify-token-for-module-on-make.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/ai-crawling/image.png b/sources/platform/integrations/workflow-automation/make/images/ai-crawling/image.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/ai-crawling/image.png rename to sources/platform/integrations/workflow-automation/make/images/ai-crawling/image.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/ai-crawling/wcc-signup.png b/sources/platform/integrations/workflow-automation/make/images/ai-crawling/wcc-signup.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/ai-crawling/wcc-signup.png rename to sources/platform/integrations/workflow-automation/make/images/ai-crawling/wcc-signup.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/amazon/image.png b/sources/platform/integrations/workflow-automation/make/images/amazon/image.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/amazon/image.png rename to sources/platform/integrations/workflow-automation/make/images/amazon/image.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/amazon/image1.png b/sources/platform/integrations/workflow-automation/make/images/amazon/image1.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/amazon/image1.png rename to sources/platform/integrations/workflow-automation/make/images/amazon/image1.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/apify-console-token-for-make.png b/sources/platform/integrations/workflow-automation/make/images/apify-console-token-for-make.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/apify-console-token-for-make.png rename to sources/platform/integrations/workflow-automation/make/images/apify-console-token-for-make.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/facebook/actor-rental.png b/sources/platform/integrations/workflow-automation/make/images/facebook/actor-rental.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/facebook/actor-rental.png rename to sources/platform/integrations/workflow-automation/make/images/facebook/actor-rental.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/facebook/make-api-token.png b/sources/platform/integrations/workflow-automation/make/images/facebook/make-api-token.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/facebook/make-api-token.png rename to sources/platform/integrations/workflow-automation/make/images/facebook/make-api-token.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/facebook/signup.png b/sources/platform/integrations/workflow-automation/make/images/facebook/signup.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/facebook/signup.png rename to sources/platform/integrations/workflow-automation/make/images/facebook/signup.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/facebook/start-rental.png b/sources/platform/integrations/workflow-automation/make/images/facebook/start-rental.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/facebook/start-rental.png rename to sources/platform/integrations/workflow-automation/make/images/facebook/start-rental.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/instagram/Apify_Make_Sign_up_page.png b/sources/platform/integrations/workflow-automation/make/images/instagram/Apify_Make_Sign_up_page.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/instagram/Apify_Make_Sign_up_page.png rename to sources/platform/integrations/workflow-automation/make/images/instagram/Apify_Make_Sign_up_page.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/instagram/Apify_Token_for_modules_on_Make.png b/sources/platform/integrations/workflow-automation/make/images/instagram/Apify_Token_for_modules_on_Make.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/instagram/Apify_Token_for_modules_on_Make.png rename to sources/platform/integrations/workflow-automation/make/images/instagram/Apify_Token_for_modules_on_Make.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/llm/apify-token-for-module-on-make.png b/sources/platform/integrations/workflow-automation/make/images/llm/apify-token-for-module-on-make.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/llm/apify-token-for-module-on-make.png rename to sources/platform/integrations/workflow-automation/make/images/llm/apify-token-for-module-on-make.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/llm/rag-signup.png b/sources/platform/integrations/workflow-automation/make/images/llm/rag-signup.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/llm/rag-signup.png rename to sources/platform/integrations/workflow-automation/make/images/llm/rag-signup.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/maps/Screenshot_2025-04-22_at_12.45.33.png b/sources/platform/integrations/workflow-automation/make/images/maps/Screenshot_2025-04-22_at_12.45.33.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/maps/Screenshot_2025-04-22_at_12.45.33.png rename to sources/platform/integrations/workflow-automation/make/images/maps/Screenshot_2025-04-22_at_12.45.33.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/maps/image.png b/sources/platform/integrations/workflow-automation/make/images/maps/image.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/maps/image.png rename to sources/platform/integrations/workflow-automation/make/images/maps/image.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/maps/maps-signup.png b/sources/platform/integrations/workflow-automation/make/images/maps/maps-signup.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/maps/maps-signup.png rename to sources/platform/integrations/workflow-automation/make/images/maps/maps-signup.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/search/image 1.png b/sources/platform/integrations/workflow-automation/make/images/search/image 1.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/search/image 1.png rename to sources/platform/integrations/workflow-automation/make/images/search/image 1.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/search/image.png b/sources/platform/integrations/workflow-automation/make/images/search/image.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/search/image.png rename to sources/platform/integrations/workflow-automation/make/images/search/image.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/search/search-signup.png b/sources/platform/integrations/workflow-automation/make/images/search/search-signup.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/search/search-signup.png rename to sources/platform/integrations/workflow-automation/make/images/search/search-signup.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/tiktok/image.png b/sources/platform/integrations/workflow-automation/make/images/tiktok/image.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/tiktok/image.png rename to sources/platform/integrations/workflow-automation/make/images/tiktok/image.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/tiktok/image1.png b/sources/platform/integrations/workflow-automation/make/images/tiktok/image1.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/tiktok/image1.png rename to sources/platform/integrations/workflow-automation/make/images/tiktok/image1.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/youtube/image.png b/sources/platform/integrations/workflow-automation/make/images/youtube/image.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/youtube/image.png rename to sources/platform/integrations/workflow-automation/make/images/youtube/image.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/images/youtube/image1.png b/sources/platform/integrations/workflow-automation/make/images/youtube/image1.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/images/youtube/image1.png rename to sources/platform/integrations/workflow-automation/make/images/youtube/image1.png diff --git a/sources/platform/integrations/workflows-and-notifications/make/index.md b/sources/platform/integrations/workflow-automation/make/index.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/index.md rename to sources/platform/integrations/workflow-automation/make/index.md diff --git a/sources/platform/integrations/workflows-and-notifications/make/instagram.md b/sources/platform/integrations/workflow-automation/make/instagram.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/instagram.md rename to sources/platform/integrations/workflow-automation/make/instagram.md diff --git a/sources/platform/integrations/workflows-and-notifications/make/llm.md b/sources/platform/integrations/workflow-automation/make/llm.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/llm.md rename to sources/platform/integrations/workflow-automation/make/llm.md diff --git a/sources/platform/integrations/workflows-and-notifications/make/maps.md b/sources/platform/integrations/workflow-automation/make/maps.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/maps.md rename to sources/platform/integrations/workflow-automation/make/maps.md diff --git a/sources/platform/integrations/workflows-and-notifications/make/search.md b/sources/platform/integrations/workflow-automation/make/search.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/search.md rename to sources/platform/integrations/workflow-automation/make/search.md diff --git a/sources/platform/integrations/workflows-and-notifications/make/tiktok.md b/sources/platform/integrations/workflow-automation/make/tiktok.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/tiktok.md rename to sources/platform/integrations/workflow-automation/make/tiktok.md diff --git a/sources/platform/integrations/workflows-and-notifications/make/youtube.md b/sources/platform/integrations/workflow-automation/make/youtube.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/make/youtube.md rename to sources/platform/integrations/workflow-automation/make/youtube.md diff --git a/sources/platform/integrations/workflows-and-notifications/n8n/images/config.png b/sources/platform/integrations/workflow-automation/n8n/images/config.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/n8n/images/config.png rename to sources/platform/integrations/workflow-automation/n8n/images/config.png diff --git a/sources/platform/integrations/workflows-and-notifications/n8n/images/credentials.png b/sources/platform/integrations/workflow-automation/n8n/images/credentials.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/n8n/images/credentials.png rename to sources/platform/integrations/workflow-automation/n8n/images/credentials.png diff --git a/sources/platform/integrations/workflows-and-notifications/n8n/images/install.png b/sources/platform/integrations/workflow-automation/n8n/images/install.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/n8n/images/install.png rename to sources/platform/integrations/workflow-automation/n8n/images/install.png diff --git a/sources/platform/integrations/workflows-and-notifications/n8n/images/operations.png b/sources/platform/integrations/workflow-automation/n8n/images/operations.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/n8n/images/operations.png rename to sources/platform/integrations/workflow-automation/n8n/images/operations.png diff --git a/sources/platform/integrations/workflows-and-notifications/n8n/images/result.png b/sources/platform/integrations/workflow-automation/n8n/images/result.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/n8n/images/result.png rename to sources/platform/integrations/workflow-automation/n8n/images/result.png diff --git a/sources/platform/integrations/workflows-and-notifications/n8n/images/setup.png b/sources/platform/integrations/workflow-automation/n8n/images/setup.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/n8n/images/setup.png rename to sources/platform/integrations/workflow-automation/n8n/images/setup.png diff --git a/sources/platform/integrations/workflows-and-notifications/n8n/images/token.png b/sources/platform/integrations/workflow-automation/n8n/images/token.png similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/n8n/images/token.png rename to sources/platform/integrations/workflow-automation/n8n/images/token.png diff --git a/sources/platform/integrations/workflows-and-notifications/n8n/index.md b/sources/platform/integrations/workflow-automation/n8n/index.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/n8n/index.md rename to sources/platform/integrations/workflow-automation/n8n/index.md diff --git a/sources/platform/integrations/workflows-and-notifications/n8n/website-content-crawler.md b/sources/platform/integrations/workflow-automation/n8n/website-content-crawler.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/n8n/website-content-crawler.md rename to sources/platform/integrations/workflow-automation/n8n/website-content-crawler.md diff --git a/sources/platform/integrations/workflows-and-notifications/slack.md b/sources/platform/integrations/workflow-automation/slack.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/slack.md rename to sources/platform/integrations/workflow-automation/slack.md diff --git a/sources/platform/integrations/workflows-and-notifications/telegram.md b/sources/platform/integrations/workflow-automation/telegram.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/telegram.md rename to sources/platform/integrations/workflow-automation/telegram.md diff --git a/sources/platform/integrations/workflows-and-notifications/windmill.md b/sources/platform/integrations/workflow-automation/windmill.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/windmill.md rename to sources/platform/integrations/workflow-automation/windmill.md diff --git a/sources/platform/integrations/workflows-and-notifications/workato.md b/sources/platform/integrations/workflow-automation/workato.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/workato.md rename to sources/platform/integrations/workflow-automation/workato.md diff --git a/sources/platform/integrations/workflows-and-notifications/zapier.md b/sources/platform/integrations/workflow-automation/zapier.md similarity index 100% rename from sources/platform/integrations/workflows-and-notifications/zapier.md rename to sources/platform/integrations/workflow-automation/zapier.md diff --git a/sources/platform/integrations/workflows-and-notifications/_category_.yml b/sources/platform/integrations/workflows-and-notifications/_category_.yml deleted file mode 100644 index 836d96ded0..0000000000 --- a/sources/platform/integrations/workflows-and-notifications/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: Workflows & notifications -position: 4 diff --git a/sources/platform/proxy/datacenter_proxy.md b/sources/platform/proxy/datacenter_proxy.md index 1cf81cb789..35d61261d8 100644 --- a/sources/platform/proxy/datacenter_proxy.md +++ b/sources/platform/proxy/datacenter_proxy.md @@ -1,7 +1,7 @@ --- title: Datacenter proxy description: Learn how to reduce blocking when web scraping using IP address rotation. See proxy parameters and learn to implement Apify Proxy in an application. -sidebar_position: 10.2 +sidebar_position: 3 slug: /proxy/datacenter-proxy --- diff --git a/sources/platform/proxy/google_serp_proxy.md b/sources/platform/proxy/google_serp_proxy.md index ddc39a0f7b..1651dc1b72 100644 --- a/sources/platform/proxy/google_serp_proxy.md +++ b/sources/platform/proxy/google_serp_proxy.md @@ -1,7 +1,7 @@ --- title: Google SERP proxy description: Learn how to collect search results from Google Search-powered tools. Get search results from localized domains in multiple countries, e.g. the US and Germany. -sidebar_position: 10.4 +sidebar_position: 5 slug: /proxy/google-serp-proxy --- diff --git a/sources/platform/proxy/index.md b/sources/platform/proxy/index.md index 1ae1bf2e06..fe32dd63c2 100644 --- a/sources/platform/proxy/index.md +++ b/sources/platform/proxy/index.md @@ -1,7 +1,7 @@ --- title: Proxy description: Learn to anonymously access websites in scraping/automation jobs. Improve data outputs and efficiency of bots, and access websites from various geographies. -sidebar_position: 10 +sidebar_position: 1 category: platform slug: /proxy --- diff --git a/sources/platform/proxy/residential_proxy.md b/sources/platform/proxy/residential_proxy.md index f65470e661..204af241c2 100644 --- a/sources/platform/proxy/residential_proxy.md +++ b/sources/platform/proxy/residential_proxy.md @@ -1,7 +1,7 @@ --- title: Residential proxy description: Achieve a higher level of anonymity using IP addresses from human users. Access a wider pool of proxies and reduce blocking by websites' anti-scraping measures. -sidebar_position: 10.3 +sidebar_position: 4 slug: /proxy/residential-proxy --- diff --git a/sources/platform/proxy/usage.md b/sources/platform/proxy/usage.md index 0203aeb2f4..f741ec8a83 100644 --- a/sources/platform/proxy/usage.md +++ b/sources/platform/proxy/usage.md @@ -1,7 +1,7 @@ --- title: Proxy usage description: Learn how to configure and use Apify Proxy. See the required parameters such as the correct username and password. -sidebar_position: 10.1 +sidebar_position: 2 slug: /proxy/usage --- @@ -28,12 +28,12 @@ All usage of Apify Proxy with your password is charged towards your account. Do If you want to connect to Apify Proxy from outside of the Apify Platform, you need to have a paid Apify plan (to prevent abuse). If you need to test Apify Proxy before you subscribe, please [contact our support](https://apify.com/contact). -| Parameter | Value / explanation | -|---------------------|---------------------| -| Hostname | `proxy.apify.com`| -| Port | `8000` | -| Username | Specifies the proxy parameters such as groups, [session](#sessions) and location. See [username parameters](#username-parameters) below for details.
    **Note**: this is not your Apify username.| -| Password | Apify Proxy password. Your password is displayed on the [Proxy](https://console.apify.com/proxy/groups) page in Apify Console.
    **Note**: this is not your Apify account password. | +| Parameter | Value / explanation | +| --- | --- | +| Hostname | `proxy.apify.com` | +| Port | `8000` | +| Username | Specifies the proxy parameters such as groups, [session](#sessions) and location. See [username parameters](#username-parameters) below for details.
    **Note**: this is not your Apify username. | +| Password | Apify Proxy password. Your password is displayed on the [Proxy](https://console.apify.com/proxy/groups) page in Apify Console.
    **Note**: this is not your Apify account password. | :::caution If you use these connection parameters for connecting to Apify Proxy from your Actors running on the Apify Platform, the connection will still be considered external, it will not work on the Free plan, and on paid plans you will be charged for external data transfer. Please use the connection parameters from the [Connection from Actors](#connection-from-actors) section when using Apify Proxy from Actors. @@ -52,12 +52,12 @@ If you want to connect to Apify Proxy from Actors running on the Apify Platform, If you don't want to use these helpers, and want to connect to Apify Proxy manually, you can find the right configuration values in [environment variables](../actors/development/programming_interface/environment_variables.md) provided to the Actor. By using this configuration, you ensure that you connect to Apify Proxy directly through the Apify infrastructure, bypassing any external connection via the Internet, thereby improving the connection speed, and ensuring you don't pay for external data transfer. -| Parameter | Source / explanation | -|---------------------|---------------------| -| Hostname | `APIFY_PROXY_HOSTNAME` environment variable | -| Port | `APIFY_PROXY_PORT` environment variable | -| Username | Specifies the proxy parameters such as groups, [session](#sessions) and location. See [username parameters](#username-parameters) below for details.
    **Note**: this is not your Apify username.| -| Password | `APIFY_PROXY_PASSWORD` environment variable | +| Parameter | Source / explanation | +| --- | --- | +| Hostname | `APIFY_PROXY_HOSTNAME` environment variable | +| Port | `APIFY_PROXY_PORT` environment variable | +| Username | Specifies the proxy parameters such as groups, [session](#sessions) and location. See [username parameters](#username-parameters) below for details.
    **Note**: this is not your Apify username. | +| Password | `APIFY_PROXY_PASSWORD` environment variable | Example connection string creation: diff --git a/sources/platform/proxy/your_own_proxies.md b/sources/platform/proxy/your_own_proxies.md index 3f2be86712..0a6e917897 100644 --- a/sources/platform/proxy/your_own_proxies.md +++ b/sources/platform/proxy/your_own_proxies.md @@ -1,7 +1,7 @@ --- title: Using your own proxies description: Learn how to use your own proxies while using the Apify platform. -sidebar_position: 10.5 +sidebar_position: 6 slug: /proxy/using-your-own-proxies --- diff --git a/sources/platform/security.md b/sources/platform/security.md index ec13e53011..a84028b9d2 100644 --- a/sources/platform/security.md +++ b/sources/platform/security.md @@ -1,8 +1,7 @@ --- title: Security description: Learn more about Apify's security practices and data protection measures that are used to protect your Actors, their data, and the Apify platform in general. -sidebar_position: 15 -category: platform +sidebar_position: 7 slug: /security --- @@ -111,4 +110,4 @@ Please adhere strictly to the following rules. Failure to do so may result in le ## Securing your data -The Apify platform provides you with multiple ways to secure your data, including [encrypted environment variables](./actors/development/programming_interface/environment_variables.md) for storing your configuration secrets and [encrypted input](./actors/development/actor_definition/input_schema/secret_input.md) for securing the input parameters of your Actors. +The Apify platform provides you with multiple ways to secure your data, including [encrypted environment variables](./actors/development/programming_interface/environment_variables.md) for storing your configuration secrets and [encrypted input](./actors/development/input_output_schemas/secret_input.md) for securing the input parameters of your Actors. diff --git a/sources/platform/sidebars.js b/sources/platform/sidebars.js index 8494ebdd6a..8dee16cd88 100644 --- a/sources/platform/sidebars.js +++ b/sources/platform/sidebars.js @@ -1,8 +1,44 @@ module.exports = { - docs: [ + getStarted: [ { type: 'autogenerated', - dirName: '.', + dirName: 'get-started', + }, + ], + actors: [ + { + type: 'autogenerated', + dirName: 'actors', + }, + ], + storage: [ + { + type: 'autogenerated', + dirName: 'storage', + }, + ], + proxy: [ + { + type: 'autogenerated', + dirName: 'proxy', + }, + ], + integrations: [ + { + type: 'autogenerated', + dirName: 'integrations', + }, + ], + account: [ + { + type: 'autogenerated', + dirName: 'account', + }, + ], + security: [ + { + type: 'doc', + id: 'security', }, ], }; diff --git a/sources/platform/storage/dataset.md b/sources/platform/storage/dataset.md index b56d6008d9..8a12624c10 100644 --- a/sources/platform/storage/dataset.md +++ b/sources/platform/storage/dataset.md @@ -1,7 +1,7 @@ --- title: Dataset description: Store and export web scraping, crawling or data processing job results. Learn how to access and manage datasets in Apify Console or via API. -sidebar_position: 9.2 +sidebar_position: 3 toc_max_heading_level: 4 slug: /storage/dataset --- @@ -43,7 +43,7 @@ To view or download a dataset: 2. Select the format & configure other options if desired in **Export dataset** section. 3. Click **Download**. -Utilize the **Actions** menu to modify the dataset's name, which also affects its [retention period](/platform/storage/usage#data-retention), and to adjust [access rights](../collaboration/index.md). The **API** button allows you to explore and test the dataset's [API endpoints](/api/v2/storage-datasets). +Utilize the **Actions** menu to modify the dataset's name, which also affects its [retention period](/platform/storage/usage#data-retention), and to adjust [access rights](../account/index.md). The **API** button allows you to explore and test the dataset's [API endpoints](/api/v2/storage-datasets). ![Datasets detail view](./images/datasets-detail.png) @@ -53,7 +53,7 @@ The [Apify API](/api/v2/storage-datasets) enables you programmatic access to you If you are accessing your datasets using the `username~store-name` [store ID format](./index.md), you will need to use your secret API token. You can find the token (and your user ID) on the [Integrations](https://console.apify.com/account#/integrations)tab of **Settings** page of your Apify account. -> When providing your API authentication token, we recommend using the request's `Authorization` header, rather than the URL. ([More info](../integrations/programming/api.md#authentication)). +> When providing your API authentication token, we recommend using the request's `Authorization` header, rather than the URL. ([More info](../integrations/api-and-webhooks/api.md#authentication)). To retrieve a list of your datasets, send a GET request to the [Get list of datasets](/api/v2/datasets-get) endpoint. @@ -380,11 +380,11 @@ By default, the whole result is wrapped in an `` element, while each pag ## Sharing -You can grant [access rights](../collaboration/index.md) to your dataset through the **Share** button under the **Actions** menu. For more details, check the [full list of permissions](../collaboration/list_of_permissions.md). +You can grant [access rights](../account/index.md) to your dataset through the **Share** button under the **Actions** menu. For more details, check the [full list of permissions](../account/list_of_permissions.md). -You can also share datasets by link using their ID or name, depending on your account or resource-level general access setting. Learn how link-based access works in [General resource access](/platform/collaboration/general-resource-access). +You can also share datasets by link using their ID or name, depending on your account or resource-level general access setting. Learn how link-based access works in [General resource access](/platform/account/general-resource-access). -For one-off sharing of specific records when access is restricted, you can generate time-limited pre-signed URLs. See [Sharing restricted resources with pre-signed URLs](/platform/collaboration/general-resource-access#pre-signed-urls). +For one-off sharing of specific records when access is restricted, you can generate time-limited pre-signed URLs. See [Sharing restricted resources with pre-signed URLs](/platform/account/general-resource-access#pre-signed-urls). ### Sharing datasets between runs diff --git a/sources/platform/storage/index.md b/sources/platform/storage/index.md index 5682d4a8f7..4a0c97b62d 100644 --- a/sources/platform/storage/index.md +++ b/sources/platform/storage/index.md @@ -1,7 +1,7 @@ --- title: Storage description: Store anything from images and key-value pairs to structured output data. Learn how to access and manage your stored data from the Apify platform or via API. -sidebar_position: 9 +sidebar_position: 1 category: platform slug: /storage --- diff --git a/sources/platform/storage/key_value_store.md b/sources/platform/storage/key_value_store.md index 8d4bb85d6c..0057f3ee77 100644 --- a/sources/platform/storage/key_value_store.md +++ b/sources/platform/storage/key_value_store.md @@ -2,7 +2,7 @@ title: Key-value store description: Store anything from Actor or task run results, JSON documents, or images. Learn how to access and manage key-value stores from Apify Console or via API. toc_max_heading_level: 4 -sidebar_position: 9.3 +sidebar_position: 4 slug: /storage/key-value-store --- @@ -37,7 +37,7 @@ In [Apify Console](https://console.apify.com), you can view your key-value store ![Key-value stores in app](./images/key-value-stores-app.png) -To view a key-value store's content, click on its **Store ID**. Under the **Actions** menu, you can rename your store (which extends its [retention period](/platform/storage/usage#named-and-unnamed-storages)) and grant [access rights](../collaboration/index.md) using the **Share** button. +To view a key-value store's content, click on its **Store ID**. Under the **Actions** menu, you can rename your store (which extends its [retention period](/platform/storage/usage#named-and-unnamed-storages)) and grant [access rights](../account/index.md) using the **Share** button. Click on the **API** button to view and test a store's [API endpoints](/api/v2/storage-key-value-stores). ![Key-value stores detail](./images/key-value-stores-detail-header.png) @@ -60,7 +60,7 @@ If you are accessing your datasets using the `username~store-name` [store ID for :::tip Authentication -When providing your API authentication token, we recommend using the request's `Authorization` header, rather than the URL. For more information, refer to the [API integration](../integrations/programming/api.md#authentication) documentation. +When providing your API authentication token, we recommend using the request's `Authorization` header, rather than the URL. For more information, refer to the [API integration](../integrations/api-and-webhooks/api.md#authentication) documentation. ::: @@ -267,11 +267,11 @@ _Using the [JavaScript SDK](/sdk/js/reference/class/KeyValueStore#setValue) or o ## Sharing -You can grant [access rights](../collaboration/index.md) to your key-value store through the **Share** button under the **Actions** menu. For more details check the [full list of permissions](../collaboration/list_of_permissions.md). +You can grant [access rights](../account/index.md) to your key-value store through the **Share** button under the **Actions** menu. For more details check the [full list of permissions](../account/list_of_permissions.md). -You can also share key-value stores by link using their ID or name, depending on your account or resource-level general access setting. Learn how link-based access works in [General resource access](/platform/collaboration/general-resource-access). +You can also share key-value stores by link using their ID or name, depending on your account or resource-level general access setting. Learn how link-based access works in [General resource access](/platform/account/general-resource-access). -For one-off sharing of specific records when access is restricted, you can generate time-limited pre-signed URLs. See [Sharing restricted resources with pre-signed URLs](/platform/collaboration/general-resource-access#pre-signed-urls). +For one-off sharing of specific records when access is restricted, you can generate time-limited pre-signed URLs. See [Sharing restricted resources with pre-signed URLs](/platform/account/general-resource-access#pre-signed-urls). ### Sharing key-value stores between runs diff --git a/sources/platform/storage/request_queue.md b/sources/platform/storage/request_queue.md index 32c0fa87b4..63fe55e96f 100644 --- a/sources/platform/storage/request_queue.md +++ b/sources/platform/storage/request_queue.md @@ -2,7 +2,7 @@ title: Request queue description: Queue URLs for an Actor to visit in its run. Learn how to share your queues between Actor runs. Access and manage request queues from Apify Console or via API. toc_max_heading_level: 4 -sidebar_position: 9.4 +sidebar_position: 5 slug: /storage/request-queue --- @@ -37,7 +37,7 @@ In the [Apify Console](https://console.apify.com), you can view your request que To view a request queue, click on its **Queue ID**. Under the **Actions** menu, you can rename your queue's name (and, in turn, its -[retention period](/platform/storage/usage#named-and-unnamed-storages)) and [access rights](../collaboration/index.md) using the **Share** button. +[retention period](/platform/storage/usage#named-and-unnamed-storages)) and [access rights](../account/index.md) using the **Share** button. Click on the **API** button to view and test a queue's [API endpoints](/api/v2/storage-request-queues). ![Request queues detail](./images/request-queue-detail.png) @@ -48,7 +48,7 @@ The [Apify API](/api/v2/storage-request-queues) allows you programmatic access t If you are accessing your datasets using the `username~store-name` [store ID format](./index.md), you will need to use your secret API token. You can find the token (and your user ID) on the [Integrations](https://console.apify.com/account#/integrations) page of your Apify account. -> When providing your API authentication token, we recommend using the request's `Authorization` header, rather than the URL. ([More info](../integrations/programming/api.md#authentication)). +> When providing your API authentication token, we recommend using the request's `Authorization` header, rather than the URL. ([More info](../integrations/api-and-webhooks/api.md#authentication)). To get a list of your request queues, send a GET request to the [Get list of request queues](/api/v2/request-queues-get) endpoint. @@ -556,11 +556,11 @@ A detailed tutorial on how to process one request queue with multiple Actor runs ## Sharing -You can grant [access rights](../collaboration/index.md) to your request queue through the **Share** button under the **Actions** menu. For more details check the [full list of permissions](../collaboration/list_of_permissions.md). +You can grant [access rights](../account/index.md) to your request queue through the **Share** button under the **Actions** menu. For more details check the [full list of permissions](../account/list_of_permissions.md). -You can also share request queues by link using their ID or name, depending on your account or resource-level general access setting. Learn how link-based access works in [General resource access](/platform/collaboration/general-resource-access). +You can also share request queues by link using their ID or name, depending on your account or resource-level general access setting. Learn how link-based access works in [General resource access](/platform/account/general-resource-access). -For one-off sharing of specific records when access is restricted, you can generate time-limited pre-signed URLs. See [Sharing restricted resources with pre-signed URLs](/platform/collaboration/general-resource-access#pre-signed-urls). +For one-off sharing of specific records when access is restricted, you can generate time-limited pre-signed URLs. See [Sharing restricted resources with pre-signed URLs](/platform/account/general-resource-access#pre-signed-urls). ### Sharing request queues between runs diff --git a/sources/platform/storage/usage.md b/sources/platform/storage/usage.md index ac55550620..94ac51631e 100644 --- a/sources/platform/storage/usage.md +++ b/sources/platform/storage/usage.md @@ -1,7 +1,7 @@ --- title: Storage usage description: Learn how to effectively use Apify's storage options. Understand key aspects of data retention, rate limiting, and secure sharing. -sidebar_position: 9.1 +sidebar_position: 2 category: platform slug: /storage/usage --- @@ -160,11 +160,11 @@ For example, storage names `janedoe~my-storage-1` and `janedoe~web-scrape-result ## Sharing -You can grant [access rights](../collaboration/index.md) to other Apify users to view or modify your storages. Check the [full list of permissions](../collaboration/list_of_permissions.md). +You can grant [access rights](../account/index.md) to other Apify users to view or modify your storages. Check the [full list of permissions](../account/list_of_permissions.md). -You can also share storages by link using their ID or name, depending on your account or resource-level general access setting. Learn how link-based access works in [General resource access](/platform/collaboration/general-resource-access). +You can also share storages by link using their ID or name, depending on your account or resource-level general access setting. Learn how link-based access works in [General resource access](/platform/account/general-resource-access). -For one-off sharing when access is restricted, generate time-limited pre-signed URLs. See [Sharing restricted resources with pre-signed URLs](/platform/collaboration/general-resource-access#pre-signed-urls). +For one-off sharing when access is restricted, generate time-limited pre-signed URLs. See [Sharing restricted resources with pre-signed URLs](/platform/account/general-resource-access#pre-signed-urls). :::tip Accessing restricted storage resources via API @@ -186,7 +186,7 @@ Storage can be accessed from any [Actor](../actors/index.mdx) or [task](../actor :::info Accessing restricted storage resources between runs If a storage resource access is set to **Restricted**,the run from which it's accessed must have explicit access to it. -Learn how restricted access works in [General resource access](/platform/collaboration/general-resource-access). +Learn how restricted access works in [General resource access](/platform/account/general-resource-access). :::