diff --git a/docs-vs-console-discrepancies.md b/docs-vs-console-discrepancies.md new file mode 100644 index 0000000000..6698ceae1d --- /dev/null +++ b/docs-vs-console-discrepancies.md @@ -0,0 +1,212 @@ +# Documentation vs Console discrepancies + +Audit performed on 2026-03-20 against local Apify Console at localhost:3000. + +## 1. Console homepage: "Homepage" vs "Dashboard" + +**File**: `sources/platform/console/index.md` + +- **Docs say**: Section heading "Homepage overview", references the page as "homepage" +- **Actual Console**: The page heading is "Dashboard" and the sidebar item is "Dashboard" +- **Docs keyboard shortcut**: Lists "Home" with shortcut GH +- **Actual**: The sidebar says "Dashboard", not "Home" +- **Fix**: Rename "Homepage overview" to "Dashboard overview", update references to use "Dashboard" + +## 2. Console navigation: missing "Dashboard" sidebar item + +**File**: `sources/platform/console/index.md` + +- **Docs**: The navigation table (lines 111-123) does not include "Dashboard" as a sidebar item +- **Actual**: "Dashboard" is a sidebar item at `/`, positioned between "Apify Store" and "Actors" +- **Fix**: Add "Dashboard" row to the navigation table + +## 3. Sign-up/sign-in buttons: wrong button labels + +**File**: `sources/platform/console/index.md` + +- **Docs say**: "Sign up with Google" / "Sign up with GitHub" buttons +- **Actual**: Buttons say "Continue with Google" / "Continue with GitHub" +- **Docs say**: References "sign-in" throughout +- **Actual**: The page heading says "Log in to Apify" +- **Fix**: Update button labels to match actual UI + +## 4. Settings tab name: "Integrations" vs "API & Integrations" + +**File**: `sources/platform/console/settings.md` + +- **Docs say**: "The **Integrations** tab" +- **Actual**: The tab is called "**API & Integrations**" +- **Fix**: Update tab name to "API & Integrations" + +## 5. Settings: missing "Referrals" tab + +**File**: `sources/platform/console/settings.md` + +- **Docs**: Do not mention the "Referrals" tab at all +- **Actual**: There is a "Referrals" tab in Settings, positioned after "Notifications" +- **Fix**: Add a section describing the Referrals tab + +## 6. Settings: "API & Integrations" content description outdated + +**File**: `sources/platform/console/settings.md` + +- **Docs say**: Mentions "Slack workspace" integration specifically and "Actor Integration Accounts" +- **Actual**: The tab shows "API tokens" section, "Third-party apps & services", "Account-level integrations" with generic "Add account" button, and "Actor OAuth accounts" +- **Fix**: Update description to match actual sections + +## 7. Billing tab name: "Subscriptions" vs "Subscription" + +**File**: `sources/platform/console/billing.md` + +- **Docs say**: "The **Subscriptions** tab" +- **Actual**: The tab is called "**Subscription**" (singular) +- **Fix**: Change "Subscriptions" to "Subscription" + +## 8. Schedules: outdated Console URLs + +**File**: `sources/platform/schedules.md` + +- **Docs reference**: `https://console.apify.com/account?tab=integrations` for secret API token +- **Docs reference**: `https://console.apify.com/account#/integrations` for user ID +- **Actual**: The correct URL is `https://console.apify.com/settings/integrations` +- **Fix**: Update URLs to point to correct settings path + +## 9. Actors page: "Pay per usage" pricing label not documented + +**File**: `sources/platform/actors/running/store.md` + +- **Docs say**: Three pricing models: "Pay per event", "Pay per result", "Rental" +- **Actual Console**: Some Actors show "Pay per usage" as their pricing model label in the Actors table +- **Note**: "Pay per usage" appears to be the standard platform-usage-only pricing model (no additional per-event or per-result charges). The docs only describe the three store-specific pricing models but don't mention the "Pay per usage" label that appears in Console. +- **Fix**: Add note about "Pay per usage" as the default model for Actors that only charge platform usage costs + +## 10. Settings: "Login & Privacy" tab not separately described + +**File**: `sources/platform/console/settings.md` + +- **Docs**: Mention "Login & Privacy" in an info box but list login info under the Account section bullet points +- **Actual**: "Login & Privacy" is its own separate tab (distinct from "Account"), containing sign-in methods, password reset, two-factor authentication, and session configuration +- **Fix**: Restructure to describe Login & Privacy as its own section/tab + +## 11. Widespread outdated `/account` URLs across the codebase + +**Affected files** (30+ files): + +- Multiple integration docs reference `console.apify.com/account?tab=integrations`, `console.apify.com/account#/integrations`, or `console.apify.com/account/integrations` +- Organization docs reference `console.apify.com/account#/myorganizations` and `console.apify.com/account#/myorganization` +- Storage docs, monitoring docs, academy docs, and API reference docs all contain old URLs +- **Actual**: Settings is at `console.apify.com/settings/integrations`, organizations at `console.apify.com/settings/organizations` +- **Fix**: Updated all occurrences across the codebase + +## 12. Widespread "Settings > Integrations" instead of "Settings > API & Integrations" + +**Affected files** (20+ files): + +- Many integration docs (Make, n8n, Gumloop, Telegram, Slack, Keboola, etc.) refer to the tab as "Settings > Integrations" in prose text +- **Actual**: The Settings tab is called "API & Integrations" +- **Fix**: Updated text references to "Settings > API & Integrations" across all affected files + +--- + +## Second-round findings (step-by-step tutorial walkthrough) + +## 13. Actor running tutorial: wrong button labels + +**File**: `sources/platform/actors/running/index.md` + +- **Docs say**: "click **Use Actor**" then "click **Save & Start**" +- **Actual Console**: There is no "Use Actor" button on the Actor detail page. The run button says **"Start"**, not "Save & Start" +- **Fix**: Updated to remove "Use Actor" reference and changed "Save & Start" to "Start" + +## 14. Actor tasks: wrong "Create task" button label + +**File**: `sources/platform/actors/running/tasks.md` + +- **Docs say**: "click the **Create task** button" +- **Actual Console**: The button says **"Save as a new task"** +- **Fix**: Updated button label + +## 15. Schedules: wrong "Add" button label and nonexistent "Save & activate" + +**File**: `sources/platform/schedules.md` + +- **Docs say**: "Click on the **Add** dropdown" +- **Actual Console**: Button says **"Add new"** +- **Docs say**: "click **Save & activate**" +- **Actual Console**: No such button exists. Schedules are created in an enabled state; you toggle with **Disable**/**Enable** button +- **Fix**: Updated button label and replaced "Save & activate" description + +## 16. Dataset detail: outdated export flow description + +**File**: `sources/platform/storage/dataset.md` + +- **Docs say**: "Select the format in **Export dataset** section" then "Click **Download**" +- **Actual Console**: There is an **Export** button (not an "Export dataset" section), and data can be viewed in **Table** or **JSON** format. There is no separate **Download** button. +- **Fix**: Updated the export flow to match actual UI + +## 18. Web IDE guide: wrong intro paragraph + +**File**: `sources/platform/actors/development/quick-start/start_web_ide.md` + +- **Docs say**: "You'll start by creating and running it locally with the Apify CLI" +- **Actual**: This guide is about the Web IDE, not the CLI. The intro was copied from the local development guide. +- **Fix**: Rewrote the intro to accurately describe the Web IDE workflow + +## 19. Web IDE guide: outdated template name and New Actor page layout + +**File**: `sources/platform/actors/development/quick-start/start_web_ide.md` + +- **Docs say**: "templates for JavaScript, TypeScript, and Python" and "proceed with **Crawlee + Puppeteer + Chrome**" +- **Actual New Actor page**: Shows three sections - "Link a Git repository", "Select a code template", and "Push your code with Apify CLI". The default templates shown are "Crawlee + Cheerio" variants, not "Crawlee + Puppeteer + Chrome" +- **Fix**: Updated to describe the actual page layout and use "Crawlee + Cheerio" template name + +## 20. Web IDE guide: minor tab capitalization + +**File**: `sources/platform/actors/development/quick-start/start_web_ide.md` + +- **Docs say**: "Last Run" (capitalized R) +- **Actual**: Tab says "Last run" (lowercase r) +- **Fix**: Updated to "Last run" + +## 21. Builds doc: wrong button label "Start" instead of "Build" + +**File**: `sources/platform/actors/development/builds_and_runs/builds.md` + +- **Docs say**: "Locate the **Start** button. Next to it, click on the arrow & choose **Clean build**" +- **Actual Console**: The button says **"Build"**, not "Start" +- **Fix**: Updated "Start" to "Build" + +## 22. General resource access: wrong settings tab name + +**File**: `sources/platform/collaboration/general-resource-access.md` + +- **Docs say**: "Settings → Security & Privacy" +- **Actual Console**: For personal accounts, the tab is **"Login & Privacy"** (not "Security & Privacy") +- Also docs say "Account Settings → Privacy" for run sharing - actual is "Settings → Login & Privacy → Share run data with developers" +- **Fix**: Updated both references + +## 23. Google Drive integration: wrong integration name + +**File**: `sources/platform/integrations/data-storage/drive.md` + +- **Docs say**: click on the **"Upload file"** integration +- **Actual Console**: The integration is called **"Upload results to GDrive"** +- **Fix**: Updated integration name + +## 24. Gmail integration: wrong integration name + +**File**: `sources/platform/integrations/workflows-and-notifications/gmail.md` + +- **Docs say**: "click on Send email generic integration" +- **Actual Console**: The integration is called **"Send results email via Gmail"** +- **Fix**: Updated integration name + +## 17. Actor detail page: tabs don't match documentation structure + +**Observed in Console** (for own Actors in development mode): + +Main tabs: Source, Information, Runs, Builds, Integrations, Monitoring, Issues, Saved tasks, Settings, Publication + +Inner source tabs: Code, Last build, Input, Last run + +This differs from what's implied in the running tutorial docs, which describe a simpler view with just Input/Output tabs. The development mode view has a significantly different tab structure than the store Actor view. diff --git a/sources/academy/platform/expert_scraping_with_apify/solutions/integrating_webhooks.md b/sources/academy/platform/expert_scraping_with_apify/solutions/integrating_webhooks.md index 7c994d4e2a..4f4bd6bda5 100644 --- a/sources/academy/platform/expert_scraping_with_apify/solutions/integrating_webhooks.md +++ b/sources/academy/platform/expert_scraping_with_apify/solutions/integrating_webhooks.md @@ -180,7 +180,7 @@ Actor detail https://console.apify.com/actors/Yk1bieximsduYDydP Success: Actor was deployed to Apify cloud and built there. ``` -The URLs tell us that our Actor's ID is `Yk1bieximsduYDydP`. With this `actorId`, and our `token`, which is retrievable through **Settings > Integrations** in Apify Console, we can construct a link which will call the Actor: +The URLs tell us that our Actor's ID is `Yk1bieximsduYDydP`. With this `actorId`, and our `token`, which is retrievable through **Settings > API & Integrations** in Apify Console, we can construct a link which will call the Actor: ```text https://api.apify.com/v2/acts/Yk1bieximsduYDydP/runs?token=YOUR_TOKEN_HERE diff --git a/sources/academy/platform/getting_started/apify_client.md b/sources/academy/platform/getting_started/apify_client.md index a1d8d531e8..14edeaa771 100644 --- a/sources/academy/platform/getting_started/apify_client.md +++ b/sources/academy/platform/getting_started/apify_client.md @@ -62,7 +62,7 @@ from apify_client import ApifyClient In the last lesson, we ran the **adding-actor** and retrieved its dataset items. That's exactly what we're going to do now; however, by using the Apify client instead. -Before we can use the client though, we must create a new instance of the `ApifyClient` class and pass it our API token from the [**Integrations** page](https://console.apify.com/account?tab=integrations&asrc=developers_portal) on Apify Console: +Before we can use the client though, we must create a new instance of the `ApifyClient` class and pass it our API token from the [**API & Integrations** page](https://console.apify.com/settings/integrations?asrc=developers_portal) on Apify Console: diff --git a/sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md b/sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md index e95e0cb0b8..bf182d06b6 100644 --- a/sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md +++ b/sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md @@ -33,7 +33,7 @@ To run, or **call**, an Actor/task, you will need a few things: - The name or ID of the Actor/task. The name looks like `username~actorName` or `username~taskName`. The ID can be retrieved on the **Settings** page of the Actor/task. -- Your [API token](/platform/integrations), which you can find on the **Integrations** page in [Apify Console](https://console.apify.com/account?tab=integrations) (do not share it with anyone!). +- Your [API token](/platform/integrations), which you can find on the **API & Integrations** page in [Apify Console](https://console.apify.com/settings/integrations) (do not share it with anyone!). - Possibly an input, which is passed in JSON format as the request's **body**. @@ -158,7 +158,7 @@ Here is a Node.js example of calling a task via the API and logging the dataset import got from 'got'; // Specify your API token -// (find it at https://console.apify.com/account#/integrations) +// (find it at https://console.apify.com/settings/integrations) const myToken = ''; // Start apify/google-search-scraper Actor diff --git a/sources/academy/tutorials/api/using_apify_from_php.md b/sources/academy/tutorials/api/using_apify_from_php.md index d890390429..43bae729df 100644 --- a/sources/academy/tutorials/api/using_apify_from_php.md +++ b/sources/academy/tutorials/api/using_apify_from_php.md @@ -10,7 +10,7 @@ Apify does not have an official PHP client (yet), so we are going to use [guzzle ## Before you start -Make sure you have an Apify account and API token. You will find the token in the [Integrations](https://console.apify.com/account#/integrations) section in Apify Console. +Make sure you have an Apify account and API token. You will find the token in the [API & Integrations](https://console.apify.com/settings/integrations) section in Apify Console. If you don't already have guzzle installed in your project (or just want to try out the code examples), run `composer require guzzlehttp/guzzle` to install it in the current directory. diff --git a/sources/api/getting-started.mdx b/sources/api/getting-started.mdx index 413aed4e0e..8005a1a6ca 100644 --- a/sources/api/getting-started.mdx +++ b/sources/api/getting-started.mdx @@ -37,7 +37,7 @@ You must authenticate all API requests presented on this page. You can authentic Authorization: Bearer YOUR_API_TOKEN ``` -You can find your API token in Apify Console under **[Settings > Integrations](https://console.apify.com/settings/integrations)**. +You can find your API token in Apify Console under **[Settings > API & Integrations](https://console.apify.com/settings/integrations)**. ### Verify your account diff --git a/sources/platform/actors/development/builds_and_runs/builds.md b/sources/platform/actors/development/builds_and_runs/builds.md index 53fafcc8a9..2bf6585eed 100644 --- a/sources/platform/actors/development/builds_and_runs/builds.md +++ b/sources/platform/actors/development/builds_and_runs/builds.md @@ -55,7 +55,7 @@ To speed up builds triggered via API, you can use the `useCache=1` parameter. Th Running builds from the Console By default, the Console uses cached data when starting a build. You can also run a clean build without using the cache. To run a clean build: 1. Go to your Actor page. -2. Select **Source** > **Code**. -3. Locate the **Start** button. Next to it, click on the arrow & choose **Clean build** +1. Select **Source** > **Code**. +1. Locate the **Build** button. Next to it, click on the arrow and choose **Clean build**. ::: diff --git a/sources/platform/actors/development/quick-start/start_web_ide.md b/sources/platform/actors/development/quick-start/start_web_ide.md index face50ebe7..9151a4fb24 100644 --- a/sources/platform/actors/development/quick-start/start_web_ide.md +++ b/sources/platform/actors/development/quick-start/start_web_ide.md @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem'; ## What you'll learn -This guide walks you through the full lifecycle of an Actor. You'll start by creating and running it locally with the Apify CLI, then learn to configure its input and data storage. Finally, you will deploy the Actor to the Apify platform, making it ready to run in the cloud. +This guide walks you through the full lifecycle of an Actor using the web IDE in Apify Console. You'll create an Actor from a code template, build it, configure its input, and run it in the cloud. ### Prerequisites @@ -22,9 +22,9 @@ Log in to [Apify Console](https://console.apify.com), navigate to [**My Actors** ![Create Actor](./images/create-actor.png) -You'll see Actor development templates for `JavaScript`, `TypeScript`, and `Python`. +You'll see options to link a Git repository, select a code template, or push code with the Apify CLI. -These templates provide boilerplate code and a preconfigured environment. Choose the template that best suits your needs. For the following demo, we'll proceed with **Crawlee + Puppeteer + Chrome**. +Under **Select a code template**, you'll find quick-start templates for TypeScript, Python, and JavaScript. Click **Browse all templates** to see the full list. Choose the template that best suits your needs. For the following demo, we'll proceed with a **Crawlee + Cheerio** template. :::info Explore Actor templates @@ -65,7 +65,7 @@ The UI includes four tabs: - **Code** - **Last build** - **Input** -- **Last Run** +- **Last run** This represents the Actor creation flow, where you first build the Actor from the source code. Once the build is successful, you can provide input parameters and initiate an Actor run. diff --git a/sources/platform/actors/running/index.md b/sources/platform/actors/running/index.md index 9b037a6ae7..74c907936f 100644 --- a/sources/platform/actors/running/index.md +++ b/sources/platform/actors/running/index.md @@ -34,11 +34,11 @@ For this tutorial, let's choose [Website Content Crawler](https://console.apify. ### 2. Configure and run your Actor -Once you select the Actor, click **Use Actor**. +Once you select the Actor, you will be taken to the Actor's detail page. In the **Input** tab, you can customize your Actor's behavior. Website Content Crawler is pre-configured to run without extra input, so you don't need to change anything. -To run the Actor, click **Save & Start**. +To run the Actor, click **Start**. ![Actor input](./images/apify-input.png) diff --git a/sources/platform/actors/running/store.md b/sources/platform/actors/running/store.md index 1f1c5087e0..b5861e77cd 100644 --- a/sources/platform/actors/running/store.md +++ b/sources/platform/actors/running/store.md @@ -18,8 +18,9 @@ import RentalSunset from '../../../_partials/_rental-sunsetting.mdx'; ## Pricing models -All Actors in [Apify Store](https://apify.com/store) fall into one of three pricing models: +Actors in [Apify Store](https://apify.com/store) use one of the following pricing models: +1. [**Pay per usage**](#pay-per-usage) - you only pay for the platform resources (compute units, data transfer, etc.) the Actor consumes. There are no additional charges from the Actor developer. This is shown as "Pay per usage" in Apify Console. 1. [**Pay per event**](#pay-per-event) - you pay for specific events the Actor creator defines, such as generating a single result or starting the Actor. Most Actors include platform usage in the price, but some may charge it separately - check the Actor's pricing for details. 1. [**Pay per result**](#pay-per-result) - you do not pay for platform usage the Actor generates and instead just pay for the results it produces. 1. [**Rental**](#rental-actors) - to continue using the Actor after the trial period, you must rent the Actor from the developer and pay a flat monthly fee in addition to the costs associated with the platform usage that the Actor generates. @@ -28,6 +29,10 @@ All Actors in [Apify Store](https://apify.com/store) fall into one of three pric After a run finishes, any interactions with the dataset - such as reading or writing additional data - incur standard platform usage costs. This applies to all pricing models. Unnamed datasets are automatically removed after your data retention period, so long-term storage is rarely a concern. ::: +### Pay per usage + +With pay per usage pricing, you only pay for the platform resources the Actor consumes - compute units, data transfer, proxy, and storage. The Actor developer does not charge any additional fees. This is the default pricing model for most Actors, especially private Actors and many community-built Actors in Apify Store. + ### Pay per event With pay per event pricing, you pay for specific events defined by the Actor creator, such as producing a single result, uploading a file, or starting an Actor. These events and their prices are always described on each Actor's page. diff --git a/sources/platform/actors/running/tasks.md b/sources/platform/actors/running/tasks.md index 778c680c4e..734c57a8c1 100644 --- a/sources/platform/actors/running/tasks.md +++ b/sources/platform/actors/running/tasks.md @@ -12,7 +12,7 @@ You can find all your tasks in the [Apify Console](https://console.apify.com/act ## Create -To create a task, open any Actor from [Apify Store](https://console.apify.com/store) or your list of [Actors](https://console.apify.com/actors) in Apify Console. At the top-right section of the page, click the **Create task** button. +To create a task, open any Actor from [Apify Store](https://console.apify.com/store) or your list of [Actors](https://console.apify.com/actors) in Apify Console. At the top-right section of the page, click the **Save as a new task** button. ![Create a new Apify task](./images/tasks/tasks-create-task.png) diff --git a/sources/platform/collaboration/general-resource-access.md b/sources/platform/collaboration/general-resource-access.md index 53fc5fea48..8423348c8d 100644 --- a/sources/platform/collaboration/general-resource-access.md +++ b/sources/platform/collaboration/general-resource-access.md @@ -10,7 +10,7 @@ Some resources, like storages, Actor runs or Actor builds, can be shared simply Thanks to the hard-to-guess, unique IDs, it’s also secure enough for most use cases. However, it doesn't offer features like access revocation and in some cases, you may want to have more direct control over data access and require users to have explicit permissions to your resources. -**General resource access** is an account setting that defines the default access policy at the account level. You can find General resource access in Apify Console under **Settings → Security & Privacy**. The two following options are supported: +**General resource access** is an account setting that defines the default access policy at the account level. You can find General resource access in Apify Console under **Settings → Login & Privacy** (or **Settings → Security & Privacy** for organization accounts). The two following options are supported: - **Anyone with ID can read (default)**: Selected resources can be accessed using just their unique resource ID. This means if you share the resource ID with someone, they would be able to view it without providing an API token or viewing the resource by visiting the Console URL. - **Restricted**: With this setting, only signed-in users with an explicit access to the resources can access them. To access restricted resources via API, a valid token needs to be provided. @@ -79,7 +79,7 @@ When you share an Actor with a collaborator, you can choose to share read-only a If you’re using a public Actor from Apify Store, you can choose to automatically share your runs of that Actor with its creator. This helps developers monitor usage and troubleshoot issues more effectively. -- This setting is opt-in and can be enabled under **Account Settings → Privacy** +- This setting is opt-in and can be enabled under **Settings → Login & Privacy** in the **Share run data with developers** section - When enabled, your runs of public Actors are automatically visible to the Actor’s creator - Shared runs include logs, input, and output storages (dataset, key-value store, request queue) diff --git a/sources/platform/collaboration/organization_account/how_to_use.md b/sources/platform/collaboration/organization_account/how_to_use.md index eba67bd5d6..6dab78b62b 100644 --- a/sources/platform/collaboration/organization_account/how_to_use.md +++ b/sources/platform/collaboration/organization_account/how_to_use.md @@ -26,7 +26,7 @@ The resources you can access and account details you can edit will depend on you ### Manage your organizations -You can view and manage the organizations you are a member of from the **Organizations** tab on your [account page](https://console.apify.com/account#/myorganization). +You can view and manage the organizations you are a member of from the **Organizations** tab on your [account page](https://console.apify.com/settings/organizations). If you want to leave an organization you own, you must first transfer ownership to someone else. @@ -40,7 +40,7 @@ The organization, its Actors, and its integrations will keep running as they are While you cannot manage an organization account's settings and members via API, you can access its Actor and task runs, webhooks, schedules, and storages just as you would with any other account. -As a member of an organization, you are assigned an [API token](../../integrations/index.mdx) (under the **Integrations** tab) and proxy password (click the **Proxy** button in the left menu) for accessing the Apify platform via REST API. +As a member of an organization, you are assigned an [API token](../../integrations/index.mdx) (under the **API & Integrations** tab) and proxy password (click the **Proxy** button in the left menu) for accessing the Apify platform via REST API. ![Integration tokens](../images/organizations/integrations.png) diff --git a/sources/platform/collaboration/organization_account/index.md b/sources/platform/collaboration/organization_account/index.md index 64e79323f9..8310cb147c 100644 --- a/sources/platform/collaboration/organization_account/index.md +++ b/sources/platform/collaboration/organization_account/index.md @@ -22,7 +22,7 @@ The organization account is available on all plans. [Visit the pricing page](htt ## Create a new organization -You can create a new organization by clicking the **Create new organization** button under the **Organizations** tab in your [account](https://console.apify.com/account#/myorganizations). If you want the organization to have a separate email address (used for notifications), enter it here. Otherwise, leave the **email** field empty and the owner's email will be used for notifications. +You can create a new organization by clicking the **Create new organization** button under the **Organizations** tab in your [account](https://console.apify.com/settings/organizations). If you want the organization to have a separate email address (used for notifications), enter it here. Otherwise, leave the **email** field empty and the owner's email will be used for notifications. ![Create a new organization](../images/organizations/create-new-org.png) @@ -40,7 +40,7 @@ Before converting your personal account into an organization, make sure it has a An organization can't be a member of other organizations. If you want to convert your account to one, you'll first need to **leave all the organizations you are a part of**. -Then, under the **Organizations** [tab](https://console.apify.com/account#/myorganizations), click the **Convert this user account to an organization** button. +Then, under the **Organizations** [tab](https://console.apify.com/settings/organizations), click the **Convert this user account to an organization** button. ![Convert your account to an organization](../images/organizations/convert-to-organization.png) diff --git a/sources/platform/console/billing.md b/sources/platform/console/billing.md index 8d29a4a501..0fab91cb8c 100644 --- a/sources/platform/console/billing.md +++ b/sources/platform/console/billing.md @@ -34,7 +34,7 @@ Below the bar chart, there is a table titled **Usage by Actors**. This table pre ## Subscription -The **Subscriptions** tab offers a central location to manage various aspects of your subscription plan. Here, you can access details about your current plan and explore options to upgrade to a different one. +The **Subscription** tab offers a central location to manage various aspects of your subscription plan. Here, you can access details about your current plan and explore options to upgrade to a different one. :::info Unused credits diff --git a/sources/platform/console/index.md b/sources/platform/console/index.md index ce9cac2f35..61bc3efaf1 100644 --- a/sources/platform/console/index.md +++ b/sources/platform/console/index.md @@ -29,7 +29,7 @@ If you did not receive the email, you can visit the [sign-in page](https://conso ### Google or GitHub -If you do not want to create a new password for Apify Console, you can also use your Google or GitHub account to sign up. To do that, click the **Sign up with Google** or **Sign up with GitHub** buttons. You will proceed to the corresponding authentication page, where you must sign in and authorize Apify to access your account. Then, when you come back to Apify Console, we will create your account. +If you do not want to create a new password for Apify Console, you can also use your Google or GitHub account to sign up. To do that, click the **Continue with Google** or **Continue with GitHub** buttons. You will proceed to the corresponding authentication page, where you must sign in and authorize Apify to access your account. Then, when you come back to Apify Console, we will create your account. If you used Google to sign up, there is no verification step after this, and you can start using Apify Console right away. On the other hand, if you used GitHub to create your account and your GitHub account does not have a verified email, we will ask you to verify your email address before you can start using Apify Console. The process works the same as the process for email and password authentication. @@ -66,17 +66,17 @@ After you click on the link (or copy it to your browser), you will proceed to a ![Apify Console reset password page](./images/console-reset-password-page.png) -## Homepage overview +## Dashboard overview ![apify-console-homepage](./images/apify-console-homepage.png) -The Apify Console homepage provides an overview of your account setup. The header displays your account name and current plan level. The homepage features several sections: +The Apify Console Dashboard provides an overview of your account setup. The header displays your account name and current plan level. The Dashboard features several sections: -- **Recently Viewed**: This section displays Actors you have recently accessed. If you haven't used any Actors yet, you will see suggestions instead. +- **Recently viewed**: This section displays Actors you have recently accessed. If you haven't used any Actors yet, you will see suggestions instead. -- **Suggested Actors for You**: Based on your and other users' recent activities, this section recommends Actors that might interest you. +- **Suggested Actors for you**: Based on your and other users' recent activities, this section recommends Actors that might interest you. -- **Actor Runs**: This section is divided into two tabs: +- **Actor runs**: This section is divided into two tabs: - **Recent**: View your latest Actor runs. - **Scheduled**: Check your upcoming scheduled runs and tasks. @@ -93,7 +93,7 @@ You can also navigate Apify Console via keyboard shortcuts. | Shortcut | Tab | | :--- | :--- | | Show shortcuts | Shift? | -| Home | GH | +| Dashboard | GH | | Store | GO | | Actors | GA | | Development | GD | @@ -111,13 +111,14 @@ You can also navigate Apify Console via keyboard shortcuts. | Tab name | Description | | :--- | :--- | | [Apify Store](/platform/console/store) | Search for Actors that suit your web-scraping needs. | +| Dashboard | Overview of your account with recently viewed Actors, suggestions, and recent runs. | | [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. | +| [Schedules](/platform/schedules) | Schedule Actor runs & tasks to run at specified time. | | [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 | +| [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. | +| [Billing](/platform/console/billing) | Billing information, statistics, and invoices. | | [Settings](/platform/console/settings) | Settings of your account. | diff --git a/sources/platform/console/settings.md b/sources/platform/console/settings.md index e99ffe97c6..8e6eea7d35 100644 --- a/sources/platform/console/settings.md +++ b/sources/platform/console/settings.md @@ -8,34 +8,41 @@ slug: /console/settings ## Account -By clicking the **Settings** tab on the side menu, you will be presented with an Account page where you can view & edit various settings regarding your account, such as: +By clicking the **Settings** tab on the side menu, you will be presented with an Account page where you can view and edit various settings regarding your account, such as: * account email * username * profile information * theme -* login information -* session information * account delete -:::info Verify your identity +## Login & Privacy -The **Login & Privacy** tab (**Security & Privacy** for organization accounts) contains sensitive settings. As a security measure, fresh user session is required. If it has been too long since you logged in, you need to sign-in again to be able to view and edit the settings. +The **Login & Privacy** tab (**Security & Privacy** for organization accounts) contains sensitive settings related to authentication and session management. As a security measure, a fresh user session is required. If it has been too long since you logged in, you need to sign in again to view and edit these settings. -::: +Here you can manage: -### Session Information +* sign-in methods (email/password, Google, GitHub) +* password reset +* two-factor authentication +* session information and configuration -In the **Session Information** section, you can adjust the session configuration. You can modify the default session lifespan of 90 days, this customization helps ensure compliance with organization security policies. +### Session information -## Integrations +In the **Session information** section, you can adjust the session configuration. You can modify the default session lifespan of 90 days. This customization helps ensure compliance with organization security policies. -The **Integrations** tab provides essential tools for enhancing your interaction with the Apify platform. Here, you can access your **Personal API Tokens**, which are necessary for using the [REST API](https://docs.apify.com/api/v2). This page also facilitates the integration of your Slack workspace and lists your **Actor Integration Accounts**. This section represents any third-party integrations added by you or your team. For detailed guidance on utilizing these integrations, refer to the [Integrations documentation](https://docs.apify.com/platform/integrations). +## API & Integrations -## Organization +The **API & Integrations** tab provides essential tools for accessing the Apify platform programmatically. Here, you can manage your **API tokens**, which are necessary for using the [Apify API](https://docs.apify.com/api/v2). The tab also shows **third-party apps and services** connected to your account, **account-level integrations**, and **Actor OAuth accounts**. For detailed guidance on utilizing these integrations, refer to the [Integrations documentation](https://docs.apify.com/platform/integrations). -The **Organizations** tab is where you can view your accounts' current organizations, create new organizations, or convert your user account into an organization account. For more information on how to set up an organization check out this [article](https://help.apify.com/en/articles/8698948-how-to-set-up-an-organization-account). +## Organizations + +The **Organizations** tab is where you can view your accounts' current organizations, create new organizations, or convert your user account into an organization account. For more information on how to set up an organization, check out this [article](https://help.apify.com/en/articles/8698948-how-to-set-up-an-organization-account). ## Notifications The **Notifications** tab allows you to customize your notification preferences. Here, you can specify the types of updates you wish to receive and select the methods by which you receive them. + +## Referrals + +The **Referrals** tab lets you share Apify with others and earn rewards. You can find your referral link and track the status of your referrals. diff --git a/sources/platform/integrations/ai/agno.md b/sources/platform/integrations/ai/agno.md index fd77a6f224..b4048d3f1b 100644 --- a/sources/platform/integrations/ai/agno.md +++ b/sources/platform/integrations/ai/agno.md @@ -22,7 +22,7 @@ This guide shows how to integrate Apify Actors with Agno to empower your AI agen ### Prerequisites -- _Apify API token_: Obtain your API token from the [Apify Console](https://console.apify.com/account/integrations). +- _Apify API token_: Obtain your API token from the [Apify Console](https://console.apify.com/settings/integrations). - _OpenAI API key_: Get your API key from the [OpenAI platform](https://platform.openai.com/account/api-keys). :::tip Alternative LLM providers diff --git a/sources/platform/integrations/ai/chatgpt.md b/sources/platform/integrations/ai/chatgpt.md index 8b5259baa0..1e440724c6 100644 --- a/sources/platform/integrations/ai/chatgpt.md +++ b/sources/platform/integrations/ai/chatgpt.md @@ -19,7 +19,7 @@ In this tutorial, you'll learn how to connect _ChatGPT_ to the _Apify MCP server Before connecting ChatGPT to Apify, you'll need: - _An Apify account_ - If you don't have an Apify account already, you can [sign up](https://console.apify.com/sign-up) -- _Apify API token_ - Get your API token from the **Integrations** section in [Apify Console](https://console.apify.com/account#/integrations). This token authorizes the MCP server to run Actors on your behalf. Make sure to keep it secure. +- _Apify API token_ - Get your API token from the **API & Integrations** section in [Apify Console](https://console.apify.com/settings/integrations). This token authorizes the MCP server to run Actors on your behalf. Make sure to keep it secure. - _An OpenAI account with access to ChatGPT_ - You need an OpenAI account to use ChatGPT. - _ChatGPT with Developer mode enabled_ - You must enable [Developer Mode](https://platform.openai.com/docs/guides/developer-mode) to add custom connectors (when the Developer mode is active, the message input box is outlined in orange). diff --git a/sources/platform/integrations/ai/haystack.md b/sources/platform/integrations/ai/haystack.md index 110a1a6b74..da1d285d7e 100644 --- a/sources/platform/integrations/ai/haystack.md +++ b/sources/platform/integrations/ai/haystack.md @@ -33,7 +33,7 @@ from haystack.utils.auth import Secret from apify_haystack import ApifyDatasetFromActorCall ``` -Find your [Apify API token](https://console.apify.com/account/integrations) and [OpenAI API key](https://platform.openai.com/account/api-keys) and initialize these into environment variable: +Find your [Apify API token](https://console.apify.com/settings/integrations) and [OpenAI API key](https://platform.openai.com/account/api-keys) and initialize these into environment variable: ```python import os diff --git a/sources/platform/integrations/ai/langchain.md b/sources/platform/integrations/ai/langchain.md index 807f9d0b47..fa9a40326b 100644 --- a/sources/platform/integrations/ai/langchain.md +++ b/sources/platform/integrations/ai/langchain.md @@ -33,7 +33,7 @@ from langchain_openai import ChatOpenAI from langchain_openai.embeddings import OpenAIEmbeddings ``` -Find your [Apify API token](https://console.apify.com/account/integrations) and [OpenAI API key](https://platform.openai.com/account/api-keys) and initialize these into environment variable: +Find your [Apify API token](https://console.apify.com/settings/integrations) and [OpenAI API key](https://platform.openai.com/account/api-keys) and initialize these into environment variable: ```python os.environ["OPENAI_API_KEY"] = "Your OpenAI API key" diff --git a/sources/platform/integrations/ai/mcp.md b/sources/platform/integrations/ai/mcp.md index 3842045fc5..808587355f 100644 --- a/sources/platform/integrations/ai/mcp.md +++ b/sources/platform/integrations/ai/mcp.md @@ -24,7 +24,7 @@ and enables AI coding assistants to access Apify documentation and tutorials. Before connecting your AI to Apify, you'll need three things: - _An Apify account_ - Sign up for an Apify account, if you don't have one. -- _Apify API token_ - Get your API token from the **Integrations** section in [Apify Console](https://console.apify.com/account#/integrations). This token authorizes the MCP server to run Actors on your behalf. Make sure to keep it secure. +- _Apify API token_ - Get your API token from the **API & Integrations** section in [Apify Console](https://console.apify.com/settings/integrations). This token authorizes the MCP server to run Actors on your behalf. Make sure to keep it secure. - _MCP client_ - An AI agent or client that supports Model Context Protocol (MCP) This could be Anthropic's Claude for Desktop, a VS Code extension with MCP support, or any application that implements the MCP specification. The [official MCP documentation](https://modelcontextprotocol.io/clients) maintains a list of compatible clients. ## Quick start @@ -81,7 +81,7 @@ You can also use your Apify token directly, instead of OAuth, by setting the `Au } ``` -Replace `` with your actual Apify API token from the [Integrations section](https://console.apify.com/account#/integrations). +Replace `` with your actual Apify API token from the [API & Integrations section](https://console.apify.com/settings/integrations). @@ -143,7 +143,7 @@ To add Apify MCP server to Cursor manually: } ``` - Replace `` with your actual Apify API token from the [Integrations section](https://console.apify.com/account#/integrations). + Replace `` with your actual Apify API token from the [API & Integrations section](https://console.apify.com/settings/integrations). @@ -197,7 +197,7 @@ VS Code supports MCP through GitHub Copilot's agent mode (requires Copilot subsc } ``` - Replace `` with your actual Apify API token from the [Integrations section](https://console.apify.com/account#/integrations). + Replace `` with your actual Apify API token from the [API & Integrations section](https://console.apify.com/settings/integrations). @@ -231,7 +231,7 @@ To manually configure Apify's MCP server for Claude Desktop: } ``` -Replace `` with your actual Apify API token from the [Integrations section](https://console.apify.com/account#/integrations). +Replace `` with your actual Apify API token from the [API & Integrations section](https://console.apify.com/settings/integrations). @@ -433,7 +433,7 @@ documentation queries. If you exceed this limit, you'll receive a `429` response ##### Authentication errors -- _Check your API token_: Verify that your Apify API token is correct. You can find it in the **Integrations** section of the [Apify Console](https://console.apify.com/account#/integrations). Without a valid token, the server cannot start Actor runs. +- _Check your API token_: Verify that your Apify API token is correct. You can find it in the **API & Integrations** section of the [Apify Console](https://console.apify.com/settings/integrations). Without a valid token, the server cannot start Actor runs. - _Set environment variable for local development_: When running the MCP server locally, ensure you have set the `APIFY_TOKEN` environment variable. ##### Local environment setup diff --git a/sources/platform/integrations/ai/openai_agents.md b/sources/platform/integrations/ai/openai_agents.md index ad653d85fc..62352876fa 100644 --- a/sources/platform/integrations/ai/openai_agents.md +++ b/sources/platform/integrations/ai/openai_agents.md @@ -16,7 +16,7 @@ For more details about the OpenAI Agents SDK, refer to the [official documentati Before integrating Apify with OpenAI Agents SDK, you'll need: - _An Apify account_ - If you don't have an Apify account already, you can [sign up](https://console.apify.com/sign-up) -- _Apify API token_ - Get your API token from the **Integrations** section in [Apify Console](https://console.apify.com/account#/integrations). This token authorizes the Apify MCP server to run Actors on your behalf. Make sure to keep it secure. +- _Apify API token_ - Get your API token from the **API & Integrations** section in [Apify Console](https://console.apify.com/settings/integrations). This token authorizes the Apify MCP server to run Actors on your behalf. Make sure to keep it secure. - _OpenAI API key_ - Get your API key from the [OpenAI platform](https://platform.openai.com/account/api-keys). You need this to use OpenAI Agents SDK. - _Python packages_ - Install the required packages: @@ -262,7 +262,7 @@ For a comprehensive example with error handling and reporting, refer to the [Ope ### Authentication errors -- _Check your API token_: Verify that your Apify API token is correct. You can find it in the **Integrations** section of the [Apify Console](https://console.apify.com/account#/integrations). Without a valid token, the server cannot start Actor runs. +- _Check your API token_: Verify that your Apify API token is correct. You can find it in the **API & Integrations** section of the [Apify Console](https://console.apify.com/settings/integrations). Without a valid token, the server cannot start Actor runs. - _Set environment variables_: When running your agent, ensure you have set the `APIFY_TOKEN` and `OPENAI_API_KEY` environment variables. ### Agent execution issues diff --git a/sources/platform/integrations/ai/openai_assistants.md b/sources/platform/integrations/ai/openai_assistants.md index e260c41f50..6d8d63085a 100644 --- a/sources/platform/integrations/ai/openai_assistants.md +++ b/sources/platform/integrations/ai/openai_assistants.md @@ -41,7 +41,7 @@ from openai import OpenAI, Stream from openai.types.beta.threads.run_submit_tool_outputs_params import ToolOutput ``` -Find your [Apify API token](https://console.apify.com/account/integrations) and [OpenAI API key](https://platform.openai.com/account/api-keys) and initialize OpenAI and Apify clients: +Find your [Apify API token](https://console.apify.com/settings/integrations) and [OpenAI API key](https://platform.openai.com/account/api-keys) and initialize OpenAI and Apify clients: ```python client = OpenAI(api_key="YOUR OPENAI API KEY") @@ -257,7 +257,7 @@ Before we start, we need to install all dependencies: pip install apify-client openai ``` -Find your [Apify API token](https://console.apify.com/account/integrations) and [OpenAI API key](https://platform.openai.com/account/api-keys) and initialize OpenAI and Apify clients: +Find your [Apify API token](https://console.apify.com/settings/integrations) and [OpenAI API key](https://platform.openai.com/account/api-keys) and initialize OpenAI and Apify clients: ```python from apify_client import ApifyClient diff --git a/sources/platform/integrations/data-storage/airbyte.md b/sources/platform/integrations/data-storage/airbyte.md index 7bf5b7d5c5..a0045f9f12 100644 --- a/sources/platform/integrations/data-storage/airbyte.md +++ b/sources/platform/integrations/data-storage/airbyte.md @@ -29,7 +29,7 @@ To find your **dataset ID**, you need to navigate to the **Storage** tab in Apif ![Datasets in app](../images/datasets-app.png) -To find your Apify API token, you need to navigate to the **Settings** tab and select **Integrations**. Copy it and paste it in the relevant field in Airbyte. +To find your Apify API token, you need to navigate to the **Settings** tab and select **API & Integrations**. Copy it and paste it in the relevant field in Airbyte. ![Integrations token](../images/apify-integrations-token.png) diff --git a/sources/platform/integrations/data-storage/drive.md b/sources/platform/integrations/data-storage/drive.md index 3f8bc8e026..8bf664e28e 100644 --- a/sources/platform/integrations/data-storage/drive.md +++ b/sources/platform/integrations/data-storage/drive.md @@ -16,7 +16,7 @@ To use the Apify integration for Google Drive, you will need: ## Set up Google Drive integration -1. Head over to **Integrations** tab in your saved task and click on the **Upload file** integration. +1. Head over to **Integrations** tab in your saved task and click on the **Upload results to GDrive** integration. ![Google Drive integration](../images/google/google-integrations-add.png) diff --git a/sources/platform/integrations/data-storage/keboola.md b/sources/platform/integrations/data-storage/keboola.md index 20b21da5ee..23aa01a1a2 100644 --- a/sources/platform/integrations/data-storage/keboola.md +++ b/sources/platform/integrations/data-storage/keboola.md @@ -51,7 +51,7 @@ In the next step, you can choose the action you want to perform: #### Authentication -After selecting the action, you will need to provide your Apify API credentials. You can find these credentials on your Apify account page by navigating to **Settings > Integrations** and copying them into the provided form. +After selecting the action, you will need to provide your Apify API credentials. You can find these credentials on your Apify account page by navigating to **Settings > API & Integrations** and copying them into the provided form. ![Keboola API authentication](../images/keboola/keboola-setup-api-token.png) diff --git a/sources/platform/integrations/programming/api.md b/sources/platform/integrations/programming/api.md index ad194f4539..8bdf94b5d2 100644 --- a/sources/platform/integrations/programming/api.md +++ b/sources/platform/integrations/programming/api.md @@ -16,7 +16,7 @@ You are not required to those packages - the REST API works with any HTTP client ## API token -To access the Apify API in your integrations, you need to authenticate using your secret API token. You can find it on the [Integrations](https://console.apify.com/settings/integrations) page in Apify Console. Give your token a reasonable description, and never use one token for several services, much like you shouldn't use the same password for different accounts. +To access the Apify API in your integrations, you need to authenticate using your secret API token. You can find it on the [API & Integrations](https://console.apify.com/settings/integrations) page in Apify Console. Give your token a reasonable description, and never use one token for several services, much like you shouldn't use the same password for different accounts. ![Integrations page in Apify Console](../images/api-token.png) @@ -50,7 +50,7 @@ For better security awareness, the UI marks tokens identified as compromised, ma ## Organization accounts -When working under an organization account, you will see two types of API tokens on the Integrations page. +When working under an organization account, you will see two types of API tokens on the API & Integrations page. ![Integrations page in Apify Console in organization mode](../images/api-token-organization.png) @@ -70,7 +70,7 @@ We do not allow scoped tokens to create or modify Actors. If you do need to crea ### How to create a scoped token -Scoped tokens behave like standard API tokens and are managed through the [Integrations](https://console.apify.com/settings/integrations) page in Apify Console. When creating a token (or updating an existing one), simply toggle "Limit token permissions" to make the token scoped. +Scoped tokens behave like standard API tokens and are managed through the [API & Integrations](https://console.apify.com/settings/integrations) page in Apify Console. When creating a token (or updating an existing one), simply toggle "Limit token permissions" to make the token scoped. Once the token is scoped, you can specify the token's permissions. diff --git a/sources/platform/integrations/workflows-and-notifications/gmail.md b/sources/platform/integrations/workflows-and-notifications/gmail.md index a41cd88810..3e10eb45cc 100644 --- a/sources/platform/integrations/workflows-and-notifications/gmail.md +++ b/sources/platform/integrations/workflows-and-notifications/gmail.md @@ -16,7 +16,7 @@ To use the Apify integration for Gmail, you will need: ## Set up Gmail integration -1. Head over to **Integrations** tab in your task and click on Send email generic integration. +1. Head over to **Integrations** tab in your task and click on the **Send results email via Gmail** integration. ![Google Drive integration](../images/google/google-integrations-add.png) diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/index.md b/sources/platform/integrations/workflows-and-notifications/gumloop/index.md index 6df6ec189d..6e586339fa 100644 --- a/sources/platform/integrations/workflows-and-notifications/gumloop/index.md +++ b/sources/platform/integrations/workflows-and-notifications/gumloop/index.md @@ -50,9 +50,9 @@ To use the Apify integration in Gumloop, you need an Apify account, a Gumloop ac 1. _Get your Apify API Key_ - To get started, navigate to [**Settings > Integrations**](https://console.apify.com/settings/integrations) in Apify Console and copy your API token. + To get started, navigate to [**Settings > API & Integrations**](https://console.apify.com/settings/integrations) in Apify Console and copy your API token. - ![Apify Settings > Integrations with API token](images/generate_apify_token.png) + ![Apify Settings > API & Integrations with API token](images/generate_apify_token.png) 1. _Add Apify credentials to Gumloop_ diff --git a/sources/platform/integrations/workflows-and-notifications/make/ai-crawling.md b/sources/platform/integrations/workflows-and-notifications/make/ai-crawling.md index ba07ea07bb..30cc370545 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/ai-crawling.md +++ b/sources/platform/integrations/workflows-and-notifications/make/ai-crawling.md @@ -11,7 +11,7 @@ toc_max_heading_level: 4 Apify Scraper for AI Crawling from [Apify](https://apify.com/) lets you extract text content from websites to feed AI models, LLM applications, vector databases, or Retrieval Augmented Generation (RAG) pipelines. It supports rich formatting using Markdown, cleans the HTML of irrelevant elements, downloads linked files, and integrates with AI ecosystems like LangChain, LlamaIndex, and other LLM frameworks. -To use these modules, you need an [Apify account](https://console.apify.com) and an [API token](https://docs.apify.com/platform/integrations/api#api-token). You can find your token in the [Apify Console](https://console.apify.com/) under **Settings > Integrations**. After connecting, you can automate content extraction at scale and incorporate the results into your AI workflows. +To use these modules, you need an [Apify account](https://console.apify.com) and an [API token](https://docs.apify.com/platform/integrations/api#api-token). You can find your token in the [Apify Console](https://console.apify.com/) under **Settings > API & Integrations**. After connecting, you can automate content extraction at scale and incorporate the results into your AI workflows. ## Connect Apify Scraper for AI Crawling diff --git a/sources/platform/integrations/workflows-and-notifications/make/amazon.md b/sources/platform/integrations/workflows-and-notifications/make/amazon.md index 28475015b7..8cb4f5f272 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/amazon.md +++ b/sources/platform/integrations/workflows-and-notifications/make/amazon.md @@ -11,7 +11,7 @@ unlisted: true The Amazon Scraper module from [Apify](https://apify.com) allows you to extract product, search, or category data from Amazon. -To use the module, you need an [Apify account](https://console.apify.com) and an [API token](https://docs.apify.com/platform/integrations/api#api-token), which you can find in Apify Console under **Settings > Integrations**. After connecting, you can automate data extraction and incorporate the results into your workflows. +To use the module, you need an [Apify account](https://console.apify.com) and an [API token](https://docs.apify.com/platform/integrations/api#api-token), which you can find in Apify Console under **Settings > API & Integrations**. After connecting, you can automate data extraction and incorporate the results into your workflows. ## Connect Apify Scraper for Amazon Data modules to Make diff --git a/sources/platform/integrations/workflows-and-notifications/make/facebook.md b/sources/platform/integrations/workflows-and-notifications/make/facebook.md index 58ae6116b4..ac27bffabd 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/facebook.md +++ b/sources/platform/integrations/workflows-and-notifications/make/facebook.md @@ -11,7 +11,7 @@ unlisted: true The Facebook Scraper modules from [Apify](https://apify.com/) allow you to extract posts, comments, and profile data from Facebook. -To use these modules, you need an [Apify account](https://console.apify.com) and an [API token](https://docs.apify.com/platform/integrations/api#api-token). You can find your token in the [Apify Console](https://console.apify.com/) under **Settings > Integrations**. After connecting, you can automate data extraction and incorporate the results into your workflows. +To use these modules, you need an [Apify account](https://console.apify.com) and an [API token](https://docs.apify.com/platform/integrations/api#api-token). You can find your token in the [Apify Console](https://console.apify.com/) under **Settings > API & Integrations**. After connecting, you can automate data extraction and incorporate the results into your workflows. ## Connect Apify Scraper for Facebook Data modules to Make diff --git a/sources/platform/integrations/workflows-and-notifications/make/instagram.md b/sources/platform/integrations/workflows-and-notifications/make/instagram.md index 7b1b5c51dd..d4debe9b60 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/instagram.md +++ b/sources/platform/integrations/workflows-and-notifications/make/instagram.md @@ -11,7 +11,7 @@ unlisted: true The Instagram Scraper modules from [Apify](https://apify.com) allow you to extract posts, comments, and profile data from Instagram. -To use these modules, you need an [Apify account](https://console.apify.com) and an [API token](https://docs.apify.com/platform/integrations/api#api-token). You can find your token in the [Apify Console](https://console.apify.com/) under **Settings > Integrations**. After connecting, you can automate data extraction and incorporate the results into your workflows. +To use these modules, you need an [Apify account](https://console.apify.com) and an [API token](https://docs.apify.com/platform/integrations/api#api-token). You can find your token in the [Apify Console](https://console.apify.com/) under **Settings > API & Integrations**. After connecting, you can automate data extraction and incorporate the results into your workflows. ## Connect Apify Scraper for Instagram Data modules to Make diff --git a/sources/platform/integrations/workflows-and-notifications/make/llm.md b/sources/platform/integrations/workflows-and-notifications/make/llm.md index 9253cc620a..a8dec32168 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/llm.md +++ b/sources/platform/integrations/workflows-and-notifications/make/llm.md @@ -11,7 +11,7 @@ toc_max_heading_level: 4 Apify Scraper for LLMs from [Apify](https://apify.com) is a web browsing module for OpenAI Assistants, RAG pipelines, and AI agents. It can query Google Search, scrape the top results, and return page content as Markdown for downstream AI processing. -To use these modules, you need an [Apify account](https://console.apify.com) and an [API token](https://docs.apify.com/platform/integrations/api#api-token). You can find your token in Apify Console under **Settings > Integrations**. After connecting, you can automate content extraction and integrate results into your AI workflows. +To use these modules, you need an [Apify account](https://console.apify.com) and an [API token](https://docs.apify.com/platform/integrations/api#api-token). You can find your token in Apify Console under **Settings > API & Integrations**. After connecting, you can automate content extraction and integrate results into your AI workflows. ## Connect Apify Scraper for LLMs diff --git a/sources/platform/integrations/workflows-and-notifications/make/maps.md b/sources/platform/integrations/workflows-and-notifications/make/maps.md index 9882b1f941..b5b45d9bdc 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/maps.md +++ b/sources/platform/integrations/workflows-and-notifications/make/maps.md @@ -12,7 +12,7 @@ unlisted: true The Google Maps Leads Scraper modules from [apify.com](http://apify.com/) allow you to extract valuable business lead data from Google Maps, including contact information, email addresses, social media profiles, business websites, phone numbers, and detailed location data. Perfect for sales teams, marketers, and business developers looking to build targeted lead lists, marketers or other commercial teams looking to data mine reviews or assess sentiment analysis wide geographies. -To use these modules, you need an [Apify account](https://console.apify.com/sign-up) and an [API token](https://docs.apify.com/platform/integrations/api#api-token), which you can find under **Settings > Integrations** in Apify Console. After connecting, you can automate lead generation at scale and incorporate the results into your sales and marketing workflows. +To use these modules, you need an [Apify account](https://console.apify.com/sign-up) and an [API token](https://docs.apify.com/platform/integrations/api#api-token), which you can find under **Settings > API & Integrations** in Apify Console. After connecting, you can automate lead generation at scale and incorporate the results into your sales and marketing workflows. For more details, follow the tutorial below. diff --git a/sources/platform/integrations/workflows-and-notifications/make/search.md b/sources/platform/integrations/workflows-and-notifications/make/search.md index 6af241e4f1..7f4e547be0 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/search.md +++ b/sources/platform/integrations/workflows-and-notifications/make/search.md @@ -11,7 +11,7 @@ unlisted: true The Google search modules from [Apify](https://apify.com) allows you to crawl Google Search Results Pages (SERPs) and extract data from those web pages in structured format such as JSON, XML, CSV, or Excel. -To use the module, you need an [Apify account](https://console.apify.com) and an [API token](https://docs.apify.com/platform/integrations/api#api-token), which you can find in Apify Console under **Settings > Integrations**. After connecting, you can automate data extraction and incorporate the results into your workflows. +To use the module, you need an [Apify account](https://console.apify.com) and an [API token](https://docs.apify.com/platform/integrations/api#api-token), which you can find in Apify Console under **Settings > API & Integrations**. After connecting, you can automate data extraction and incorporate the results into your workflows. ## Connect Apify Scraper for Google Search modules to Make diff --git a/sources/platform/integrations/workflows-and-notifications/make/tiktok.md b/sources/platform/integrations/workflows-and-notifications/make/tiktok.md index 2b84ca90e2..78b655d76e 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/tiktok.md +++ b/sources/platform/integrations/workflows-and-notifications/make/tiktok.md @@ -11,7 +11,7 @@ unlisted: true The TikTok Scraper modules from [Apify](https://apify.com) allow you to extract hashtag, comments, and profile data from TikTok. -To use these modules, you need an [Apify account](https://console.apify.com) and an [API token](https://docs.apify.com/platform/integrations/api#api-token). You can find your token in the [Apify Console](https://console.apify.com/) under **Settings > Integrations**. After connecting, you can automate data extraction and incorporate the results into your workflows. +To use these modules, you need an [Apify account](https://console.apify.com) and an [API token](https://docs.apify.com/platform/integrations/api#api-token). You can find your token in the [Apify Console](https://console.apify.com/) under **Settings > API & Integrations**. After connecting, you can automate data extraction and incorporate the results into your workflows. ## Connect Apify Scraper for TikTok Data modules to Make diff --git a/sources/platform/integrations/workflows-and-notifications/make/youtube.md b/sources/platform/integrations/workflows-and-notifications/make/youtube.md index 475d12e7d6..e2bae675b1 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/youtube.md +++ b/sources/platform/integrations/workflows-and-notifications/make/youtube.md @@ -11,7 +11,7 @@ unlisted: true The YouTube Scraper module from [apify.com](https://apify.com) allows you to extract channel, video, streams, shorts, and search data from YouTube. -To use this module, you need an [Apify account](https://console.apify.com) and an [API token](https://docs.apify.com/platform/integrations/api#api-token), which you can find in Apify Console under **Settings > Integrations**. After connecting, you can automate data extraction and incorporate the results into your workflows. +To use this module, you need an [Apify account](https://console.apify.com) and an [API token](https://docs.apify.com/platform/integrations/api#api-token), which you can find in Apify Console under **Settings > API & Integrations**. After connecting, you can automate data extraction and incorporate the results into your workflows. For more details, follow the tutorial below. diff --git a/sources/platform/integrations/workflows-and-notifications/n8n/website-content-crawler.md b/sources/platform/integrations/workflows-and-notifications/n8n/website-content-crawler.md index 7dd0c75423..0f9615de7c 100644 --- a/sources/platform/integrations/workflows-and-notifications/n8n/website-content-crawler.md +++ b/sources/platform/integrations/workflows-and-notifications/n8n/website-content-crawler.md @@ -9,7 +9,7 @@ toc_max_heading_level: 4 Website Content Crawler from [Apify](https://apify.com/apify/website-content-crawler) lets you extract text content from websites to feed AI models, LLM applications, vector databases, or Retrieval Augmented Generation (RAG) pipelines. It supports rich formatting using Markdown, cleans the HTML of irrelevant elements, downloads linked files, and integrates with AI ecosystems like Langchain, LlamaIndex, and other LLM frameworks. -To use these modules, you need an [API token](https://docs.apify.com/platform/integrations/api#api-token). You can find your token in the [Apify Console](https://console.apify.com/) under **Settings > Integrations**. After connecting, you can automate content extraction at scale and incorporate the results into your AI workflows. +To use these modules, you need an [API token](https://docs.apify.com/platform/integrations/api#api-token). You can find your token in the [Apify Console](https://console.apify.com/) under **Settings > API & Integrations**. After connecting, you can automate content extraction at scale and incorporate the results into your AI workflows. ## Prerequisites diff --git a/sources/platform/integrations/workflows-and-notifications/slack.md b/sources/platform/integrations/workflows-and-notifications/slack.md index ed46810a76..7d11406904 100644 --- a/sources/platform/integrations/workflows-and-notifications/slack.md +++ b/sources/platform/integrations/workflows-and-notifications/slack.md @@ -28,7 +28,7 @@ To use the Apify integration for Slack, you will need: You can find all integrations on an Actor's or task's **Integrations** tab. For example, you can try using the [Google Shopping Scraper](https://console.apify.com/actors/aLTexEuCetoJNL9bL). -Find the integration for Slack, then click the **Configure** button. You will be prompted to log in with your Slack account and select your workspace in the **Settings > Integrations** window. +Find the integration for Slack, then click the **Configure** button. You will be prompted to log in with your Slack account and select your workspace in the **Settings > API & Integrations** window. ![Integrations tab](../images/integrations-tab.png) diff --git a/sources/platform/integrations/workflows-and-notifications/telegram.md b/sources/platform/integrations/workflows-and-notifications/telegram.md index 9bb6443288..65350ba15e 100644 --- a/sources/platform/integrations/workflows-and-notifications/telegram.md +++ b/sources/platform/integrations/workflows-and-notifications/telegram.md @@ -59,7 +59,7 @@ The connection configuration options open in a new tab in your browser or in a m ![Apify Zapier connection](../images/zapier-new-connection.png) -In connection configuration, you need to provide your Apify API Token. You can find the token in Apify Console by navigating to **Settings > Integrations**. +In connection configuration, you need to provide your Apify API Token. You can find the token in Apify Console by navigating to **Settings > API & Integrations**. ![Integrations token](../images/apify-integrations-token.png) diff --git a/sources/platform/integrations/workflows-and-notifications/workato.md b/sources/platform/integrations/workflows-and-notifications/workato.md index edf628df71..1b0430fa92 100644 --- a/sources/platform/integrations/workflows-and-notifications/workato.md +++ b/sources/platform/integrations/workflows-and-notifications/workato.md @@ -60,7 +60,7 @@ You can authenticate the connection using either: #### Authenticate with API token 1. In the Apify connection dialog, select **Apify API token** as the authentication type. -1. Enter your **API Token**. In Apify Console, go to [**Settings > Integrations**](https://console.apify.com/account#/integrations) and copy your API token. +1. Enter your **API Token**. In Apify Console, go to [**Settings > API & Integrations**](https://console.apify.com/settings/integrations) and copy your API token. 1. Click **Connect**. Workato will test the connection by making an authenticated call to verify your credentials. ![Screenshot of the Workato API Key authentication form](../images/workato/create-connection-api-key.png) diff --git a/sources/platform/monitoring/index.md b/sources/platform/monitoring/index.md index 7b360fe77d..3def90e425 100644 --- a/sources/platform/monitoring/index.md +++ b/sources/platform/monitoring/index.md @@ -58,7 +58,7 @@ When you set up an alert, you have four choices for how you want the metrics to 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. 1. **Email** - You can set up one or more emails to receive alert notifications. To do that, you just have to separate them by commas. You can also disable email notifications if you don't want to receive them. -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. +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/settings/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) diff --git a/sources/platform/schedules.md b/sources/platform/schedules.md index c8f2ee6366..d7757f0c39 100644 --- a/sources/platform/schedules.md +++ b/sources/platform/schedules.md @@ -48,7 +48,7 @@ You can adjust how often your Actor or task runs using the [schedule setup tool] ![New schedule](./images/schedules-overview.png) -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. +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 new** 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). The **timeout** value is specified in seconds; a value of _0_ means there is no timeout, and the Actor runs until it finishes. @@ -63,7 +63,7 @@ If you're scheduling a task, just select the task you prepared earlier using the To add more Actors or tasks, just repeat the process. -Now, all you need to do is click **Save & activate** and let the scheduler take care of running your jobs on time. +New schedules are created in an enabled state by default. You can disable or enable the schedule at any time using the **Disable**/**Enable** button on the schedule detail page. For integrations, you can also add a [webhook](/platform/integrations/webhooks) to your tasks, which will notify you (or perform an action of your choice) every time the task runs. @@ -71,13 +71,13 @@ 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 [API & Integrations](https://console.apify.com/settings/integrations) tab of your Apify account settings. :::caution API authentication recommendations When providing your API authentication token, we recommend using the request's `Authorization` header, rather than the URL ([more info](/api/v2#authentication)). ::: -In the `POST` request's payload should be a JSON object specifying the schedule's name, your [user ID](https://console.apify.com/account#/integrations), and the schedule's _actions_. +In the `POST` request's payload should be a JSON object specifying the schedule's name, your [user ID](https://console.apify.com/settings/integrations), and the schedule's _actions_. The following JSON object creates a schedule which runs an SEO audit of the Apify domain once a month. diff --git a/sources/platform/storage/dataset.md b/sources/platform/storage/dataset.md index 763bd75866..db662209e4 100644 --- a/sources/platform/storage/dataset.md +++ b/sources/platform/storage/dataset.md @@ -39,9 +39,9 @@ In [Apify Console](https://console.apify.com), you can view your datasets in the To view or download a dataset: -1. Click on its **Dataset ID**. -2. Select the format & configure other options if desired in **Export dataset** section. -3. Click **Download**. +1. Click on its **Dataset ID** to open the dataset detail page. +1. Browse the data in **Table** or **JSON** view. +1. Click **Export** to download the data in your preferred format. 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). @@ -51,7 +51,7 @@ Utilize the **Actions** menu to modify the dataset's name, which also affects it The [Apify API](/api/v2/storage-datasets) enables you programmatic access to your datasets using [HTTP requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods). -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. +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 [API & Integrations](https://console.apify.com/settings/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)). diff --git a/sources/platform/storage/key_value_store.md b/sources/platform/storage/key_value_store.md index 5a3f9d502e..088761e7af 100644 --- a/sources/platform/storage/key_value_store.md +++ b/sources/platform/storage/key_value_store.md @@ -56,7 +56,7 @@ At the bottom of the page, you can work with records in your key-value store: The [Apify API](/api/v2/storage-key-value-stores) enables you programmatic access to your key-value stores using [HTTP requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods). -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. +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 [API & Integrations](https://console.apify.com/settings/integrations) tab of **Settings** page of your Apify account. :::tip Authentication diff --git a/sources/platform/storage/request_queue.md b/sources/platform/storage/request_queue.md index da7baecdcc..5eeba97bda 100644 --- a/sources/platform/storage/request_queue.md +++ b/sources/platform/storage/request_queue.md @@ -46,7 +46,7 @@ Click on the **API** button to view and test a queue's [API endpoints](/api/v2/s The [Apify API](/api/v2/storage-request-queues) allows you programmatic access to your request queues using [HTTP requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods). -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. +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 [API & Integrations](https://console.apify.com/settings/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)). diff --git a/sources/platform/storage/usage.md b/sources/platform/storage/usage.md index 475274e8c4..3848f13cfe 100644 --- a/sources/platform/storage/usage.md +++ b/sources/platform/storage/usage.md @@ -68,7 +68,7 @@ In most cases, when accessing your storages via API, you will need to provide a For read (GET) requests, it is enough to use a store's alphanumerical ID, since the ID is hard to guess and effectively serves as an authentication key. -With other request types and when using the `username~store-name`, however, you will need to provide your secret API token in your request's [`Authorization`](/api/v2#authentication) header or as a query parameter. You can find your token on the [Integrations](https://console.apify.com/account?tab=integrations) page of your Apify account. +With other request types and when using the `username~store-name`, however, you will need to provide your secret API token in your request's [`Authorization`](/api/v2#authentication) header or as a query parameter. You can find your token on the [API & Integrations](https://console.apify.com/settings/integrations) page of your Apify account. For further details and a breakdown of each storage API endpoint, refer to the [API documentation](/api/v2/storage-datasets).