jyapayne/langflow
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

docs: Improve Apify integration documentation (#6889)

Browse source 
* docs: Improve Apify integration documentation with detailed guidance and examples

* cleanup

* Apply suggestions from code review

Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com>

* header

---------

Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com>
This commit is contained in:
Mendon Kissling 2025-03-06 09:20:32 -05:00 • committed by GitHub
commit cd313b73d7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 39 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

74
docs/docs/Integrations/Apify/integrations-apify.md
View file

@ -5,59 +5,63 @@ slug: /integrations-apify
# Integrate Apify with Langflow
[Apify](https://apify.com/) is a web scraping and data extraction platform. It provides an app store with more than three thousand ready-made cloud tools called Actors.
[Apify](https://apify.com/) is a web scraping and data extraction platform. It provides an [Actor Store](https://apify.com/store) with more than 3,000 ready-made cloud tools called **Actors**.
The Apify components allow you to run Apify Actors in your flow to accomplish tasks such as:
- Crawling websites and extracting text content
- Scraping social media platforms like Instagram and Facebook
- Extracting data from Google Maps
- Inserting data into a PostgreSQL/MySQL/MSSQL database
- Running various other automation tasks
More info about Apify:
- [Website](https://apify.com/)
- [Apify Actor Store](https://apify.com/store)
- [Actor Whitepaper](https://whitepaper.actor/)
Apify components in Langflow run **Actors** to accomplish tasks like data extraction, content analysis, and SQL operations.
## Prerequisites
You need an **Apify API token**. You can create a free account on [Apify](https://apify.com/) and generate your API key in the Apify Console. [Get a Free API key here](https://docs.apify.com/platform/integrations/api).
* An [Apify API token](https://docs.apify.com/platform/integrations/api)
Enter the key in the *Apify Token* field in all components that require the key.
## Use the Apify Actors component in a flow
To use an **Apify Actor** in your flow:
1. Click and drag the **Apify Actors** component to your **workspace**.
2. In the **Apify Actor** component's **Apify Token** field, add your **Apify API token**.
3. In the **Apify Actor** component's **Actor** field, add your **Actor ID**.
You can find the Actor ID in the [Apify Actor Store](https://apify.com/store).
For example, the [Website Content Crawler](https://apify.com/apify/website-content-crawler) has Actor ID `apify/website-content-crawler`.
4. The component can now be used as a **Tool** to be connected to an **Agent** component, or configured to run manually.
For more information on running the component manually, see the **JSON Example** in the [Apify documentation](https://apify.com/apify/website-content-crawler/input-schema).
## Example flows
### Extract website text content in Markdown format
Here are some example flows that use the **Apify Actors** component.
### Extract website text content in Markdown
Use the [Website Content Crawler Actor](https://apify.com/apify/website-content-crawler) to extract text content in Markdown format from a website and process it in your flow.
![Apify Flow - Website Content Crawler](./apify_flow_wcc.png)
### Analyze and process website content with an Agent
### Process web content with an agent
Extract website content using the [Website Content Crawler Actor](https://apify.com/apify/website-content-crawler), and then process it with an agent.
The agent takes the extracted data and transforms it into summaries, insights, or structured responses to make the information more actionable.
Building on the previous example, this flow not only extracts website content using the [Website Content Crawler Actor](https://apify.com/apify/website-content-crawler) but also processes and analyzes it with an agent. The agent takes the extracted data and transforms it into summaries, insights, or structured responses, making the information more actionable. Unlike simple extraction, this approach enables automated content understanding and contextual processing.
![Apify Agent Flow - Simple](./apify_agent_flow_simple.png)
### Search and analyze social media profiles with an Agent
### Analyze social media profiles with multiple actors
Perform comprehensive social media research with multiple Apify Actors. Start with the [Google Search Results Scraper Actor](https://apify.com/apify/google-search-scraper) to find relevant social media profiles, then use the [TikTok Data Extractor Actor](https://apify.com/clockworks/free-tiktok-scraper) to gather data and videos. The agent streamlines the process by collecting links from Google and retrieving content from TikTok, enabling deeper analysis of a person, brand, or topic.
Perform comprehensive social media research with multiple Apify Actors.
Add the [Google Search Results Scraper Actor](https://apify.com/apify/google-search-scraper) to find relevant social media profiles, and then add the [TikTok Data Extractor Actor](https://apify.com/clockworks/free-tiktok-scraper) to gather data and videos.
The agent collects the links from Google and content from TikTok and analyzes the data to provide insights about a person, brand, or topic.
![Apify Agent Flow](./apify_agent_flow.png)
## Components
## Inputs
### Apify Actors
| Name | Display Name | Info |
|------|--------------|------|
| apify_token | Apify Token | Your Apify API key. |
| actor | Actor | The Apify Actor to run, for example `apify/website-content-crawler`. |
| run_input | Run Input | The JSON input for configuring the Actor run. For more information, see the [Apify documentation](https://apify.com/apify/website-content-crawler/input-schema). |
This component allows you to run Apify Actors in your flow. It can be used manually by providing run input or integrated as a tool for an AI Agent. When used with an AI Agent, the agent can leverage the Apify Actors to perform various tasks.
## Outputs
- **Input**:
- Apify Token: Your API key.
- Actor: The Apify Actor to run. Example: `apify/website-content-crawler`.
- Run Input: The JSON input for configuring the Actor run.
- **Output**:
- Actor Run Result: The JSON response containing the output of the Actor run.
## How to use Apify Actors in Langflow
First, you need to pick an Actor that you want to use in your flow from the [Apify Actor Store](https://apify.com/store). Then, create the **Apify Actors** component and input your Apify API token and the Actor ID. You can find the Actor ID in the Apify Actor Store, for instance, the [Website Content Crawler](https://apify.com/apify/website-content-crawler) has Actor ID `apify/website-content-crawler`. Now you can either connect the **Tool** output to an AI Agent or configure the Run input JSON manually and run the component to retrieve data from the **Output Data**. Example Run input can be obtained from the Actor details page in the Apify Actor Store. See the **JSON Example** in the input schema section [here](https://apify.com/apify/website-content-crawler/input-schema).
| Name | Display Name | Info |
|------|--------------|------|
| output | Actor Run Result | The JSON response containing the output of the Actor run. |