Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 17 additions & 20 deletions docs/tools/apifyactorstool.mdx
Original file line number Diff line number Diff line change
@@ -1,40 +1,37 @@
---
title: Apify Actors
description: ApifyActorsTool integrates Apify Actors into CrewAI for web scraping, data extraction, and automation.
description: `ApifyActorsTool` lets you call Apify Actors to provide your CrewAI workflows with web scraping, crawling, data extraction, and web automation capabilities.
icon: toolbox
---

# `ApifyActorsTool`

Integrate [Apify Actors](https://apify.com/) into your CrewAI workflows.
Integrate [Apify Actors](https://apify.com/actors) into your CrewAI workflows.

## Description

The `ApifyActorsTool` connects [Apify Actors](https://apify.com/), cloud-based programs for web scraping and automation, to your CrewAI workflows. You can extract data, crawl websites, and automate tasks, all without requiring infrastructure management.
The `ApifyActorsTool` connects [Apify Actors](https://apify.com/actors), cloud-based programs for web scraping and automation, to your CrewAI workflows.
Use any of 4,000+ Actors from [Apify Store](https://apify.com/store) for use cases such as extracting data from social media, search engines, online maps, e-commerce sites, travel portals, or general websites.
Comment thread
MQ37 marked this conversation as resolved.

**Key features**:
- **Run Actors** directly, like the [RAG Web Browser](https://apify.com/apify/rag-web-browser), with CrewAI agents.
- **Access real-time data** for tasks that need fresh web content or automation.

See the [Apify CrewAI documentation](https://docs.apify.com/platform/integrations/crewai) for a detailed integration guide.
For details, see the [Apify CrewAI integration](https://docs.apify.com/platform/integrations/crewai) in Apify documentation.

## Steps to get started

<Steps>
<Step title="Install dependencies">
Install `crewai[tools]` and `langchain-apify` using pip: `pip install 'crewai[tools]' langchain-apify`.
</Step>
<Step title="Obtain an API token">
Sign up at [Apify](https://apify.com/) and obtain your API token by following the [Apify API documentation](https://docs.apify.com/platform/integrations/api).
<Step title="Obtain an Apify API token">
Sign up to [Apify Console](https://console.apify.com/) and get your [Apify API token](https://console.apify.com/settings/integrations)..
</Step>
<Step title="Configure environment">
Set your API token as an environment variable (`APIFY_API_TOKEN`) to enable the tool's functionality.
Set your Apify API token as the `APIFY_API_TOKEN` environment variable to enable the tool's functionality.
</Step>
</Steps>

## Usage example

Use the `ApifyActorsTool` manually to run the [RAG Web Browser Actor](https://apify.com/apify/rag-web-browser) and perform a web search:
Use the `ApifyActorsTool` manually to run the [RAG Web Browser Actor](https://apify.com/apify/rag-web-browser) to perform a web search:

```python
from crewai_tools import ApifyActorsTool
Expand Down Expand Up @@ -78,23 +75,23 @@ agent = Agent(
)
```

Experiment with other Actors from the [Apify Store](https://apify.com/store) by changing the `actor_name` and, when using it manually, adjusting the `run_input` based on the Actor input schema.
You can run other Actors from [Apify Store](https://apify.com/store) simply by changing the `actor_name` and, when using it manually, adjusting the `run_input` based on the Actor input schema.

For an example of usage with agents, see the [CrewAI Apify Actor template](https://apify.com/templates/python-crewai).
For an example of usage with agents, see the [CrewAI Actor template](https://apify.com/templates/python-crewai).

## Configuration

The `ApifyActorsTool` requires these inputs to work:

- **`actor_name`**
The ID of the Apify Actor to run, e.g., `"apify/rag-web-browser"`. Browse options in the [Apify Store](https://apify.com/store).
The ID of the Apify Actor to run, e.g., `"apify/rag-web-browser"`. Browse all Actors in [Apify Store](https://apify.com/store).
Comment thread
MQ37 marked this conversation as resolved.
- **`run_input`**
A dictionary of input parameters for the Actor when running the tool manually.
- For example for the `apify/rag-web-browser`: `{"query": "search term", "maxResults": 5}`
- See each Actor [input schema](https://apify.com/apify/rag-web-browser/input-schema) for details.
- For example for the `apify/rag-web-browser` Actor: `{"query": "search term", "maxResults": 5}`
Comment thread
MQ37 marked this conversation as resolved.
- See Actor's [input schema](https://apify.com/apify/rag-web-browser/input-schema) for the list of input parameters.
Comment thread
MQ37 marked this conversation as resolved.

## Resources

- **[Apify Platform](https://apify.com/)**: Dive into the Apify ecosystem.
- **[RAG Web Browser Actor](https://apify.com/apify/rag-web-browser)**: Test this popular Actor for web data retrieval.
- **[CrewAI Integration Guide](https://docs.apify.com/platform/integrations/crewai)**: Follow the official guide for Apify and CrewAI.
- **[Apify](https://apify.com/)**: Dive into the Apify platform.
Comment thread
MQ37 marked this conversation as resolved.
- **[RAG Web Browser Actor](https://apify.com/apify/rag-web-browser)**: A popular Actor for web search for LLMs.
- **[CrewAI Integration Guide](https://docs.apify.com/platform/integrations/crewai)**: Follow the official guide for integrating Apify and CrewAI.