Skip to content

Commit 53f3f93

Browse files
authored
Fix/docs (#18)
* fix: updating readme docs * fix: grammar
1 parent ede9b50 commit 53f3f93

File tree

9 files changed

+19
-52
lines changed

9 files changed

+19
-52
lines changed

README.md

Lines changed: 19 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# n8n Nodes - Apify integration
22

3-
This is an n8n community node that integrates [Apify](https://apify.com) with your n8n workflows, so you can run Apify Actors, extract structured data from websites, and automate complex web scraping tasks.
3+
This is an n8n community node that integrates [Apify](https://apify.com) [Website Content Crawler](https://apify.com/apify/website-content-crawler) with your n8n workflows.
44

5-
[Apify](https://apify.com) is a platform for developers to build, deploy, and publish web automation tools, while [n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) tool for AI workflow automation that allows you to connect various services.
5+
Use this node to run the Website Content Crawler, configure its input, and fetch results directly in your workflows.
6+
7+
[Website Content Crawler](https://apify.com/apify/website-content-crawler) is an Apify Actor that can perform a deep crawl of one or more websites and extract text content from the web pages. It is useful to download data from websites such as documentation, knowledge bases, help sites, or blogs.
68

79
## Table of contents
810

@@ -79,7 +81,7 @@ n8n start
7981

8082
This configuration is required for our service's trigger functionality to work correctly.
8183

82-
By default, when running locally n8n generates webhook URLs using `localhost`, which external services cannot reach. To fix this:
84+
By default, when running n8n locally, it generates webhook URLs using `localhost`, which external services cannot reach. To fix this:
8385

8486
1. **Set your webhook URL**
8587
In the same shell or Docker environment where n8n runs, export the `WEBHOOK_URL` to a publicly-accessible address. For example:
@@ -94,49 +96,12 @@ In the same shell or Docker environment where n8n runs, export the `WEBHOOK_URL`
9496

9597
## Operations
9698

97-
![operations](./docs/actions.png)
98-
99-
This node supports a wide range of Apify operations, organized by resource type:
100-
101-
### Actors
102-
- **Run Actor**: Execute an Actor with optional input parameters
103-
- **Default behavior**: Uses predefined input values
104-
- **Custom input**: Provide JSON object to override any or all default parameters.
105-
- Configurable timeout and memory limits
106-
- Build version selection
107-
- **Scrape Single URL**: Quick scraping of a single URL
108-
- **Get Last Run**: Retrieve information about the most recent Actor run
109-
110-
![actor run](./docs/run-actor.png)
111-
112-
### Actor tasks
113-
- **Run Task**: Execute a predefined Actor task
114-
- Supports custom input JSON
115-
- Configurable timeout
116-
- Task-specific settings
99+
![operations](./docs/operations.png)
117100

118-
### Actor runs
119-
- **Get User Runs List**: List all runs for a user
120-
- Pagination support
121-
- Sorting options
122-
- Status filtering
123-
- **Get run**: Retrieve detailed information about a specific run
101+
This node integrates the Apify Website Content Crawler Actor and supports running the Apify Actor with custom input.
124102

125-
### Datasets
126-
- **Get Items**: Fetch items from a dataset
127-
128-
### Key-Value Stores
129-
- **Get Key-Value Store Record**: Retrieve a specific record by key
130-
131-
### Triggers
132-
Automatically start an n8n workflow whenever an Actor or task finishes execution
133-
- Can be configured to trigger on success, failure, abort, timeout or any combination of these states
134-
- Includes run metadata in the output
135-
- Available triggers:
136-
- **Actor Run Finished**: Start a workflow when an Actor run completes
137-
- **Task Run Finished**: Start a workflow when a task run completes
138-
139-
![triggers](./docs/trigger.png)
103+
### Run Crawler
104+
Execute a Website Content Crawler with optional input parameters
140105

141106
## Credentials
142107

@@ -148,7 +113,7 @@ The node supports two authentication methods:
148113
2. **OAuth2 authentication** (available only in n8n cloud)
149114
- Configure OAuth2 credentials in the n8n credentials section under `apifyOAuth2Api`
150115

151-
![auth](./docs/auth.png)
116+
![auth](./docs/credentials.png)
152117

153118

154119
## Compatibility
@@ -157,17 +122,19 @@ This node has been tested with n8n version 1.57.0.
157122

158123
## Usage
159124

160-
1. **Create an Actor**: Set up a new Actor on [Apify](https://apify.com).
161-
2. **Set up a workflow**: Create a new workflow in n8n.
162-
3. **Add the Apify node**: Insert the Apify node into your workflow.
163-
4. **Configure credentials**: Enter your Apify API key and Actor ID.
164-
5. **Select an operation**: Choose the desired operation for the node.
165-
6. **Execute the workflow**: Run the workflow to execute the Apify operation.
125+
You can use this node in various workflows. It is especially useful for extracting content from websites for LLMs and other AI applications.
126+
127+
1. **Set up a workflow**: Create a new workflow in n8n.
128+
2. **Add AI Agent node**: Add an AI Agent node to your workflow to process or analyze the extracted content.
129+
3. **Add Website Content Crawler node**: Insert the node into your workflow and connect it as an AI Agent tool.
130+
4. **Configure credentials**: Enter your Apify API key or use Apify OAuth flow.
131+
5. **Execute the workflow**: Run the workflow using the chat interface.
166132

167-
![workflow](./docs/workflow.png)
133+
![workflow](./docs/uc.png)
168134

169135
## Resources
170136

137+
- [Apify Website Content Crawler](https://apify.com/apify/website-content-crawler)
171138
- [n8n Community Nodes Documentation](https://docs.n8n.io/integrations/community-nodes/)
172139
- [Apify API Documentation](https://docs.apify.com)
173140

docs/actions.png

-60.9 KB
Binary file not shown.

docs/auth.png

-45.3 KB
Binary file not shown.

docs/credentials.png

33.4 KB
Loading

docs/operations.png

107 KB
Loading

docs/run-actor.png

-56.9 KB
Binary file not shown.

docs/trigger.png

-51.8 KB
Binary file not shown.

docs/uc.png

137 KB
Loading

docs/workflow.png

-87.1 KB
Binary file not shown.

0 commit comments

Comments
 (0)