-
Notifications
You must be signed in to change notification settings - Fork 141
docs: prepare docs for gumloop addition #1695
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 4 commits
2091203
af7e28c
06dc123
0961f3a
628ff47
1242344
4eea96e
73cfb1c
d97fe66
572ea44
0304129
9dce516
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -83,6 +83,7 @@ preconfigured | |
| [Zz]apier | ||
| [Tt]rello | ||
| [Pp]refill | ||
| [Gg]umloop | ||
|
|
||
| [Mm]ultiselect | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| --- | ||
| title: Gumloop integration | ||
| description: Learn how to integrate your Apify Actors with Gumloop. | ||
| sidebar_label: Gumloop | ||
| sidebar_position: 3 | ||
| slug: /integrations/gumloop | ||
| --- | ||
|
|
||
| With the Gumloop Apify integration you can retrieve key data for your AI-powered workflows in a flash. | ||
|
|
||
| Gumloop supports two types of integrations with Apify: | ||
|
|
||
| - Direct integrations with Apify Actors through MCP nodes, where you can prompt the data you need (Recommended) | ||
| - General Apify integration using the Apify task runner node | ||
|
|
||
| ## Direct integrations with Apify Actors (recommended) | ||
|
|
||
| Gumloop offers native nodes for popular Apify use cases that provide enhanced functionality and easier configuration. | ||
|
|
||
| These native nodes eliminate the complexity of managing Apify tasks while providing more powerful features for specific platforms. They are pre-configured with no need to manage Apify tasks or API keys, enhanced features like built-in data validation and formatting, better performance optimized for Gumloop, and full customizability using a prompt. | ||
|
|
||
| The following data sources are available natively in Gumloop: | ||
|
|
||
| - [Instagram](/platform/integrations/gumloop/instagram) | ||
| - [Google Maps](/platform/integrations/gumloop/maps) | ||
| - [TikTok](/platform/integrations/gumloop/tiktok) | ||
| - [YouTube](/platform/integrations/gumloop/youtube) | ||
|
|
||
| <!-- TODO: video walkthrough --> | ||
|
|
||
| ### Gumloop credits | ||
|
|
||
| Retrieving data from Apify Actors is included in your Gumloop subscription. Apify Actors natively integrated into Gumloop (YouTube, TikTok, Google Maps, Instagram) have a list of tools (data points) you can retrieve. | ||
|
|
||
| <!-- TODO:Image of MCP tools --> | ||
|
|
||
| Each tool has a corresponding Gumloop credit cost. Each Gumloop subscription comes with a set of credits. | ||
|
|
||
| | Sample prompt | Tool | Credit cost per use | | ||
| | :--- | :--- | :--- | | ||
| | Retrieve profile details for an Instagram user | Get Profile Details | 5 credits/profile | | ||
| | Get videos for a specific hashtag | Get Hashtag Videos | 3 credits/video | | ||
| | Show 5 most recent reviews for a restaurant | Get Place Reviews | 3 credits/review | | ||
|
|
||
| ## General integration (Apify Task Runner) | ||
|
|
||
| Gumloop's Apify task runner lets you run your Apify tasks directly inside Gumloop workflows. Scrape data with Apify, then process it with AI, send results via email, update spreadsheets, or connect to any of Gumloop's 100+ integrations. | ||
|
|
||
| Build workflows that automatically collect data from websites and deliver insights to your team through Slack, Gmail, Google Sheets, or wherever you need them. | ||
|
|
||
| ### Connect Apify with Gumloop | ||
|
|
||
| To use the Apify integration in Gumloop, you need an Apify account, a Gumloop account, and at least one Apify task that has been run previously. | ||
|
|
||
| ### Step 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. | ||
|
|
||
| <!-- TODO: placeholder: Apify Console API key location --> | ||
|
|
||
| ### Step 2: Add Apify Credentials to Gumloop | ||
|
|
||
| Next, go to [**Gumloop Credentials**](https://www.gumloop.com/settings/profile/credentials) and click **Add New Credentials**. Search for Apify in the credentials list, add your Apify API key, and save the credential. | ||
|
|
||
| <!-- TODO: placeholder: Gumloop credentials page showing Apify integration --> | ||
|
|
||
| ### Step 3: Add Apify Task Runner Node to Your Workflow | ||
|
|
||
| Open a new Gumloop pipeline page. Search for **Apify Task Runner** in the **Node Library**, and drag and drop the node onto your canvas. | ||
|
|
||
| <!-- TODO: placeholder: Gumloop pipeline page with Apify Task Runner node --> | ||
|
|
||
| ### Step 4: Create and Save Tasks in Apify | ||
|
|
||
| The Apify task runner node fetches tasks from your saved tasks in Apify Console. To create a task, navigate to [**Actors**](https://console.apify.com/actors), click on the Actor you want to use, and then click **Create a task** next to the Run button. Configure your task settings and save. | ||
|
|
||
| <!-- TODO: placeholder: Apify Actor page showing "Create a task" button --> | ||
|
|
||
| :::important | ||
|
|
||
| The Task Runner only displays tasks that have been saved in your Apify Console, not individual Actors. | ||
|
|
||
| ::: | ||
|
|
||
| ### Step 5: Run Your Tasks | ||
|
|
||
| Before tasks appear in Gumloop, they must be executed at least once in Apify. Go to your [**Saved tasks**](https://console.apify.com/actors/tasks), click on the task you want to use, and click **Start** to execute it. Wait for the task to complete. | ||
|
|
||
| This step is required because Gumloop needs to understand the output structure of your task to properly configure data fields. | ||
|
|
||
| <!-- TODO: placeholder: Apify task execution page --> | ||
|
|
||
| ### Step 6: Configure Your Gumloop Workflow | ||
|
|
||
| Select your task from the dropdown menu. Choose the output fields you want to use. Configure maximum run time and output limits. Connect the node to other workflow components. | ||
|
|
||
| <!-- TODO: placeholder: Configured Apify Task Runner node in Gumloop --> | ||
|
|
||
| ## Example Workflow | ||
|
|
||
| Here's a simple example of how to use Apify with Gumloop: | ||
|
|
||
| Web Scraping \+ AI Analysis \+ Email Report | ||
|
|
||
| ```mermaid | ||
|
|
||
| graph LR | ||
| A[Apify Task Runner] --> B[Ask AI] --> C[Combine text] --> D[Gmails sender] | ||
|
|
||
| ``` | ||
|
|
||
| The Apify task runner scrapes product prices from an e-commerce site. Ask AI analyzes price trends and identifies opportunities. Combine Text formats the analysis into a readable report. Gmail Sender emails the report to stakeholders. | ||
|
||
|
|
||
| This workflow runs automatically and delivers actionable insights directly to your inbox. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Credit* |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| --- | ||
| title: Gumloop - Instagram Actor integration | ||
| description: Learn about Instagram scraper modules. Extract posts, comments, and profile data. | ||
| sidebar_label: Instagram | ||
| sidebar_position: 1 | ||
| slug: /integrations/gumloop/instagram | ||
| --- | ||
|
|
||
| Get Instagram profile posts, details, stories, reels, post comments and hashtags, users, and tagged posts in Gumloop. | ||
|
|
||
| --- | ||
|
|
||
| The Gumloop integration for Instagram provides a direct interface for running Apify’s Instagram scrapers directly in your workflows. No API tokens or manual polling required. All you need is a Gumloop account. | ||
|
|
||
| Using the Gumloop Instagram MCP node, you can prompt the Instagram data you need and Gumloop will retrieve it from relevant Apify Actors. From there you can connect this data to other tools and AI models to process the information. | ||
|
|
||
| <!-- TODO:Image of MCP node --> | ||
|
|
||
| ## Available actions | ||
|
|
||
| You can pull the following types of data from public Instagram accounts using Gumloop’s Instagram node (via Apify). Each action has a token cost. | ||
|
|
||
| Prerequisites: | ||
|
|
||
| - A Gumloop account. | ||
|
||
|
|
||
| | Tool/ Action | Description | Token Cost | | ||
| | :---- | :---- | :---- | | ||
| | Get profile posts | Fetch posts from a public Instagram profile, including captions, images, like and comment counts, and metadata. | 3 tokens per item | | ||
|
||
| | Get post comments | Retrieve all comments on a specific post, with author info, timestamps, and like counts. | 3 tokens per item | | ||
| | Get hashtag posts | Search by hashtag and return matching posts with full details. | 3 tokens per item | | ||
| | Find users | Look up Instagram users by name or handle and return profile metadata like bio, follower/following counts, etc. | 3 tokens per item | | ||
| | Get profile details | Extract detailed metadata from a profile, including follower count, bio, and verification status. | 5 tokens per item | | ||
| | Get profile stories | Get media URLs, timestamps, and view counts from an Instagram profile’s stories. | 3 tokens per item | | ||
| | Get profile reels | Fetch reels with captions, engagement metrics, play counts, and music info. | 3 tokens per item | | ||
| | Get tagged posts | Return posts where a specific user is tagged, with full post details. | 3 tokens per item | | ||
|
|
||
| ## Retrieve Instagram data in Gumloop | ||
|
|
||
| 1. Add the Gumloop Instagram MCP node | ||
|
||
|
|
||
| First, add the Instagram node from the node library to your workflow canvas. | ||
|
|
||
| <!-- TODO:Image of MCP node --> | ||
|
|
||
| 1. Prompt the data you need. | ||
|
|
||
| In the node's configuration panel, write a clear, specific prompt that describes the data you want to retrieve. | ||
|
|
||
| <!-- TODO:Image of the prompt --> | ||
|
|
||
| :::tip Prompting tips | ||
|
|
||
| - MCP nodes only have access to the tools listed so your prompt should be scoped to Instagram. | ||
| - You can mix and match different tools (get 10 latest videos for a hashtag and retrieve profile data for each post). | ||
|
|
||
| ::: | ||
|
|
||
| 1. Define the inputs and outputs | ||
|
|
||
| Once you’ve entered your prompt, you will go through the AI assisted node creation process starting with defining inputs, parameters and outputs of your Instagram node. | ||
|
|
||
| Gummie (Gumloop’s AI assistant) will suggest inputs (information coming from previous steps, ie hashtag to scrape), parameters (user defined choices, ie number of posts to retrieve) and outputs (information used in future steps, ie number of followers of users and list of recent videos). | ||
|
|
||
| <!-- TODO:Image of inputs/outputs --> | ||
|
|
||
| 1. Generate and test the node | ||
|
|
||
| With inputs, parameters and outputs defined, Gummie will generate the code to retrieve the data from the Apify Instagram node. There is no requirement for you to review or understand the code, Gummie takes care of it. | ||
|
|
||
| After the code is written, enter test values to confirm the outputs of the node and save. | ||
|
|
||
| Once saved, you can access this node in any of your flows. | ||
|
|
||
| <!-- TODO:Image of node --> | ||
|
|
||
| ## Other integrations | ||
|
|
||
| - [TikTok](/platform/integrations/gumloop/tiktok) | ||
| - [YouTube](/platform/integrations/gumloop/youtube) | ||
| - [Google Maps](/platform/integrations/gumloop/maps) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| --- | ||
| title: Gumloop - Google maps Actor integration | ||
| description: Learn about Google Maps scraper modules. Extract place details, reviews, and search results. | ||
| sidebar_label: Google maps | ||
|
||
| sidebar_position: 2 | ||
| slug: /integrations/gumloop/maps | ||
| --- | ||
|
|
||
| Search, extract, and enrich business data from Google Maps in Gumloop. | ||
|
|
||
| --- | ||
|
|
||
| The Gumloop Google Maps integration provides a native interface for running Apify’s Google Maps scrapers directly in your workflows—no API keys or manual polling required. All you need is a Gumloop account. | ||
|
||
|
|
||
| Using the Gumloop Google Maps MCP node, you can simply prompt the location data you need and Gumloop will retrieve it from relevant Apify actors. From there, you can connect it to your favorite tools and AI agents to process the information. | ||
|
|
||
| <!-- TODO:Image of MCP node --> | ||
|
|
||
| ## Available actions | ||
|
|
||
| You can pull the following types of place data from Google Maps using Gumloop’s Google Maps node (via Apify). Each action has a token cost. | ||
|
|
||
| Prerequisites: | ||
|
|
||
| - A Gumloop account. | ||
|
|
||
| | Tool/ Action | Description | Token Cost | | ||
| | :---- | :---- | :---- | | ||
| | Search places | Search for places on Google Maps using location and search terms. | 3 tokens per item | | ||
| | Get place details | Retrieve detailed information about a specific place using its URL or place ID. | 5 tokens per item | | ||
| | Search by category | Search for places by a specific category (e.g. cafes, gyms) on Google Maps. | 3 tokens per item | | ||
| | Get place reviews | Fetch reviews for specific locations, including text, rating, and reviewer info. | 3 tokens per item | | ||
| | Find places in area | Return all visible places within a defined map area or bounding box. | 3 tokens per item | | ||
|
|
||
|
|
||
| ## Retrieve Google Maps data in Gumloop | ||
|
|
||
| 1. Add the Gumloop Google Maps MCP node. | ||
|
||
|
|
||
| First, add the Google Maps node from the node lirbary to your workflow canvas. | ||
|
|
||
| <!-- TODO:Image of MCP node --> | ||
|
|
||
| 1. Prompt the data you need | ||
|
|
||
| In the node's configuration panel, write a clear, specific prompt that describes the data you want to retrieve. | ||
|
|
||
| <!-- TODO:Image of the prompt --> | ||
|
|
||
| :::tip Prompting tips | ||
|
|
||
| - MCP nodes only have access to the tools listed so your prompt should be scoped to Google Maps. | ||
| - You can mix and match different tools (e.g., search for gyms in Vancouver → get place details → pull reviews). | ||
|
|
||
| ::: | ||
|
|
||
| 1. Define inputs/outputs | ||
|
|
||
| Once you’ve entered your prompt, you will go through the AI assisted node creation process starting with defining inputs, parameters and outputs of your Google Maps node. | ||
|
|
||
| Gummie (Gumloop’s AI assistant) will suggest inputs (information coming from previous steps, ie location, keyword, category), parameters (user defined choices, ie number of results or radius) and outputs (information used in future steps, ie business name, review count, ratings). | ||
|
|
||
| <!-- TODO:Image of inputs/outputs --> | ||
|
|
||
| 1. Generate and test the node | ||
|
|
||
| With inputs, parameters and outputs defined, Gummie will generate the code to retrieve the data from the Apify Google Maps node. There is no requirement for you to review or understand the code, Gummie takes care of it. | ||
|
|
||
| After the code is written, enter test values to confirm the outputs of the node and save. | ||
|
|
||
| Once saved, you can access this node in any of your flows. | ||
|
|
||
| <!-- TODO:Image of node --> | ||
|
|
||
| ## Other integrations | ||
|
|
||
| - [TikTok](/platform/integrations/gumloop/tiktok) | ||
| - [Instagram](/platform/integrations/gumloop/instagram) | ||
| - [YouTube](/platform/integrations/gumloop/youtube) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| --- | ||
| title: Gumloop - TikTok Actor integration | ||
| description: Learn about TikTok scraper modules. Extract videos, profile data, followers, and hashtag data. | ||
| sidebar_label: TikTok | ||
| sidebar_position: 1 | ||
| slug: /integrations/gumloop/tiktok | ||
| --- | ||
|
|
||
| Get TikTok hashtag videos, profile videos, followers, video details, and search results in Gumloop. | ||
|
|
||
| --- | ||
|
|
||
| The Gumloop TikTok integration provides a native interface for running Apify’s TikTok scrapers directly in your workflows—no API tokens or manual polling required. All you need is a Gumloop account. | ||
|
||
| Using the Gumloop TikTok MCP node, you can simply prompt the TikTok data you need and Gumloop will retrieve it from relevant Apify actors. From there, you can connect it to your favorite tools and AI agents to process the information. | ||
|
|
||
| <!-- TODO:Image of MCP node --> | ||
|
|
||
| ## Available actions | ||
|
|
||
| You can pull the following types of data from TikTok using Gumloop’s TikTok node (via Apify). Each action has a token cost. | ||
|
||
|
|
||
| Prerequisites: | ||
|
|
||
| - A Gumloop account. | ||
|
|
||
| | Tool/ Action | Description | Token Cost | | ||
| | :---- | :---- | :---- | | ||
| | Get hashtag videos | Fetch videos from TikTok hashtags with captions, engagement metrics, play counts, and author information. | 3 tokens per item | | ||
| | Get profile videos | Get videos from TikTok user profiles with video metadata, engagement stats, music info, and timestamps. | 3 tokens per item | | ||
| | Get profile followers | Retrieve followers or following lists from TikTok profiles, including usernames, follower counts, and bios. | 3 tokens per item | | ||
| | Get video details | Get comprehensive data on a specific TikTok video using its URL—includes engagement and video-level metrics. | 5 tokens per item | | ||
| | Search videos | Search TikTok for videos and users using queries. Returns video details and user profile info. | 3 tokens per item | | ||
|
|
||
| ## Retrieve Tiktok Data in Gumloop | ||
|
|
||
| 1. Add the Gumloop TikTok MCP node | ||
|
||
|
|
||
| First, add the TikTok node from the node lirbary to your workflow canvas. | ||
|
|
||
| <!-- TODO:Image of MCP node --> | ||
|
|
||
| 1. Prompt the data you need | ||
|
|
||
| In the node's configuration panel, write a clear, specific prompt that describes the data you want to retrieve. | ||
|
|
||
| <!-- TODO:Image of prompt --> | ||
|
|
||
| :::tip Prompting tips | ||
|
|
||
| - MCP nodes only have access to the tools listed so your prompt should be scoped to TikTok. | ||
| - You can mix and match different tools (e.g., search a hashtag → get profile videos → retrieve engagement data). | ||
|
|
||
| ::: | ||
|
|
||
| 1. Define inputs/outputs | ||
|
|
||
| Once you’ve entered your prompt, you will go through the AI assisted node creation process starting with defining inputs, parameters and outputs of your TikTok node. | ||
|
|
||
| Gummie (Gumloop’s AI assistant) will suggest inputs (information coming from previous steps, ie search keyword, video URL), parameters (user defined choices, number of videos to retrieve) and outputs (information used in future steps, ie follower count, video engagement, music info). | ||
|
|
||
| <!-- TODO:Image of inputs/outputs --> | ||
|
|
||
| 1. Generate and test the node | ||
|
|
||
| With inputs, parameters and outputs defined, Gummie will generate the code to retrieve the data from the Apify TikTok node. There is no requirement for you to review or understand the code, Gummie takes care of it. | ||
|
|
||
| After the code is written, enter test values to confirm the outputs of the node and save. | ||
|
|
||
| Once saved, you can access this node in any of your flows. | ||
|
|
||
| <!-- TODO:Image of final node--> | ||
|
|
||
| ## Other integrations | ||
|
|
||
| - [Instagram](/platform/integrations/gumloop/instagram) | ||
| - [YouTube](/platform/integrations/gumloop/youtube) | ||
| - [Google Maps](/platform/integrations/gumloop/maps) | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Title case